REST API belgeleri
İlk MultiTEL API isteğinizi yapın
Salt okunur bir istekle başlayın, yanıtı anlayın, ardından geliştirmek istediğiniz hizmetin referansını seçin.
API’yi ve kimlik bilgisini birlikte seçin
Onaylı Geliştirici ve Otomasyon, İşletme ve İletişim Sağlayıcısı hesapları etkinleştirilmiş hizmetleri entegre edebilir. Bireysel bir geliştiricinin şirket gibi davranması gerekmez. Uygulama SMS/MMS’i için geçerli gönderim onayı ve kayıt gerekir. Bireyler ve aileler hizmetinde müşterinin erişebileceği, mesaj gönderimini başlatan bir API yoktur.
| API ailesi | Temel URL | Kimlik doğrulama ve sonuç |
|---|---|---|
| İletişim v3 | https://api.multitel.net/v3 | Onaylı Basic kimlik bilgileri; uygun şekilde sağlanmış belirteçler yalnızca bunları destekleyen işlemlerde. JSON status ve response. |
| Acil durum kaydı | https://api.multi.tel/emergency | Onaylı Basic kimlik bilgileri veya özel olarak sağlanmış bearer erişimi. JSON code, message ve data. |
| Portal REST entegrasyonları | Hesabınızın geliştirici başvuru kaynağında gösterilen ana bilgisayar ve işlem | Bu işlemin belgelenmiş kimlik bilgisini, kapsamlarını ve şemasını kullanın. Tarayıcı oturumu istekleri ayrı bir erişim yoludur. |
Örnekleri kullanmadan önce MULTITEL_API_USERNAME ve MULTITEL_API_PASSWORD değerlerini sunucunuzun gizli bilgi yapılandırması üzerinden ayarlayın. Bunları asla herkese açık tarayıcı JavaScript’ine, URL’lere veya kaynak denetimine eklemeyin. Özel kimlik bilgileri API Entegrasyonu ayarları bölümünde yönetilir.
İlk istek: bakiyenizi okuyun
Bu okuma işlemi bir hizmet satın almaz, arama veya mesaj başlatmaz.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"İletişim v3 API’si, uygulama sonucunu JSON gövdesinin içinde döndürür. response alanını okumadan önce HTTP durumunu ve status.code değerini kontrol edin; reddedilen bir istekte yanıt nesnesi bulunmayabilir. Kod değerleri dize veya sayı olabilir.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Bu kurgusal bir örnektir, gerçek bir hesap bakiyesi değildir. Parasal değerleri ondalık tutarlar olarak ele alın. Reddedilen bir isteği teşhis ederken sunucunun yanıt mesajını, kimlik bilgileri çıkarılmış hâlde saklayın.
Faturalandırma verilerini doğru kullanın
Bakiye yanıtı güncel bakiyeyi, para birimini ve ödeme koşullarını içerir. Gelecekteki bir aramanın maliyetini veya eksiksiz bir faturayı vermez. Bu sorular için ilgili tarife ve kullanım işlemlerini kullanın. Mevcut numaralar, bugünkü kataloğun planlarından farklı planlara sahip olabilir.
Sonraki entegrasyonunuzu seçin
LRN yönlendirme sorgusu REST API’si
Bir Kuzey Amerika telefon numarasının yönlendirme numarasını ve mevcut operatör bilgilerini sabit bir fiyatla sorgulayın.
Entegrasyon rehberini okuyun →Telefon numarası REST API’leri
Mevcut ülkeleri ve numaraları keşfedin, teklifin tamamını inceleyin ve sahip olduğunuz numaraları yönetin.
Entegrasyon rehberini okuyun →SMS ve MMS REST API’leri
Onaylı uygulama mesajlarını gönderin; kabul, iletim olayları, bölümleme ve ücretleri yönetin.
Entegrasyon rehberini okuyun →Acil arama REST API’leri
Bir numarayı ve hizmet adresini kaydedin, etkinleştirme durumunu izleyin ve konum değiştikçe kaydı güncel tutun.
Entegrasyon rehberini okuyun →Hesap ve faturalama REST API’leri
Onaylı entegrasyonunuz için kullanılabilen bakiye ve faturalama bilgilerini okuyun.
Entegrasyon rehberini okuyun →CNAM ve yönlendirme sorguları
Arayan adlarını okuyun, sorgu katmanlarını anlayın ve numara yönlendirme bilgilerini kullanın.
CNAM REST referansı →Barındırılan PBX
Mevcut hizmet planlarından ve yapılandırmayı planladığınız PBX ortamından (tenant) başlayın.
Barındırılan PBX hizmet planı API’si →Hataları ve yeniden denemeleri yönetme
- Kimlik doğrulama veya yetki hatası
- API kimlik bilgisinin etkin olup olmadığını, izin verilen hizmeti ve kaynak IP kısıtlamasını kontrol edin. Portal oturum çerezi bir entegrasyon kimlik bilgisi değildir.
- Yetersiz kredi veya eksik onay
- İşlemi tekrarlamadan önce hesap bakiyesi, gönderim onayı veya belge gereksinimini çözün.
- Sonuç yok
- Boş envanteri veya bulunamayan arayan adını olağan bir sonuç olarak ele alın. Sözdizimi geçerli bir numaranın her hizmete sahip olduğunu varsaymayın.
- Ağ zaman aşımı veya hizmet hatası
- Okuma işlemlerinde geri çekilmeli (backoff) ve sınırlı sayıda yeniden deneme kullanın. Satın alma, gönderim veya kayıt işlemlerinde önce işlemin durumunu inceleyin; kabul edilmiş bir isteği yeniden denemek faturalandırılabilir bir işlemin tekrarlanmasına yol açabilir.
Idempotency desteği her API ailesine özgüdür. Acil durum API’si yeniden deneme anahtarlarını destekler; bu, v3 isteklerinin keyfi olarak idempotent olduğu anlamına gelmez. Destek için zaman damgalarını, döndürülen kimlikleri ve bilgileri çıkarılmış yanıtları saklayın.
Hesabınızın referansıyla devam edin
Oturum açılmış referans, işlemleri izinlerinize ve etkinleştirilmiş hizmetlerinize göre filtreler. Onun belirttiği ana makine adını, kimlik bilgisi türünü, istek alanlarını ve yanıt şemasını aynen kullanın. Konsollar, satın alma ve mesaj gönderme dahil canlı işlemleri çalıştırabilir.