Разработчици

POST/v3/get_requirements

Прочетете изискванията за регистрация

Извлечете изискванията за регистрация, които се връщат в момента за дадена държава и наименование на тип номер.

На тази страница
  1. Изберете държавата и типа номер
  2. Прочетете върнатите инструкции
  3. Не тълкувайте грешка като освобождаване от регистрация
  4. Заявка
  5. Отговор
  6. Грешки
  7. Наличност и странични ефекти

Изберете държавата и типа номер

Изберете държава за регистрация, след което използвайте наименование, върнато от get_document_number_types. Изпратете това наименование като number_type, а не идентификатор на тип или обща категория за търсене на номера.

Прочетете върнатите инструкции

Запазете идентификаторите на изискванията и връзките за съответния работен процес за самоличност и документи. Това извикване връща изисквания; то не проверява валидността на файловете ви и не ги подава. Следвайте върнатите инструкции и всички изисквания, специфични за избрания номер.

Не тълкувайте грешка като освобождаване от регистрация

Грешката за невалидна държава или липса на документи за регистрация в държавата обединява две условия. Тя не доказва, че регистрацията не е необходима. Неуспешна справка или празен резултат също не означават одобрение на клиент или номер. Свържете се с поддръжката, ако резултатът е неясен.

Заявка

Използвайте данните за достъп на активирания си API акаунт през HTTPS. Поддържат се основно удостоверяване и активирани токени на приносител за API акаунта; прилагат се ограниченията на акаунта.

POST с application/json или application/x-www-form-urlencoded.

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"
Параметри в тялото на заявката
ИмеТипЗадължителноОписание
countryнизДаISO код на държавата от get_document_countries.
number_typeнизДаНаименование на тип от get_document_number_types, например Local; при съпоставяне не се различават главни и малки букви. Подайте наименованието, а не идентификатора му.

Отговор

Проверете status.code в JSON тялото, както и HTTP статуса. response е един ресурс с изисквания, съдържащ id, type и attributes, плюс relationships, когато се връщат. Идентификаторите в ресурса и данните за връзките са непрозрачни и от тях не трябва да се извежда значение. HTML таговете се премахват от незадължителния текст restriction_message; обработвайте останалото съдържание като текст, а не като доверен HTML. Обработчикът връща първия ресурс с изисквания, затова не заключавайте, че този отговор е изчерпателен списък. Наличието на атрибути и връзки зависи от държавата и типа; примерът не е пълна, фиксирана схема.

Примерна структура на отговора; не представлява действителни данни от акаунт или актуална ценова оферта.

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

Грешки

  • 400: Проверката на валидността на държавата и number_type е неуспешна: подайте и двете задължителни стойности. Текстът на проверката може да съдържа форматиране.
  • 400: Invalid country ISO or No country registration documents required.: това двусмислено съобщение само по себе си не доказва освобождаване от регистрация.
  • 400: Invalid number type: използвайте върнато наименование на тип. Старото съобщение за грешка изброява Global, Local, Mobile, National, Shared Cost и Toll Free.
  • 500: Unable to load registration requirements for the specified country and number type.: изискванията не са върнати успешно. Опитайте отново по-късно или се свържете с поддръжката.

Наличност и странични ефекти

  • Тази справка в каталога и изискванията не създава запис за самоличност, не качва доказателствен документ, не регистрира номер и не прави поръчка.
  • Успешният отговор от каталога не представлява одобрение на документите ви или потвърждение, че избран номер може да бъде активиран.