Pengembang

GET/v3/get_document_number_types/{country}

Daftar jenis nomor untuk registrasi

Temukan nama jenis nomor yang saat ini tercantum dalam katalog registrasi untuk suatu negara.

Di halaman ini
  1. Pilih jenis berdasarkan nama yang dikembalikan
  2. Jumlah grup bukanlah persediaan nomor
  3. Permintaan
  4. Respons
  5. Kesalahan
  6. Ketersediaan dan efek samping

Pilih jenis berdasarkan nama yang dikembalikan

Gunakan negara dari get_document_countries. Teruskan nama jenis yang dikembalikan ke get_requirements. ID katalog jenis bukanlah ID prefiks, ID nomor, atau ID kategori bukti.

Jumlah grup bukanlah persediaan nomor

available_groups menghitung rekaman grup yang dikembalikan oleh pencarian katalog ini. Nilai ini tidak menghitung nomor telepon yang dapat dibeli, tidak mencadangkan persediaan, dan tidak menjamin bahwa katalog telah menelusuri seluruh halaman dari sumber hulu. Cari persediaan nomor yang relevan dan tinjau penawaran harga secara terpisah.

Permintaan

Gunakan kredensial akun API Anda yang telah diaktifkan melalui HTTPS. Autentikasi Basic dan token bearer akun API yang telah diaktifkan didukung; pembatasan akun berlaku.

GET dengan parameter apa pun yang didokumentasikan di jalur URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Parameter jalur
NamaTipeWajibDeskripsi
countrystringYaKode ISO negara dua huruf dari katalog negara registrasi. Spasi di awal dan akhirnya dihapus, lalu hurufnya diubah menjadi huruf kapital.

Respons

Periksa status.code dalam isi JSON serta status HTTP. response adalah larik yang berisi id, name, dan available_groups. Gunakan name sebagai number_type saat memanggil get_requirements; jangan kirim id sebagai penggantinya. available_groups adalah jumlah rekaman grup yang dikembalikan untuk jenis tersebut, bukan jumlah persediaan nomor telepon atau jumlah total lengkap dari seluruh halaman. Jenis yang tidak memiliki grup yang dikembalikan tidak disertakan. Urutan yang diutamakan adalah Local, Mobile, National, Toll Free, Shared Cost, Global, diikuti nama katalog lainnya.

Contoh struktur respons; bukan data akun langsung atau penawaran harga terkini.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Kesalahan

  • 400: country is required: berikan kode ISO negara registrasi.
  • 400: Invalid country ISO or no available DID registration country found: pilih negara dari katalog registrasi saat ini; hal ini tidak membuktikan bahwa tidak ada dokumen yang diperlukan.

Ketersediaan dan efek samping

  • Pencarian katalog/persyaratan ini tidak membuat identitas, mengunggah bukti, meregistrasikan nomor, atau membuat pesanan.
  • Respons katalog yang berhasil bukanlah persetujuan atas dokumen Anda atau konfirmasi bahwa nomor yang dipilih dapat diaktifkan.