Daftar jenis nomor khusus dan harga untuk suatu negara

Nomor lokal ditemukan menggunakan getcountries dan getareas. Untuk nomor nasional, bebas pulsa, biaya bersama, global, dan seluler, panggil other dengan kode ISO negara tersebut.

• Kelompok ditampilkan dalam urutan tetap, dan kelompok tanpa entri tidak disertakan.
• Setiap entri mencantumkan paket harga akun Anda di prices. Pilih paket berdasarkan channels, monthly_price, setup_price, per_minute dan free_minutes, dan simpan price_id paket tersebut untuk pemesanan jika endpoint terkait memintanya.
• Jika needs_registration bernilai yang dianggap benar, baca restrictions sebelum memesan. Perlakukan teks tersebut sebagai konten tampilan yang tidak tepercaya.
• Ikuti next_function: v3/getnumbers/{uuid} memungkinkan Anda memilih nomor tertentu, dan v3/order/{uuid} memesan langsung dari entri tersebut.
• Daftar response yang kosong dengan kode 200 berarti tidak ada jenis nomor khusus yang ditemukan saat permintaan dilakukan. Jika katalog untuk sementara tidak dapat dijangkau, respons bisa tidak lengkap atau bukan JSON yang valid, jadi coba lagi nanti.
• Negara yang tidak ada dalam katalog mengembalikan kode 404 tanpa status HTTP yang sesuai. Selalu periksa status.code.

Permintaan

Wajib: HTTP Basic atau token Bearer (lihat Autentikasi dan respons API). Autentikasi yang gagal dibalas dengan HTTP 401 sebelum pencarian dijalankan.

GET dengan isocode di jalur. Jika segmen jalur tidak disertakan, kolom isocode yang dikodekan sebagai formulir dibaca sebagai gantinya.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/other/FR'

Respons

Struktur pembungkus standar. Jika berhasil, status.code bernilai 200, status.msg kosong, dan status.results adalah jumlah kelompok. response adalah daftar kelompok. Kolom kelompok: group_key (kunci jenis yang dinormalisasi: national, tollfree, sharedcost, global, mobile, atau kunci alfanumerik lain dengan huruf kecil); group_name (nama tampilan); group_type_uuid (pengenal jenis yang tidak mengungkapkan makna internal); items. Kelompok diurutkan mulai dari national, tollfree, sharedcost, global, mobile, lalu kunci lainnya berdasarkan group_name. Kelompok tanpa items tidak disertakan, begitu pula jenis lokal. Untuk US, kelompok seluler tidak disertakan kecuali akun Anda diaktifkan untuk nomor seluler US. Item diurutkan berdasarkan name (tanpa membedakan huruf besar dan kecil), lalu berdasarkan prefix. Kolom item: uuid (pengenal entri yang tidak mengungkapkan makna internal dan digunakan dalam next_function); area_uuid (pengenal kelompok katalog yang tidak mengungkapkan makna internal); country_uuid (pengenal negara yang tidak mengungkapkan makna internal); prefix (prefiks lengkap yang diawali dengan '+' dan kode panggilan negara); name (nama katalog; karakter tanda kutip dapat muncul dengan karakter escape garis miring terbalik); metered, overflow dan needs_registration (penanda yang dapat bertipe boolean atau number; perlakukan setiap nilai yang dianggap benar sebagai ya); restrictions (kosong jika pendaftaran tidak diperlukan, selain itu berisi teks persyaratan yang dapat mencakup pergantian baris HTML dan tautan, tanda kutip yang mengapit teks, serta karakter yang di-escape; perlakukan sebagai teks tampilan yang tidak tepercaya); state (untuk US, CA dan PR berupa kode negara bagian, atau daftar kosong jika tidak ada yang diketahui; untuk negara lain berupa kode ISO negara); country_iso; is_mobile (1 dalam kelompok seluler, selain itu 0); number_type (sama dengan group_key); available (jumlah bertipe integer yang dilaporkan katalog untuk entri tersebut, 0 jika tidak dilaporkan); sms_coverage (1 jika ada fitur yang menyebut SMS atau MMS); returns_numbers (1 jika nomor tertentu dapat dicantumkan); next_function ('v3/getnumbers/{uuid}' jika returns_numbers bernilai 1, selain itu 'v3/order/{uuid}'); prices; features (daftar string kemampuan); group_key; group_type_uuid. Setiap entri prices memiliki price_id (pengenal paket yang tidak mengungkapkan makna internal), is_customer_custom (true jika harga khusus untuk akun Anda berlaku; hanya untuk paket tanpa kanal yang disertakan), per_minute dan free_minutes (string desimal), setup_price dan monthly_price (string dengan dua angka desimal), serta channels (jumlah kanal yang disertakan, bertipe integer). Entri tanpa paket harga apa pun tidak disertakan. Maksimal 1000 entri katalog per jenis nomor dipertimbangkan untuk setiap permintaan. Jika tidak ada jenis yang memiliki entri, response berupa daftar kosong dengan status.results bernilai 0. Jika pencarian katalog secara langsung gagal, respons mungkin tidak menggunakan struktur pembungkus ini, atau beberapa kelompok mungkin tidak disertakan.

Bentuk respons sebagai ilustrasi; bukan data akun langsung atau penawaran harga terkini.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

Kesalahan

• 500: msg 'ISO Code parameter is required': isocode tidak ada atau kosong. Ini adalah kesalahan permintaan yang dapat diperbaiki. Tidak ada status HTTP yang sesuai yang ditetapkan.
• 404: msg 'Error: no such country': negara tersebut tidak dikenal atau tidak ditautkan ke katalog nomor khusus. Tidak ada status HTTP yang sesuai yang ditetapkan.
• 401: Autentikasi tidak disertakan atau gagal. Dikirim dengan status HTTP 401.

Ketersediaan dan efek samping

• Tidak melakukan pemesanan. Tidak ada langkah pembebanan biaya dalam kode endpoint ini.
• Memperbarui detail katalog dan penawaran harga untuk akun Anda, menggantikan penawaran sebelumnya untuk paket yang sama. Cara endpoint pemesanan menggunakan penawaran ini didokumentasikan secara terpisah.
• Harga berlaku khusus untuk akun Anda dan dapat mencakup harga khusus. Respons tidak menyebutkan mata uang.
• Melakukan pencarian katalog secara langsung, sehingga dapat lebih lambat daripada panggilan penelusuran lainnya. Hasil dapat berubah di antara panggilan.