Списък с префикси за област на покритие

Преди да започнете

Изберете област на покритие чрез getareas. Копирайте идентификатора на областта от отговора или от върнатото поле next_function. За област на покритие в САЩ или Канада използвайте getstates , ако искате да ограничите резултатите до един щат или една провинция.

Разчитане на резултата

Проверете status.code в тялото на JSON отговора, както и HTTP статуса. Успешните резултати се намират в масива response. По подразбиране отговорът е сортиран по име. available е приблизителна оценка, а флаговете в каталога не заменят проверката на действителните възможности на избрания номер и изискванията за регистрация.

Избор на следващата стъпка

Използвайте негрупиран резултат. Когато returns_numbers е 1, върнатото поле next_function сочи към търсене на номера. Когато стойността е 0, номерата се предоставят при поръчка и пътят сочи към операция за поръчване. Прегледайте операцията и изискванията ѝ, преди да изпратите заявката: заявка за поръчка може да доведе до начисляване на сума по сметката ви. Не изпращайте автоматично заявки към всеки върнат път.

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

Разширени опции за показване

compact=1 връща извадка от най-много 100 реда в разбъркан ред, а не страница от по-голям набор от резултати. Групирането създава обобщени редове и синтетични идентификатори; използвайте обикновен негрупиран отговор, за да изберете отделен префикс. Не използвайте извадки или групирани резултати като основание за твърдения за изчерпателна наличност или точни възможности.

Заявка

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

Използвайте GET и изпращайте незадължителните параметри в низа на заявката. Не разчитайте на резервно приемане на параметри от тялото на формуляр.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

Отговор

Стандартната JSON обвивка с status/response. status.results отчита броя на върнатите редове, включително при извадка или групиране. response съдържа обекти за префикси. Не се връщат полета за цени. В обикновения негрупиран отговор uuid е идентификаторът на префикса; area_uuid и country_uuid са върнати идентификатори; prefix и name са информация за показване; available е приблизителна оценка на наличността, а не резервация; needs_registration и restrictions описват информацията за регистрация; sms_coverage, is_mobile и number_type са ориентировъчни данни от каталога, а не гаранция за конкретна възможност на даден номер. number_type може да е празно или да съдържа друг низ от каталога, затова не изисквайте фиксирано изброяване на допустими стойности. state е низ и може да е празно или да съдържа форматиране от каталога. latitude и longitude може да са празни. metered и overflow са флагове от каталога, а не парични суми. returns_numbers избира маршрут за списък с номера (1) или маршрут за предоставяне на номер при поръчка (0). next_function указва този следващ маршрут. Групираните отговори съдържат и обединени характеристики, включително резервни стойности за характеристики; не ги тълкувайте като проверени възможности на всеки номер.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

Грешки

• 404: Invalid area ID: получете актуален идентификатор на област на покритие чрез справка в каталога.
• 404: State filter is only available for US and CA: пропуснете state за други държави.
• 404: Invalid state: използвайте щат или провинция, върнати от getstates за тази държава.
• 404: No prefixes found: не са върнати съответстващи редове от каталога. Това не доказва, че даден номер никога не може да бъде поръчан.
• 500: Грешка: 'Failed loading prefixes': справката в каталога е неуспешна. Опитайте отново по-късно и се свържете с поддръжката, ако проблемът продължава.

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

• Това е стъпка за справка в каталога, а не потвърждение на поръчка. Наличността може да се актуализира чрез допълнителни справки в каталога, затова времето за отговор може да варира.
• Цени не се връщат. Получете съответната ценова оферта за номера или поръчката и прегледайте изискванията за регистрация, преди да направите поръчка.
• Не приемайте available за точен брой налични номера, нулата за всеобща забрана за поръчване или успешната справка за резервация. Наличността може да се промени преди поръчването.