Приказ посебних типова бројева и цена за земљу

Локални бројеви се проналазе помоћу getcountries и getareas. За националне бројеве, бесплатне бројеве, бројеве са подељеним трошковима, глобалне и мобилне бројеве позовите other са ISO кодом земље.

• Групе се приказују утврђеним редоследом, а групе без ставки се изостављају.
• Свака ставка наводи тарифне планове вашег налога у пољу prices. Изаберите план према вредностима поља channels, monthly_price, setup_price, per_minute и free_minutes, а сачувајте његов price_id за наручивање када га одговарајућа крајња тачка захтева.
• Ако needs_registration има вредност која се тумачи као тачно, прочитајте restrictions пре наручивања. Тај текст третирајте као непоуздан садржај за приказ.
• Пратите next_function: v3/getnumbers/{uuid} омогућава избор одређеног броја, а v3/order/{uuid} наручује директно на основу ставке.
• Празна response листа са кодом 200 значи да у тренутку захтева нису пронађени посебни типови бројева. Ако је каталог био привремено недоступан, одговор може бити непотпун или не бити исправан JSON, па покушајте поново касније.
• За земље које нису у каталогу враћа се код 404 без одговарајућег HTTP статуса. Увек проверите status.code.

Захтев

Обавезно: HTTP Basic или Bearer токен (погледајте Аутентификација и API одговори). На неуспелу аутентификацију одговара се статусом HTTP 401 пре извршавања претраге.

GET са параметром isocode у путањи. Ако је сегмент путање изостављен, уместо њега се чита поље isocode кодирано као податак обрасца.

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

Одговор

Стандардна структура одговора. У случају успеха, status.code је 200, status.msg је празно, а status.results је број група. response је листа група. Поља групе: group_key (нормализовани кључ типа: national, tollfree, sharedcost, global, mobile или други алфанумерички кључ са малим словима); group_name (назив за приказ); group_type_uuid (непрозирни идентификатор типа); items. Групе су поређане редоследом national, tollfree, sharedcost, global, mobile, а затим следе остали кључеви према пољу group_name. Групе без ставки у пољу items се изостављају, као и локални тип. За US се група мобилних бројева изоставља осим ако је вашем налогу омогућен приступ мобилним бројевима за US. Ставке се сортирају по пољу name (без разликовања великих и малих слова), а затим по пољу prefix. Поља ставке: uuid (непрозирни идентификатор ставке који се користи у пољу next_function); area_uuid (непрозирни идентификатор групе у каталогу); country_uuid (непрозирни идентификатор земље); prefix (цео префикс који почиње знаком '+' и позивним бројем земље); name (назив у каталогу; знакови навода могу бити екранирани обрнутом косом цртом); metered, overflow и needs_registration (ознаке које могу бити типа boolean или number; сваку вредност која се тумачи као тачно третирајте као да); restrictions (празно када регистрација није потребна, а иначе текст захтева који може да садржи HTML преломе редова и везу, наводнике на почетку и крају и екраниране знакове; третирајте га као непоуздан текст за приказ); state (за US, CA и PR код савезне државе, или празна листа када ниједан није познат; за остале земље ISO код земље); country_iso; is_mobile (1 у групи мобилних бројева, иначе 0); number_type (исто као group_key); available (број типа integer који каталог пријављује за ставку, 0 када није пријављен); sms_coverage (1 ако се у било којој могућности помиње SMS или MMS); returns_numbers (1 када се могу излистати одређени бројеви); next_function ('v3/getnumbers/{uuid}' када је returns_numbers једнако 1, иначе 'v3/order/{uuid}'); prices; features (листа текстуалних вредности које описују могућности); group_key; group_type_uuid. Свака ставка у пољу prices има price_id (непрозирни идентификатор плана), is_customer_custom (true када важе прилагођене цене за ваш налог; само за планове без укључених канала), per_minute и free_minutes (децималне вредности у облику ниски), setup_price и monthly_price (ниске са две децимале) и channels (број укључених канала типа integer). Ставке без иједног тарифног плана се изостављају. По захтеву се разматра највише 1000 ставки каталога за сваки тип броја. Ако ниједан тип нема ставке, response је празна листа, а status.results има вредност 0. Ако претрага каталога уживо не успе, одговор можда неће користити ову структуру или неке групе могу недостајати.

Илустративна структура одговора; не представља податке налога уживо нити актуелну понуду цена.

{
  "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"
        }
      ]
    }
  ]
}

Грешке

• 500: msg 'ISO Code parameter is required': isocode недостаје или је празан. Ово је грешка у захтеву која се може исправити. Не поставља се одговарајући HTTP статус.
• 404: msg 'Error: no such country': земља је непозната или није повезана са каталогом посебних бројева. Не поставља се одговарајући HTTP статус.
• 401: Аутентификација недостаје или није успела. Шаље се са HTTP статусом 401.

Доступност и споредни ефекти

• Не шаље наруџбину. У коду ове крајње тачке нема корака наплате.
• Освежава детаље каталога и понуде цена за ваш налог, замењујући раније понуде за исте планове. Начин на који крајње тачке за наручивање користе ове понуде описан је у засебној документацији.
• Цене су специфичне за ваш налог и могу укључивати прилагођене цене. У одговору се не наводи валута.
• Претражује каталог уживо, па може бити спорија од других позива за проналажење бројева. Резултати се могу мењати између позива.