Geliştiriciler

POST/v3/get_requirements

Kayıt gerekliliklerini sorgulama

Bir ülke ve numara türü adı için şu anda döndürülen kayıt gerekliliklerini alın.

Bu sayfada
  1. Ülkeyi ve numara türünü seçin
  2. Döndürülen talimatları okuyun
  3. Bir hatayı muafiyet olarak yorumlamayın
  4. İstek
  5. Yanıt
  6. Hatalar
  7. Kullanılabilirlik ve yan etkiler

Ülkeyi ve numara türünü seçin

Kayıt yapılacak ülkeyi seçin, ardından şu çağrının döndürdüğü adlardan birini kullanın: get_document_number_types. Bu adı şu parametrenin değeri olarak gönderin: number_type; tür kimliği veya genel bir numara arama kategorisi göndermeyin.

Döndürülen talimatları okuyun

İlgili kimlik/belge iş akışında kullanmak üzere gereklilik ve ilişki kimliklerini saklayın. Bu çağrı gereklilikleri döndürür; dosyalarınızı doğrulamaz veya başvuru olarak göndermez. Döndürülen talimatlara ve seçilen numaraya özgü tüm gerekliliklere uyun.

Bir hatayı muafiyet olarak yorumlamayın

Ülkenin geçersiz olduğunu veya ülke için kayıt belgesi gerekmediğini belirten hata, iki koşulu bir araya getirir. Bu, kayıt gerekmediğinin kanıtı değildir. Sorgunun başarısız olması veya boş sonuç dönmesi de bir müşterinin ya da numaranın onaylandığı anlamına gelmez. Sonuç net değilse destek ekibiyle iletişime geçin.

İstek

Etkin API hesabınızın kimlik bilgilerini HTTPS üzerinden kullanın. Basic kimlik doğrulaması ve etkin API hesaplarına ait bearer belirteçleri desteklenir; hesap kısıtlamaları geçerlidir.

POST isteğini application/json veya application/x-www-form-urlencoded içerik türüyle gönderin.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"
İstek gövdesi parametreleri
AdTürZorunluAçıklama
countrykarakter dizisiEvetget_document_countries tarafından döndürülen ISO ülke kodu.
number_typekarakter dizisiEvetget_document_number_types tarafından döndürülen tür adı; örneğin Local. Eşleştirmede büyük/küçük harf ayrımı yapılmaz. Kimliğini değil, adını belirtin.

Yanıt

HTTP durumunun yanı sıra JSON gövdesindeki status.code değerini de kontrol edin. response, id, type ve attributes alanlarını, ayrıca döndürüldüğünde relationships alanını içeren tek bir gereklilik kaynağıdır. Kaynak ve ilişki verilerindeki kimliklerin içeriğinden anlam çıkarılamaz. İsteğe bağlı restriction_message metninden HTML etiketleri kaldırılır; kalan içeriği güvenilir HTML olarak değil, metin olarak işleyin. İşleyici ilk gereklilik kaynağını döndürür; bu nedenle yanıtın eksiksiz bir liste olduğunu varsaymayın. Özniteliklerin ve ilişkilerin bulunup bulunmaması ülkeye ve türe bağlıdır; örnek, eksiksiz ve sabit bir şema değildir.

Yanıt yapısını gösteren örnektir; canlı hesap verisi veya güncel fiyat teklifi değildir.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Hatalar

  • 400: Ülke ve number_type doğrulaması başarısız oldu: zorunlu değerlerin ikisini de belirtin. Doğrulama metni biçimlendirme içerebilir.
  • 400: Invalid country ISO or No country registration documents required.: bu belirsiz mesaj tek başına kayıt muafiyetini kanıtlamaz.
  • 400: Invalid number type: döndürülen tür adlarından birini kullanın. Eski hata mesajında Global, Local, Mobile, National, Shared Cost ve Toll Free listelenir.
  • 500: Unable to load registration requirements for the specified country and number type.: gereklilikler başarıyla döndürülemedi. Daha sonra yeniden deneyin veya destek ekibiyle iletişime geçin.

Kullanılabilirlik ve yan etkiler

  • Bu katalog/gereklilik sorgusu kimlik kaydı oluşturmaz, kanıtlayıcı belge yüklemez, numara kaydı yapmaz veya sipariş vermez.
  • Başarılı bir katalog yanıtı, belgelerinizin onaylandığı veya seçilen bir numaranın etkinleştirilebileceğinin doğrulandığı anlamına gelmez.