Pilih negara dan jenis nomor
Pilih negara pendaftaran, lalu gunakan nama yang dikembalikan oleh get_document_number_types. Kirim nama tersebut sebagai number_type, bukan ID jenis atau kategori penemuan nomor umum.
Baca instruksi yang dikembalikan
Simpan ID persyaratan dan relasi untuk alur kerja identitas/dokumen yang relevan. Panggilan ini mengembalikan persyaratan; panggilan ini tidak memvalidasi atau mengirimkan berkas Anda. Ikuti instruksi yang dikembalikan dan setiap persyaratan khusus untuk nomor yang dipilih.
Jangan menafsirkan kesalahan sebagai pengecualian
Kesalahan tentang negara yang tidak valid atau tidak adanya dokumen pendaftaran negara menggabungkan dua kondisi. Kesalahan tersebut bukan bukti bahwa pendaftaran tidak diperlukan. Kegagalan pencarian atau hasil kosong juga tidak menyetujui pelanggan atau nomor. Hubungi dukungan jika hasilnya tidak jelas.
Permintaan
Gunakan kredensial akun API Anda yang aktif melalui HTTPS. Autentikasi Basic dan token bearer akun API yang aktif didukung; pembatasan akun berlaku.
POST dengan application/json atau application/x-www-form-urlencoded.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
--request POST \
--header "Content-Type: application/json" \
--data '{"country":"US","number_type":"Local"}' \
"https://api.multitel.net/v3/get_requirements"| Nama | Jenis | Wajib | Deskripsi |
|---|---|---|---|
country | string | Ya | Kode ISO negara dari get_document_countries. |
number_type | string | Ya | Nama jenis dari get_document_number_types, misalnya Local; pencocokan mengabaikan perbedaan huruf besar dan kecil. Berikan namanya, bukan ID-nya. |
Respons
Periksa status.code di body JSON selain status HTTP. response adalah satu sumber daya persyaratan tunggal dengan id, type dan attributes, ditambah relationships jika dikembalikan. ID dalam data sumber daya dan relasi bersifat opak. Teks restriction_message yang bersifat opsional telah dihapus tag HTML-nya; perlakukan teks yang tersisa sebagai teks, bukan HTML tepercaya. Handler mengembalikan sumber daya persyaratan yang pertama, jadi jangan menyimpulkan bahwa respons ini adalah daftar yang lengkap. Ketersediaan atribut/relasi bergantung pada negara dan jenis; contoh ini bukan skema tetap yang lengkap.
Bentuk respons ilustratif; bukan data akun langsung atau penawaran harga terkini.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"id": "REQUIREMENT_ID_FROM_RESPONSE",
"type": "RESOURCE_TYPE_FROM_RESPONSE",
"attributes": {
"restriction_message": "Example country-specific instructions."
}
}
}Kesalahan
- 400: Validasi negara dan number_type gagal: berikan kedua nilai yang wajib. Teks validasi dapat berisi pemformatan.
- 400: Invalid country ISO or No country registration documents required.: pesan yang ambigu ini dengan sendirinya tidak membuktikan adanya pengecualian pendaftaran.
- 400: Invalid number type: gunakan nama jenis yang dikembalikan. Kesalahan lama mencantumkan Global, Local, Mobile, National, Shared Cost dan Toll Free.
- 500: Unable to load registration requirements for the specified country and number type.: persyaratan tidak berhasil dikembalikan. Coba lagi nanti atau hubungi dukungan.
Ketersediaan dan efek samping
- Pencarian katalog/persyaratan ini tidak membuat identitas, mengunggah bukti, mendaftarkan nomor, atau membuat pesanan.
- Respons katalog yang berhasil bukan merupakan persetujuan atas dokumen Anda atau konfirmasi bahwa nomor yang dipilih dapat diaktifkan.