Прикажите префиксе за област

Пре него што почнете

Изаберите област помоћу 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 као тачан број расположивих бројева, нулу као општу забрану наручивања, нити успешну претрагу као резервацију. Доступност се може променити пре наручивања.