Geliştiriciler

GET/v3/getcountries

Stokta numarası bulunan ülkeleri listeleme

Şu anda en az bir numara önekinde stok bulunan görünür ülkeleri döndürür. Her kayıt; ülke arama kodunu, ISO kodunu, ülke düzeyindeki mobil numara ve SMS göstergelerini, koordinatları ve ülkenin kapsama alanlarına yönlendiren bir next_function bağlantısını içerir.

Bu sayfada
  1. İstek
  2. Yanıt
  3. Hatalar
  4. Stok durumu ve yan etkiler

Yerel numara aramaya buradan başlayın. Liste yalnızca şu anda stokta numarası bulunan ülkeleri içerir. Bu işlem hiçbir rezervasyon yapmaz.

  • Parametre olarak isocode değerini getareas, getstates (yalnızca US ve CA) veya other çağrısına iletin.
  • next_function her zaman şu yolu gösterir: v3/getareas/{isocode}. Amerika Birleşik Devletleri ve Kanada için önce getstates çağrısını yaparak sonuçları eyalete veya ile göre daraltabilirsiniz.
  • is_mobile ve sms_coverage ülke düzeyindeki göstergelerdir; her numara için garanti vermezler. Amerika Birleşik Devletleri için is_mobile değeri 0 olur; ancak hesabınızda ABD mobil numaraları etkinleştirilmişse bu kısıtlama geçerli değildir.
  • Kapsamı yalnızca sipariş üzerine temin edilebilen numaralardan oluşan ülkeler listelenmez. Listelenmeyen bir ülke için yine de getareas veya other çağrısını doğrudan yapabilirsiniz.
  • Belirli bir sıralamaya ihtiyacınız varsa listeyi kendiniz sıralayın.

Hiçbir ülke koşulları karşılamıyorsa response değeri null ve status.code değeri 200 olur.

İstek

Gerekli: HTTP Basic kimlik doğrulaması veya Bearer belirteci (bkz. Kimlik doğrulama ve API yanıtları). Kimlik doğrulama başarısız olursa sorgulama yapılmadan önce HTTP 401 yanıtı döndürülür.

Gövdesiz bir GET isteği gönderilir. Tek parametre, sorgu dizesinde gönderilen isteğe bağlı pid parametresidir.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Sorgu parametreleri
AdTürZorunluAçıklama
pidstringHayırGelişmiş kullanıma yönelik ve isteğe bağlıdır. Listeyi, belirli bir envanter kaynağı için işaretlenmiş ülkelerle sınırlar. Yalnızca MultiTEL tarafından sağlanan, sayısal veya 32 karakterlik onaltılık biçimde bir değer kullanın; normal kullanımda bu parametreyi göndermeyin. pid, yanıt bölümünde açıklanan stok kontrolünü daraltmaz. Tanınmayan değerler, sıfır ve bu uç noktanın kabul etmediği değerler hata verilmeden yok sayılır; bu durumda liste desteklenen tüm kaynakları kapsar.

Yanıt

Standart yanıt yapısı kullanılır. İşlem başarılı olduğunda status.code değeri 200, status.msg değeri 'Results: N', status.results değeri N olur; response ise belirli bir sıralaması garanti edilmeyen bir ülke listesidir. Alanlar: countrycode ('+' işareti olmadan ülke arama kodu); name (ülke adı); description (name ile aynı değer); isocode (ISO 3166-1 alpha-2 kodu); is_mobile (0 veya 1 değerini alan, ülke düzeyinde bir katalog göstergesi; US için her zaman 0 olur, ancak hesabınızda US mobil numaraları etkinleştirilmişse bu kısıtlama geçerli değildir); sms_coverage (0 veya 1 değerini alan, ülke düzeyinde bir katalog göstergesi); latitude ve longitude (ülkenin koordinatları); next_function ('v3/getareas/{isocode}'). Bir ülke yalnızca görünürse ve öneklerinden en az biri için herhangi bir envanter kaynağında o anda stok varsa listelenir. Kapsamı tamamen sipariş üzerine temin edilebilen numaralardan oluşan (stok bulunmayan) ülkeler listelenmez. Bu stok kontrolü, getareas tarafından uygulanan filtrelerden daha geniş kapsamlıdır; bu nedenle listelenen bir ülke için orada bazen 'No areas found' yanıtı alınabilir. Hiçbir ülke koşulları karşılamıyorsa status.code değeri 200, status.msg değeri 'Results: 0' olur, status.results alanı bulunmaz ve response değeri null 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",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Hatalar

  • 401: Kimlik doğrulama bilgileri eksik veya kimlik doğrulama başarısız. HTTP durum kodu 401 ile gönderilir (bkz. Kimlik doğrulama ve API yanıtları).

Stok durumu ve yan etkiler

  • Yalnızca sorgulama yapar. Hiçbir rezervasyon veya sipariş oluşturmaz ve hiçbir şeyi değiştirmez.
  • Sonuçlar, isteğin yapıldığı andaki stok durumunu yansıtır ve çağrılar arasında değişebilir.