Pengembang

GET/v3/inventory/{number}

Tampilkan inventaris nomor yang telah dibeli

Baca konfigurasi dan status tersimpan nomor yang telah dibeli, dengan opsi penyaringan berdasarkan nomor telepon.

Di halaman ini
  1. Permintaan
  2. Respons
  3. Penyaringan dan paginasi
  4. Tidak ada nomor yang cocok
  5. Langkah selanjutnya

Tampilkan catatan nomor yang telah dibeli yang pemilik tersimpannya cocok dengan akun yang diwakili oleh kredensial API Anda. Keberadaan catatan berbeda dari keberhasilan pengujian panggilan langsung.

Permintaan

Gunakan kredensial API sisi server melalui HTTPS. Contoh-contoh ini membaca kredensial dari variabel lingkungan; tidak ada kredensial yang dapat digunakan di dalamnya. Periksa status.code dalam isi JSON serta status HTTP. Penangan lama ini tidak selalu menetapkan status kesalahan HTTP untuk kesalahan aplikasi.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory"

Untuk menyaring berdasarkan satu nomor telepon tersimpan, gunakan bentuk jalur opsional berikut:

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory/12025550100"

Gunakan nomor telepon internasional yang tersimpan dalam bentuk digit, termasuk kode negara. Jangan berikan ekstensi PBX, UUID nomor, ID wilayah, atau ID prefiks sebagai penggantinya. Nomor yang diberikan memilih catatan yang sudah ada; tindakan ini tidak membeli atau mengonfigurasi nomor.

Respons

Anggota response selalu berupa larik saat permintaan berhasil, termasuk jika menggunakan bentuk jalur untuk satu nomor. status.results adalah panjang larik tersebut.

Ini adalah ilustrasi struktur respons, bukan data akun atau penawaran harga terkini.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "number": "12025550100",
      "uuid": "NUMBER_UUID",
      "description": "Main reception",
      "isocode": "US",
      "config": {
        "uri": "sip:reception@example.com",
        "uri2": "",
        "uri3": "",
        "forward_destination": "",
        "sms_uri": "",
        "sms_forward_destination": ""
      },
      "features": {
        "voice": "1",
        "sms": "1",
        "mms": "0"
      },
      "status": {
        "capacity": {
          "assigned_channels": "2",
          "used_channels": "0",
          "overflow": "0",
          "overage_charge": "0.01"
        },
        "origination": {
          "origination_trunk_id": "ORIGINATION_ID",
          "origination_trunk_name": "ORIGINATION_NAME",
          "origination_country_iso": "US",
          "origination_continent_iso": "NA",
          "origination_continent_name": "North America"
        },
        "service_active": "1",
        "force_codec": "",
        "force_dtmf": ""
      },
      "billing": {
        "cnam": "0",
        "overflow": "0",
        "autorenew": "1",
        "persistent": "0",
        "date_created": "2026-01-01 00:00:00"
      },
      "price": {
        "setup_price": "0.00",
        "monthly_price": "1.00",
        "per_minute": "0.01",
        "free_minutes": "0",
        "remaining_minutes": "0"
      }
    }
  ]
}
Bidang nomor yang dikembalikan
BidangArti
number, uuid, description, isocodeNomor telepon tersimpan, pengenal nomor yang harus diperlakukan sebagai nilai tanpa makna internal, deskripsi, dan kode negara.
configBidang tersimpan untuk tujuan panggilan suara, penerusan eksternal, tujuan SMS, dan penerusan SMS. Endpoint ini tidak mengubahnya.
featuresPenanda kemampuan panggilan suara, SMS, dan MMS yang tersimpan. Penanda lama yang tersimpan tidak dijamin berupa nilai boolean JSON.
status.capacityNilai kanal yang dialokasikan dan digunakan, pengaturan luapan, serta biaya kelebihan pemakaian yang tersimpan. Ini adalah metadata tersimpan, bukan penawaran kapasitas terbaru atau pengujian panggilan langsung.
status.originationMetadata asal panggilan yang tersimpan. Perlakukan pengenal sebagai nilai tanpa makna internal; jangan mendasarkan logika aplikasi pada nama internal.
status.service_active, force_codec, force_dtmfBidang konfigurasi aktivasi dan media yang tersimpan. Penanda saja tidak membuktikan bahwa panggilan masuk berhasil tersampaikan.
billingNilai CNAM, luapan, perpanjangan, persistensi, dan pembuatan yang tersimpan. Membacanya tidak mengubah pengaturan perpanjangan atau penagihan lainnya.
priceHarga aktivasi awal, bulanan, dan per menit serta kuota menit yang tersimpan. Penangan ini tidak menyediakan bidang mata uang atau penawaran harga terbaru. Jangan menyimpulkan mata uang dari nilai contoh atau menggunakannya sebagai penawaran harga pembelian terkini.

Penyaringan dan paginasi

Penangan ini tidak memiliki paginasi, batas ukuran halaman, atau urutan pengurutan yang ditetapkan secara eksplisit. Penangan ini mengembalikan semua catatan yang tidak dibatalkan yang dipilih oleh kuerinya. Penangan ini tidak menerapkan filter khusus layanan aktif atau tampilan terpisah untuk nomor yang diarsipkan. Jangan menganggap urutan catatan yang dikembalikan selalu tetap.

Tidak ada nomor yang cocok

Jika akun tidak memiliki catatan yang cocok dan tidak dibatalkan, isi JSON memiliki status.code 404 dan pesan yang memuat no numbers found. Penangan ini tidak mengembalikan larik kosong dengan status berhasil. Pesan tersebut menyertakan akhiran referensi sumber yang tidak boleh diurai oleh klien sebagai pengenal yang tetap.

Langkah selanjutnya

Gunakan numberinfo ketika Anda memerlukan bidang tambahan dari sistem lama untuk registrasi dan referensi nomor bagi satu nomor. Periksa tujuan panggilan suara dan pesan sebelum mengubah rute apa pun melalui operasi konfigurasi terpisah.