Dokumentasi REST API

API REST nomor telepon

Temukan negara dan nomor yang tersedia, periksa penawaran secara lengkap, dan kelola nomor yang Anda miliki.

Pilih API dan kredensial secara bersamaan

Akun dengan profil Pengembang & Otomatisasi, Bisnis, dan Penyedia komunikasi yang telah disetujui dapat mengintegrasikan layanan yang diaktifkan. Pengembang individu tidak perlu berpura-pura menjadi perusahaan. SMS/MMS dari aplikasi memerlukan persetujuan pengiriman dan registrasi yang berlaku. Layanan Pribadi & Keluarga tidak memiliki API pengiriman pesan yang dapat diakses pelanggan.

Keluarga APIURL dasarAutentikasi dan hasil
Komunikasi v3https://api.multitel.net/v3Kredensial Basic yang disetujui; token yang disediakan dan memenuhi syarat hanya untuk operasi yang mendukungnya. JSON status dan response.
Registrasi darurathttps://api.multi.tel/emergencyKredensial Basic yang disetujui atau akses bearer yang disediakan secara khusus. JSON code, message, dan data.
Integrasi REST portalHost dan operasi yang ditampilkan dalam referensi pengembang akun AndaGunakan kredensial, cakupan izin (scope), dan skema yang didokumentasikan untuk operasi tersebut. Permintaan sesi browser menggunakan antarmuka yang terpisah.

Atur MULTITEL_API_USERNAME dan MULTITEL_API_PASSWORD melalui konfigurasi rahasia server Anda sebelum menggunakan contoh. Jangan pernah menanamkannya di JavaScript browser publik, URL, atau kontrol sumber. Kredensial khusus dikelola di pengaturan Integrasi API.

Baca katalog negara yang tersedia

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/getcountries"

Respons v3 berisi status dan larik response. Entri negara mencakup isocode, name, countrycode, informasi kapabilitas, dan next_function. Ketersediaan bergantung pada akun dan inventaris; keberadaan suatu negara bukan janji bahwa setiap prefiks atau jenis nomor tersedia.

{
  "status": {
    "code": 200,
    "msg": "Results: 1"
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "37.0902",
      "longitude": "-95.7129",
      "next_function": "v3/getareas/US"
    }
  ]
}

Dari penemuan hingga aktivasi

  1. Pilih negara, subdivisi bila diperlukan, area, dan jenis nomor menggunakan operasi geografi yang sesuai.
  2. Baca harga pemasangan, bulanan, dan penggunaan, saluran, alokasi, serta persyaratan registrasi untuk nomor yang dipilih.
  3. Kirim dokumen pengguna akhir yang diperlukan dan tinjau statusnya. Nomor dapat tetap tertunda hingga disetujui.
  4. Pesan satu kali dengan pilihan inventaris/harga yang tepat. Jika respons tidak pasti, periksa inventaris Anda sebelum mengirim pesanan lain.
  5. Konfigurasikan perutean suara dan pengiriman pesan secara terpisah, lalu uji seluruh rute yang dimaksudkan.

Menangani kesalahan dan percobaan ulang

Kegagalan autentikasi atau izin
Periksa status aktif kredensial API, layanan yang diizinkan, dan pembatasan IP sumber. Cookie sesi portal bukan kredensial integrasi.
Kredit tidak mencukupi atau persetujuan belum terpenuhi
Selesaikan masalah saldo akun, persetujuan pengiriman, atau persyaratan dokumen sebelum mengulangi operasi.
Tidak ada hasil
Tangani inventaris kosong atau nama pemanggil yang tidak ditemukan sebagai hasil yang wajar. Jangan berasumsi bahwa nomor yang sintaksnya valid memiliki semua layanan.
Waktu tunggu jaringan habis atau layanan gagal
Gunakan percobaan ulang terbatas dengan backoff untuk operasi baca. Untuk pembelian, pengiriman, atau registrasi, periksa dahulu status operasinya; mengulangi permintaan yang sudah diterima dapat menggandakan tindakan yang ditagih.

Dukungan idempotensi bergantung pada masing-masing keluarga API. Emergency API mendukung kunci percobaan ulang; hal itu tidak membuat permintaan v3 sembarang menjadi idempoten. Simpan stempel waktu, ID yang dikembalikan, dan respons yang telah disamarkan untuk dukungan.

Lanjutkan dengan referensi akun Anda

Referensi setelah masuk menyaring operasi berdasarkan izin dan layanan yang aktif pada akun Anda. Gunakan host, jenis kredensial, kolom permintaan, dan skema respons persis seperti yang tercantum di sana. Konsol dapat menjalankan operasi langsung, termasuk pembelian dan pengiriman pesan.