Bir ülkenin özel numara türlerini ve fiyatlarını listeleme

Yerel numaraları bulmak için getcountries ve getareas kullanılır. Ulusal, ücretsiz arama, paylaşımlı ücretli, küresel ve mobil numaralar için other işlevini ülkenin ISO koduyla çağırın.

• Gruplar sabit bir sırayla gösterilir ve kayıt içermeyen gruplar dahil edilmez.
• Her kayıt, hesabınızın fiyat planlarını şu alanda listeler: prices. Bir plan seçerken şu alanlarını dikkate alın: channels, monthly_price, setup_price, per_minute ve free_minutes. Ayrıca planın price_id değerini, sipariş uç noktasının bunu istediği durumlarda kullanmak üzere saklayın.
• Eğer needs_registration doğru kabul edilen bir değerse, restrictions alanını sipariş vermeden önce okuyun. Bu metni güvenilmeyen görüntüleme içeriği olarak ele alın.
• Şu alanın yönlendirmesini izleyin: next_function; v3/getnumbers/{uuid} belirli bir numara seçmenizi sağlar; v3/order/{uuid} ise doğrudan kayıt üzerinden sipariş verir.
• Boş bir response listesi ve 200 kodu, istek sırasında özel numara türü bulunamadığı anlamına gelir. Kataloğa geçici olarak erişilemiyorsa yanıt eksik olabilir veya geçerli JSON olmayabilir; bu nedenle daha sonra yeniden deneyin.
• Katalogda bulunmayan ülkeler şu kodu döndürür: 404; buna karşılık gelen bir HTTP durumu döndürülmez. Her zaman şu alanı kontrol edin: status.code.

İstek

Gerekli: HTTP Basic veya Bearer belirteci (bkz. Kimlik doğrulama ve API yanıtları). Kimlik doğrulama başarısız olduğunda, sorgulama çalıştırılmadan önce HTTP 401 yanıtı verilir.

GET isteğinde isocode yol içinde yer alır. Yolun bu bölümü belirtilmezse bunun yerine form kodlamalı bir isocode alanı okunur.

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

Yanıt

Standart yanıt zarfı. Başarı durumunda status.code değeri 200 olur, status.msg boş olur ve status.results grup sayısını belirtir. response bir grup listesidir. Grup alanları: group_key (normalleştirilmiş tür anahtarı: national, tollfree, sharedcost, global, mobile veya küçük harflerden ve rakamlardan oluşan başka bir anahtar); group_name (görünen ad); group_type_uuid (iç yapısına anlam yüklenmemesi gereken tür tanımlayıcısı); items. Gruplar sırasıyla national, tollfree, sharedcost, global, mobile olarak, ardından diğer anahtarlar group_name alanına göre sıralanır. items içermeyen gruplar ve yerel numara türü dahil edilmez. US için mobil grup, hesabınız US mobil numaraları için etkinleştirilmedikçe dahil edilmez. Kayıtlar önce name alanına göre (büyük/küçük harfe duyarsız), ardından prefix alanına göre sıralanır. Kayıt alanları: uuid (şu alanda kullanılan, iç yapısına anlam yüklenmemesi gereken kayıt tanımlayıcısı: next_function); area_uuid (katalog grubunun iç yapısına anlam yüklenmemesi gereken tanımlayıcısı); country_uuid (iç yapısına anlam yüklenmemesi gereken ülke tanımlayıcısı); prefix ('+' ve ülke arama koduyla başlayan tam önek); name (katalog adı; tırnak işaretleri ters eğik çizgiyle kaçışlanmış olarak görünebilir); metered, overflow ve needs_registration (boolean veya number türünde olabilen bayraklar; doğru kabul edilen her değeri evet olarak değerlendirin); restrictions (kayıt gerekmiyorsa boştur; aksi halde HTML satır sonları ve bir bağlantı, metni çevreleyen tırnak işaretleri ve kaçışlanmış karakterler içerebilen gereklilik metnidir; güvenilmeyen görüntüleme metni olarak ele alın); state (US, CA ve PR için bir eyalet kodu veya kod bilinmiyorsa boş bir liste; diğer ülkeler için ülkenin ISO kodu); country_iso; is_mobile (mobil grupta 1, diğer durumlarda 0); number_type (group_key ile aynı); available (katalog tarafından kayıt için bildirilen integer türünde adet; bildirilmediğinde 0); sms_coverage (herhangi bir özellik SMS veya MMS içerdiğini belirtiyorsa 1); returns_numbers (belirli numaralar listelenebiliyorsa 1); next_function ('v3/getnumbers/{uuid}' değeri, returns_numbers değeri 1 olduğunda kullanılır; aksi halde 'v3/order/{uuid}'); prices; features (yetenekleri belirten dizelerin listesi); group_key; group_type_uuid. Her prices kaydı şu alanları içerir: price_id (iç yapısına anlam yüklenmemesi gereken plan tanımlayıcısı), is_customer_custom (hesabınıza özel fiyatlandırma uygulandığında true; yalnızca dahil edilmiş kanal içermeyen planlar için), per_minute ve free_minutes (ondalık sayı dizeleri), setup_price ve monthly_price (virgülden sonra iki basamak içeren dizeler) ve channels (dahil edilen kanalların integer türündeki sayısı). Hiçbir fiyat planı bulunmayan kayıtlar dahil edilmez. Her istekte, numara türü başına en fazla 1000 katalog kaydı değerlendirilir. Hiçbir türde kayıt yoksa response boş bir liste olur ve status.results değeri 0 olur. Canlı katalog sorgusu başarısız olursa yanıt bu zarfı kullanmayabilir veya bazı gruplar eksik olabilir.

Yanıt yapısını göstermek için verilen bir örnektir; canlı hesap verisi veya güncel bir fiyat teklifi değildir.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

Hatalar

• 500: msg 'ISO Code parameter is required': isocode eksik veya boş. Bu, düzeltilebilir bir istek hatasıdır. Buna karşılık gelen bir HTTP durumu ayarlanmaz.
• 404: msg 'Error: no such country': ülke bilinmiyor veya özel numara kataloğuyla bağlantılı değil. Buna karşılık gelen bir HTTP durumu ayarlanmaz.
• 401: Kimlik doğrulama eksik veya başarısız. HTTP 401 durumuyla gönderilir.

Kullanılabilirlik ve yan etkiler

• Sipariş vermez. Bu uç noktanın kodunda ücretlendirme adımı bulunmaz.
• Hesabınızın katalog ayrıntılarını ve fiyat tekliflerini yeniler; aynı planlar için önceki tekliflerin yerini alır. Sipariş uç noktalarının bu teklifleri nasıl kullandığı ayrı olarak belgelenmiştir.
• Fiyatlar hesabınıza özeldir ve özel fiyatlandırma içerebilir. Yanıtta para birimi belirtilmez.
• Canlı katalog sorguları gerçekleştirdiğinden diğer keşif çağrılarından daha yavaş olabilir. Sonuçlar çağrılar arasında değişebilir.