Pengembang

GET/v3/getcountries

Daftar negara dengan stok nomor tersedia

Mengembalikan negara yang dapat ditampilkan dan saat ini memiliki stok untuk setidaknya satu prefiks nomor. Setiap entri mencakup kode panggilan, kode ISO, penanda seluler dan SMS tingkat negara, koordinat, serta tautan next_function ke area cakupan negara tersebut.

Di halaman ini
  1. Permintaan
  2. Respons
  3. Kesalahan
  4. Ketersediaan dan efek samping

Mulai pencarian nomor lokal di sini. Daftar ini hanya berisi negara yang saat ini memiliki stok nomor. Pencarian ini tidak mencadangkan apa pun.

  • Teruskan isocode ke getareas, ke getstates (hanya US dan CA) atau ke other.
  • next_function selalu mengarah ke v3/getareas/{isocode}. Untuk Amerika Serikat dan Kanada, Anda dapat memanggil getstates terlebih dahulu untuk mempersempit hasil berdasarkan negara bagian atau provinsi.
  • is_mobile dan sms_coverage merupakan penanda tingkat negara, bukan jaminan untuk setiap nomor. Untuk Amerika Serikat, is_mobile bernilai 0 kecuali akun Anda telah diaktifkan untuk nomor seluler Amerika Serikat.
  • Negara dengan cakupan yang seluruhnya hanya tersedia melalui pemesanan tidak dicantumkan. Anda tetap dapat memanggil getareas atau other secara langsung untuk negara yang tidak tercantum.
  • Urutkan sendiri daftar ini jika Anda memerlukan urutan tertentu.

Jika tidak ada negara yang memenuhi syarat, response bernilai null dan status.code bernilai 200.

Permintaan

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

GET tanpa isi permintaan. Satu-satunya parameter adalah pid yang bersifat opsional dan dikirim dalam string kueri.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Parameter kueri
NamaTipeWajibDeskripsi
pidstringTidakUntuk penggunaan lanjutan dan bersifat opsional. Mempersempit daftar ke negara yang ditandai untuk satu sumber inventaris. Gunakan hanya nilai yang diberikan oleh MultiTEL, dalam bentuk numerik atau heksadesimal sepanjang 32 karakter, dan jangan sertakan parameter ini untuk penggunaan biasa. pid tidak mempersempit pemeriksaan stok yang dijelaskan dalam respons. Nilai yang tidak dikenali, nol, dan nilai yang tidak diterima oleh endpoint ini diabaikan tanpa kesalahan; dalam hal ini, daftar mencakup semua sumber yang didukung.

Respons

Struktur pembungkus standar. Jika berhasil, status.code bernilai 200, status.msg bernilai 'Results: N', status.results bernilai N, dan response berupa daftar negara yang urutannya tidak dijamin. Kolom: countrycode (kode panggilan negara tanpa '+'); name (nama negara); description (nilainya sama dengan name); isocode (kode ISO 3166-1 alpha-2); is_mobile (0 atau 1, penanda katalog tingkat negara, selalu 0 untuk US kecuali akun Anda telah diaktifkan untuk nomor seluler US); sms_coverage (0 atau 1, penanda katalog tingkat negara); latitude dan longitude (koordinat negara); next_function ('v3/getareas/{isocode}'). Suatu negara hanya dicantumkan jika dapat ditampilkan dan setidaknya satu prefiksnya saat ini memiliki stok di salah satu sumber inventaris. Negara yang seluruh cakupannya hanya tersedia melalui pemesanan (tanpa stok) tidak dicantumkan. Pemeriksaan stok ini lebih luas daripada filter yang diterapkan getareas, sehingga negara yang tercantum terkadang dapat menghasilkan respons 'No areas found' di sana. Jika tidak ada negara yang memenuhi syarat, status.code bernilai 200, status.msg bernilai 'Results: 0', kolom status.results tidak disertakan, dan response bernilai null.

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

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Kesalahan

  • 401: Autentikasi tidak disertakan atau gagal. Dikirim dengan status HTTP 401 (lihat Autentikasi dan respons API).

Ketersediaan dan efek samping

  • Hanya melakukan pencarian. Tidak mencadangkan, memesan, atau mengubah apa pun.
  • Hasil mencerminkan stok pada saat permintaan dibuat dan dapat berubah di antara pemanggilan.