Başlamadan önce
Bir bölge seçmek için şu işlevi kullanın: getareas. Bölge kimliğini bu işlevin yanıtından veya döndürülen şu alandan kopyalayın: next_function. ABD veya Kanada'daki bir bölge için şu işlevi kullanabilirsiniz: getstates; böylece sonuçları tek bir eyalet veya ille sınırlandırabilirsiniz.
Sonucu yorumlama
Şu alanı kontrol edin: status.code; JSON gövdesindeki bu alanın yanı sıra HTTP durumunu da kontrol edin. Başarılı sonuçların bulunduğu dizi: response. Varsayılan yanıt ada göre sıralanır. available bir tahmindir; katalog göstergeleri, seçilen numaranın gerçek özelliklerini ve kayıt gerekliliklerini kontrol etmenin yerini tutmaz.
Sonraki adımı seçme
Gruplanmamış bir sonuç kullanın. returns_numbers değeri 1 olduğunda, döndürülen next_function bir numara aramasını gösterir. Değer 0 olduğunda numaralar sipariş sırasında atanır ve yol bir sipariş işlemini gösterir. İsteği göndermeden önce işlemi ve gerekliliklerini inceleyin: bir sipariş isteği hesabınızdan ücret alınmasına neden olabilir. Döndürülen her yola otomatik olarak istek göndermeyin.
Burada fiyat bilgisi yer almaz. Satın almadan önce ilgili fiyat teklifini, gerekli belgeleri ve sipariş talimatlarını inceleyin. Tekil önek ve fiyat teklifi kimliklerini, gösterilen telefon önekinden kendiniz oluşturmak yerine döndürüldükleri haliyle saklayın.
Gelişmiş görüntüleme seçenekleri
compact=1 en fazla 100 satırdan oluşan, sırası karıştırılmış bir örneklem döndürür; bu, daha büyük bir sonuç kümesinin bir sayfası değildir. Gruplama, özet satırlar ve yapay kimlikler oluşturur; tekil bir önek seçmek için normal, gruplanmamış bir yanıt kullanın. Örneklenmiş veya gruplanmış sonuçlara dayanarak envanterin tamamını ya da kesin özellikleri bildirdiğinizi iddia etmeyin.
İstek
Etkin API hesabınızın kimlik bilgilerini HTTPS üzerinden kullanın. Basic kimlik doğrulaması ve etkinleştirilmiş API hesabı bearer belirteçleri desteklenir; hesap kısıtlamaları geçerlidir.
GET kullanın ve isteğe bağlı parametreleri sorgu dizesinde gönderin. Alternatif olarak form gövdesinin kullanılacağına güvenmeyin.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
area_id | string | Evet | Bölge tanımlayıcısını getareas yanıtından veya bu yanıtın next_function alanından kopyalayın. İç yapısına anlam yüklemeden kullanın; kendiniz oluşturmayın veya karma değerini hesaplamayın. |
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
state | string | Hayır | Yalnızca US ve CA bölgeleri içindir. getstates tarafından döndürülen bir eyalet/il kodunu veya tam adını kullanın. Kodlarda büyük/küçük harf ayrımı yapılmaz; adlarda büyük/küçük harf farkları ve yinelenen boşluklar dikkate alınmaz. Başka bir ülke veya tanınmayan, boş olmayan bir değer API hatası döndürür. |
compact | string | Hayır | İsteğe bağlı örnekleme modu: 1, true veya on. Sonuçların sırası karıştırılır ve en fazla 100 satır döndürülür. Sonuç listesinin tamamını almak için bu parametreyi göndermeyin; bu uç noktada sayfa/imleç mekanizması yoktur. |
group | integer | Hayır | Gelişmiş görüntüleme özetleri: 1 ile 6 arasındaki değerler satırları birleştirir ve görüntüleme için maskelenmiş önekler döndürür. Grup UUID'leri yapaydır ve tekil önek kimliklerinin yerine kullanılamaz. Numara araması veya sipariş için bir önek seçmeden önce gruplanmamış bir istek gönderin. Normal iş akışında bu parametreyi göndermeyin. |
pid | string | Hayır | MultiTEL tarafından sağlanan, sayısal biçimde veya desteklenen 32 karakterlik onaltılık biçimde, isteğe bağlı bir envanter seçicisidir. Normal kullanımda göndermeyin. Tanınmayan değerler herhangi bir bildirim olmadan yok sayılır. Bu değer bir telefon öneki veya fiyat planı kimliği değildir. |
Yanıt
Standart status/response JSON zarfı kullanılır. status.results, örnekleme veya gruplama uygulandığında da döndürülen satırları sayar. response önek nesnelerini içerir. Fiyat alanları döndürülmez. Normal, gruplanmamış yanıtta uuid önek kimliğidir; area_uuid ve country_uuid döndürülen tanımlayıcılardır; prefix ve name görüntüleme bilgileridir; available bir rezervasyon değil, kullanılabilirlik tahminidir; needs_registration ve restrictions kayıt bilgilerini açıklar; sms_coverage, is_mobile ve number_type katalogdan alınan ipuçlarıdır ve belirli bir numaranın bir özelliğe sahip olduğunu garanti etmez. number_type boş olabilir veya başka bir katalog dizesi içerebilir; bu nedenle sabit bir numaralandırılmış değer kümesini zorunlu tutmayın. state bir dizedir; boş olabilir veya kataloğa özgü biçimlendirme içerebilir. latitude ve longitude boş olabilir. metered ve overflow parasal tutarlar değil, katalog göstergeleridir. returns_numbers, numaraları listeleme yolunu (1) veya sipariş sırasında numara atama yolunu (0) seçer. next_function bu sonraki yolu belirtir. Gruplanmış yanıtlar ayrıca, alternatif olarak kullanılan özellik değerleri de dahil olmak üzere birleştirilmiş özellikler içerir; bunları her numaranın doğrulanmış özellikleri olarak yorumlamayın.
Yanıt yapısını gösteren bir örnektir; canlı hesap verisi veya güncel bir fiyat teklifi değildir.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"uuid": "PREFIX_ID_FROM_RESPONSE",
"area_uuid": "AREA_ID_FROM_RESPONSE",
"country_uuid": "COUNTRY_ID_FROM_RESPONSE",
"prefix": "+1212",
"name": "Example area",
"metered": 0,
"overflow": 0,
"needs_registration": 0,
"restrictions": "",
"state": "NY",
"country_iso": "US",
"is_mobile": 0,
"number_type": "local",
"latitude": "",
"longitude": "",
"available": 12,
"sms_coverage": 1,
"returns_numbers": 1,
"next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
}
]
}Hatalar
- 404: Invalid area ID: keşif adımından güncel bir bölge kimliği alın.
- 404: State filter is only available for US and CA: diğer ülkeler için state parametresini göndermeyin.
- 404: Invalid state: bu ülke için getstates tarafından döndürülen bir eyalet/il kullanın.
- 404: No prefixes found: eşleşen katalog satırı döndürülmedi. Bu, belirli bir numaranın hiçbir zaman sipariş edilemeyeceğini kanıtlamaz.
- 500: Hata: 'Failed loading prefixes': katalog sorgulaması başarısız oldu. Daha sonra yeniden deneyin ve sorun devam ederse destek ekibiyle iletişime geçin.
Kullanılabilirlik ve yan etkiler
- Bu bir keşif adımıdır, sipariş onayı değildir. Kullanılabilirlik ek katalog sorgularıyla güncellenebileceğinden yanıt süresi değişebilir.
- Fiyatlar döndürülmez. Sipariş vermeden önce ilgili numara veya sipariş için geçerli fiyat teklifini alın ve kayıt gerekliliklerini inceleyin.
- available değerini kesin stok adedi, sıfırı her durumda geçerli bir sipariş yasağı veya başarılı bir sorgulamayı rezervasyon olarak değerlendirmeyin. Kullanılabilirlik sipariş verilmeden önce değişebilir.