Stokta telefon numarası bulunan ABD eyaletlerini veya Kanada illerini listeleme

Amerika Birleşik Devletleri veya Kanada için aramayı eyalet ya da il bazında daraltmak üzere bu isteğe bağlı adımı kullanın. Yalnızca US ve CA kabul edilir.

• Her kayıt, istek anında ilgili eyalette stokta bulunan önekleri açıklar.
• Eyaletin bölgelerini listelemek için next_function bağlantısını izleyin. Bu bağlantı zaten state filtresini içerir; ancak pid parametresini içermez.
• Bölge sorgulaması, eyalet bilgilerini biraz farklı bir biçimde eşleştirir. Bir eyaletin next_function bağlantısı No areas found sonucunu döndürürse bunun yerine getareas işlevini eyalet belirtmeden çağırın.
• Önce status.code değerini kontrol edin, ardından response alanını okuyun. Desteklenmeyen bir ülke veya eşleşen stoku bulunmayan bir ülke için döndürülen kod 404 olur; buna karşılık gelen bir HTTP durum kodu gönderilmez.
• Kod 200 olduğunda listenin boş olması, stok bulunduğu ancak eyalet bilgisi içermediği anlamına gelir. getareas işlevini eyalet belirtmeden çağırın.

İstek

Gerekli: HTTP Basic kimlik doğrulaması veya Bearer belirteci (bkz. Kimlik doğrulama ve API yanıtları). Kimlik doğrulaması başarısız olursa sorgulama çalıştırılmadan önce HTTP 401 yanıtı gönderilir.

GET isteğinde yol içinde isocode bulunur. Yol bölümü belirtilmezse bunun yerine form biçiminde kodlanmış bir isocode alanı okunur. İsteğe bağlı pid parametresi sorgu dizesinde gönderilir.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getstates/US'

Yanıt

Standart yanıt zarfı kullanılır. Başarılı olduğunda status.code değeri 200 olur, status.msg boş olur ve status.results kayıt sayısını belirtir. response, önce büyük/küçük harf ayrımı yapılmadan name alanına, ardından state koduna göre sıralanan bir listedir. Alanlar: state (öneklerin eyalet verilerinden alınan, genellikle iki harfli eyalet veya il kodu; alışılmadık değerler değiştirilmeden aktarılır); name (katalogdaki ad veya katalogda buna ait bir ad yoksa kod); country_iso; available (sayılan öneklerin toplam stoku; her zaman 0 değerinden büyüktür); prefix_count (sayılan stoktaki öneklerin adedi); is_mobile (sayılan öneklerden herhangi biri mobil kullanımı destekliyorsa 1; hesabınızda ABD mobil numaraları etkinleştirilmedikçe US için her zaman 0); sms_coverage (sayılan öneklerden herhangi birinin SMS kapsamı varsa 1); returns_numbers (sayılan öneklerden herhangi birinde numara döndürme bayrağı etkinse veya bu bayrak için değer yoksa 1); next_function ('v3/getareas/{isocode}?state={state}'). Stokta önekler bulunduğu halde hiçbiri eyalet bilgisi içermiyorsa status.code değeri 200 olur, liste boş olur ve status.results değeri 0 olur.

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": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

Hatalar

• 500: msg 'ISO Code parameter is required': isocode eksik veya boştur. Bu, düzeltilebilir bir istek hatasıdır. Buna karşılık gelen bir HTTP durum kodu ayarlanmaz; status.code değerini okuyun.
• 404: msg 'getstates is only available for US and CA': diğer tüm ülke kodları için döndürülür. Buna karşılık gelen bir HTTP durum kodu ayarlanmaz.
• 404: msg 'No states found': ülke ve kaynak filtreleriyle eşleşen stokta önek yoktur. Buna karşılık gelen bir HTTP durum kodu ayarlanmaz.
• 401: Kimlik doğrulaması eksik veya başarısızdır. HTTP durum kodu 401 ile gönderilir.

Kullanılabilirlik ve yan etkiler

• Yalnızca sorgulama yapar. Hiçbir şeyi rezerve etmez, sipariş etmez veya değiştirmez. available yalnızca bilgi amaçlıdır ve numaraları ayırmaz.