Dokumentasi REST API
Buat permintaan API MultiTEL pertama Anda
Mulailah dengan permintaan baca-saja, pahami responsnya, lalu pilih referensi untuk layanan yang ingin Anda bangun.
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 API | URL dasar | Autentikasi dan hasil |
|---|---|---|
| Komunikasi v3 | https://api.multitel.net/v3 | Kredensial Basic yang disetujui; token yang disediakan dan memenuhi syarat hanya untuk operasi yang mendukungnya. JSON status dan response. |
| Registrasi darurat | https://api.multi.tel/emergency | Kredensial Basic yang disetujui atau akses bearer yang disediakan secara khusus. JSON code, message, dan data. |
| Integrasi REST portal | Host dan operasi yang ditampilkan dalam referensi pengembang akun Anda | Gunakan 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.
Permintaan pertama: baca saldo Anda
Permintaan baca ini tidak membeli layanan dan tidak memulai panggilan atau pesan.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"API komunikasi v3 mengembalikan hasil aplikasi di dalam isi JSON. Periksa status HTTP dan status.code sebelum membaca response; permintaan yang ditolak mungkin tidak memiliki objek response. Nilai kode dapat berupa string atau angka.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Ini adalah contoh fiktif, bukan saldo akun. Perlakukan nilai moneter sebagai jumlah desimal. Simpan pesan respons dari server saat mendiagnosis permintaan yang ditolak, dengan kredensial dihapus.
Gunakan data penagihan dengan benar
Respons saldo berisi saldo saat ini, mata uang, dan ketentuan pembayaran. Respons ini tidak memberikan biaya panggilan di masa mendatang maupun faktur lengkap. Gunakan operasi tarif dan penggunaan yang sesuai untuk pertanyaan tersebut. Nomor yang sudah ada dapat memiliki paket yang berbeda dari katalog saat ini.
Pilih integrasi berikutnya
API REST pencarian perutean LRN
Cari nomor perutean dan informasi operator yang tersedia untuk nomor telepon Amerika Utara dengan harga tetap.
Baca panduan integrasi →API REST nomor telepon
Temukan negara dan nomor yang tersedia, periksa penawaran secara lengkap, dan kelola nomor yang Anda miliki.
Baca panduan integrasi →API REST SMS & MMS
Kirim pesan aplikasi yang disetujui dan tangani penerimaan, peristiwa pengiriman, segmentasi, dan biaya.
Baca panduan integrasi →API REST panggilan darurat
Daftarkan nomor dan alamat layanan, pantau status aktivasinya, dan perbarui catatan seiring perubahan lokasi.
Baca panduan integrasi →API REST akun & penagihan
Baca saldo dan informasi penagihan yang tersedia bagi integrasi Anda yang telah disetujui.
Baca panduan integrasi →Pencarian CNAM dan perutean
Baca nama penelepon, pahami tingkatan pencarian, dan gunakan informasi perutean nomor.
Referensi REST CNAM →PBX Terhosting
Mulailah dengan paket layanan yang tersedia dan tenant yang ingin Anda konfigurasikan.
API paket layanan PBX Terhosting →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.