Dokumentasi REST API

API REST panggilan darurat

Daftarkan nomor dan alamat layanan, pantau status aktivasinya, dan perbarui catatan seiring perubahan lokasi.

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 cakupan tanpa mendaftarkan nomor

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

https://api.multitel.net/emergency juga didukung. Kedua URL dasar darurat tidak mengandung /v3. Cakupan mencantumkan negara internasional, jenis nomor yang didukung, dan harga; kelayakan E911 Amerika Utara diperiksa saat registrasi.

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

Ini hanya mengilustrasikan envelope. Baca skema data setiap operasi di panduan Emergency API yang dipublikasikan.

Daftar, ikuti status, lalu konfigurasikan panggilan

  1. Untuk AS/Kanada dan wilayah E911 Amerika Utara lain yang didukung, berikan nomor, alamat E911, dan pernyataan persetujuan yang diperlukan. E911 Amerika Utara hanya tersedia di produksi.
  2. Untuk nomor internasional milik sendiri yang didukung, berikan referensi Dokumen yang tersimpan atau identitas dan alamat pengguna akhir. Tinjau dahulu persyaratan negara dan jenis nomor.
  3. Kirim satu permintaan POST /registrations. Idempotency-Key opsional mengidentifikasi satu mutasi logis; simpan kunci tersebut dan payload yang persis sama di seluruh percobaan ulang.
  4. Baca GET /registrations/:number. Periksa siklus hidup, pending, dan actionRequired; selesaikan koreksi yang diperlukan. Diterima atau tertunda bukan berarti layanan aktif.
  5. Setelah aktivasi, konfigurasikan ID pemanggil darurat yang benar dan rute panggilan khusus negara. Gunakan prosedur verifikasi non-darurat dari layanan.

Registrasi sandbox internasional terisolasi dan tidak mengaktifkan panggilan darurat yang sebenarnya. Kredensial akun utama diperlukan untuk E911 Amerika Utara; panduan menjelaskan dukungan subakun internasional yang terbatas.

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.