Daftar negara bagian AS atau provinsi Kanada dengan stok nomor tersedia

Gunakan langkah opsional ini untuk Amerika Serikat atau Kanada guna mempersempit pencarian berdasarkan negara bagian atau provinsi. Hanya US dan CA yang diterima.

• Setiap entri menjelaskan prefiks dengan stok tersedia untuk negara bagian tersebut pada saat permintaan dibuat.
• Ikuti next_function untuk menampilkan daftar wilayah di negara bagian tersebut. Tautan ini sudah menyertakan filter state, tetapi tidak menyertakan pid.
• Pencarian wilayah mencocokkan informasi negara bagian dengan cara yang sedikit berbeda. Jika next_function untuk suatu negara bagian mengembalikan No areas found, panggil getareas tanpa menyertakan negara bagian sebagai gantinya.
• Periksa status.code sebelum membaca response. Negara yang tidak didukung atau negara tanpa stok yang cocok akan mengembalikan kode 404 tanpa status HTTP yang sesuai.
• Daftar kosong dengan kode 200 berarti stok tersedia, tetapi tidak memiliki informasi negara bagian. Panggil getareas tanpa menyertakan negara bagian.

Permintaan

Wajib: HTTP Basic atau token Bearer (lihat Autentikasi dan respons API). Jika autentikasi gagal, respons HTTP 401 dikirim sebelum pencarian dijalankan.

GET dengan isocode di jalur. Jika segmen jalur tidak disertakan, kolom isocode yang dikodekan sebagai formulir dibaca sebagai gantinya. pid yang opsional dikirim dalam string kueri.

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

Respons

Struktur pembungkus standar. Jika berhasil, status.code bernilai 200, status.msg kosong, dan status.results berisi jumlah entri. response adalah daftar yang diurutkan berdasarkan name (tanpa membedakan huruf besar dan kecil), lalu berdasarkan kode state. Kolom: state (kode negara bagian atau provinsi yang diambil dari data negara bagian pada prefiks, biasanya dua huruf; nilai yang tidak umum diteruskan tanpa perubahan); name (nama dalam katalog, atau kode jika katalog tidak memiliki nama untuk kode tersebut); country_iso; available (total stok dari seluruh prefiks yang dihitung, selalu lebih besar dari 0); prefix_count (jumlah prefiks dengan stok tersedia yang dihitung); is_mobile (1 jika ada prefiks yang dihitung yang mendukung layanan seluler; selalu 0 untuk US kecuali akun Anda diaktifkan untuk nomor seluler AS); sms_coverage (1 jika ada prefiks yang dihitung yang memiliki cakupan SMS); returns_numbers (1 jika ada prefiks yang dihitung yang memiliki penanda pengembalian nomor atau tidak memiliki nilai untuk penanda tersebut); next_function ('v3/getareas/{isocode}?state={state}'). Jika ada prefiks dengan stok tersedia tetapi tidak satu pun memiliki informasi negara bagian, hasilnya adalah status.code 200 dengan daftar kosong dan status.results 0.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

Kesalahan

• 500: msg 'ISO Code parameter is required': isocode tidak disertakan atau kosong. Ini adalah kesalahan permintaan yang dapat diperbaiki. Tidak ada status HTTP yang sesuai yang ditetapkan; baca status.code.
• 404: msg 'getstates is only available for US and CA': untuk kode negara lain apa pun. Tidak ada status HTTP yang sesuai yang ditetapkan.
• 404: msg 'No states found': tidak ada prefiks dengan stok tersedia yang cocok dengan filter negara dan sumber. Tidak ada status HTTP yang sesuai yang ditetapkan.
• 401: Autentikasi tidak disertakan atau gagal. Dikirim dengan status HTTP 401.

Ketersediaan dan efek samping

• Hanya melakukan pencarian. Tidak mencadangkan, memesan, atau mengubah apa pun. available hanya memberikan informasi dan tidak menahan nomor.