Sebelum memulai
Pilih area menggunakan getareas. Salin ID area dari responsnya atau dari nilai yang dikembalikan dalam next_function. Untuk area Amerika Serikat atau Kanada, gunakan getstates jika Anda ingin membatasi hasil ke satu negara bagian atau provinsi.
Membaca hasil
Periksa status.code dalam isi JSON serta status HTTP. Hasil yang berhasil terdapat dalam larik response. Secara bawaan, respons diurutkan berdasarkan nama. available merupakan perkiraan, dan penanda katalog tidak menggantikan pemeriksaan kemampuan aktual serta persyaratan pendaftaran nomor yang dipilih.
Memilih langkah berikutnya
Gunakan hasil yang tidak dikelompokkan. Jika returns_numbers bernilai 1, nilai yang dikembalikan dalam next_function mengarah ke pencarian nomor. Jika nilainya 0, nomor dialokasikan saat pemesanan dan jalurnya mengarah ke operasi pemesanan. Periksa operasi tersebut beserta persyaratannya sebelum mengirim permintaan: permintaan pemesanan dapat membebankan biaya ke akun Anda. Jangan secara otomatis mengirim permintaan ke setiap jalur yang dikembalikan.
Harga tidak disertakan di sini. Tinjau penawaran harga yang terkait, dokumen yang diperlukan, dan petunjuk pemesanan sebelum membeli. Simpan ID prefiks individual dan ID penawaran harga yang dikembalikan, alih-alih menyusunnya sendiri dari prefiks telepon yang ditampilkan.
Opsi tampilan lanjutan
compact=1 mengembalikan sampel yang diacak dengan paling banyak 100 baris, bukan satu halaman dari kumpulan hasil yang lebih besar. Pengelompokan menghasilkan baris ringkasan dan ID sintetis; gunakan respons biasa yang tidak dikelompokkan untuk memilih prefiks individual. Jangan menggunakan hasil sampel atau hasil yang dikelompokkan untuk menyatakan bahwa persediaan sudah tercakup seluruhnya atau bahwa kemampuan yang ditunjukkan bersifat pasti.
Permintaan
Gunakan kredensial akun API Anda yang telah diaktifkan melalui HTTPS. Autentikasi Basic dan token bearer akun API yang telah diaktifkan didukung; pembatasan akun tetap berlaku.
Gunakan GET dan kirim parameter opsional dalam string kueri. Jangan mengandalkan mekanisme cadangan yang membaca parameter dari isi formulir.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
area_id | string | Ya | Salin pengenal area dari getareas atau dari next_function yang dikembalikannya. Perlakukan pengenal tersebut sebagai nilai opak yang tidak perlu ditafsirkan; jangan menyusun atau menghitung hash-nya sendiri. |
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
state | string | Tidak | Hanya untuk area US dan CA. Gunakan kode negara bagian/provinsi dari getstates, atau nama lengkapnya. Kode tidak membedakan huruf besar dan kecil; pada nama, perbedaan huruf besar dan kecil serta spasi berulang diabaikan. Negara lain atau nilai tidak kosong yang tidak dikenali akan menghasilkan kesalahan API. |
compact | string | Tidak | Mode sampel opsional: 1, true atau on. Hasil diacak, dengan paling banyak 100 baris. Jangan sertakan parameter ini untuk mendapatkan daftar hasil lengkap; endpoint ini tidak menyediakan halaman/kursor. |
group | integer | Tidak | Ringkasan tampilan lanjutan: nilai 1 hingga 6 menggabungkan baris dan mengembalikan prefiks tampilan yang sebagian karakternya disamarkan. UUID kelompok bersifat sintetis dan tidak dapat digunakan sebagai pengganti ID prefiks individual. Kirim permintaan tanpa pengelompokan sebelum memilih prefiks untuk pencarian nomor atau pemesanan. Jangan sertakan parameter ini untuk alur kerja biasa. |
pid | string | Tidak | Pemilih persediaan opsional yang disediakan oleh MultiTEL, dalam bentuk numerik atau heksadesimal 32 karakter yang didukung. Jangan sertakan untuk penggunaan biasa. Nilai yang tidak dikenali diabaikan tanpa pemberitahuan. Nilai ini bukan prefiks telepon atau ID paket harga. |
Respons
Struktur pembungkus JSON standar status/response. status.results menghitung baris yang dikembalikan, termasuk hasil pengambilan sampel atau pengelompokan. response berisi objek prefiks. Tidak ada kolom harga yang dikembalikan. Dalam respons biasa yang tidak dikelompokkan, uuid adalah ID prefiks; area_uuid dan country_uuid adalah pengenal yang dikembalikan; prefix dan name adalah informasi tampilan; available merupakan perkiraan ketersediaan, bukan reservasi; needs_registration dan restrictions menjelaskan informasi pendaftaran; sms_coverage, is_mobile dan number_type merupakan petunjuk katalog, bukan jaminan kemampuan suatu nomor tertentu. number_type dapat kosong atau berupa string katalog lainnya, jadi jangan mensyaratkan enumerasi tetap. state berupa string dan dapat kosong atau memuat pemformatan katalog. latitude dan longitude dapat kosong. metered dan overflow adalah penanda katalog, bukan nilai uang. returns_numbers memilih rute untuk menampilkan daftar nomor (1) atau rute untuk mengalokasikan nomor saat pemesanan (0). next_function mengidentifikasi rute berikutnya tersebut. Respons yang dikelompokkan juga memuat fitur gabungan, termasuk nilai fitur cadangan; jangan menafsirkannya sebagai kemampuan setiap nomor yang telah diverifikasi.
Contoh struktur respons; bukan data akun langsung atau penawaran harga terkini.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"uuid": "PREFIX_ID_FROM_RESPONSE",
"area_uuid": "AREA_ID_FROM_RESPONSE",
"country_uuid": "COUNTRY_ID_FROM_RESPONSE",
"prefix": "+1212",
"name": "Example area",
"metered": 0,
"overflow": 0,
"needs_registration": 0,
"restrictions": "",
"state": "NY",
"country_iso": "US",
"is_mobile": 0,
"number_type": "local",
"latitude": "",
"longitude": "",
"available": 12,
"sms_coverage": 1,
"returns_numbers": 1,
"next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
}
]
}Kesalahan
- 404: Invalid area ID: dapatkan ID area terkini melalui penelusuran.
- 404: State filter is only available for US and CA: jangan sertakan state untuk negara lain.
- 404: Invalid state: gunakan negara bagian/provinsi yang dikembalikan oleh getstates untuk negara ini.
- 404: No prefixes found: tidak ada baris katalog yang cocok yang dikembalikan. Hal ini tidak membuktikan bahwa suatu nomor tertentu tidak akan pernah dapat dipesan.
- 500: Kesalahan: 'Failed loading prefixes': pencarian katalog gagal. Coba lagi nanti dan hubungi dukungan jika masalah berlanjut.
Ketersediaan dan efek samping
- Ini adalah langkah penelusuran, bukan konfirmasi pesanan. Ketersediaan dapat diperbarui melalui pencarian katalog lanjutan, sehingga waktu tunggu respons dapat bervariasi.
- Harga tidak dikembalikan. Ambil penawaran harga nomor atau pesanan yang berlaku dan tinjau persyaratan pendaftaran sebelum melakukan pemesanan.
- Jangan menganggap available sebagai jumlah stok yang pasti, nilai nol sebagai larangan pemesanan yang berlaku untuk semua keadaan, atau pencarian yang berhasil sebagai reservasi. Ketersediaan dapat berubah sebelum pemesanan.