Списък на специалните типове номера и цените за дадена държава

Местните номера се намират чрез 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.

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

• Не извършва поръчка. В кода на тази крайна точка няма стъпка за таксуване.
• Обновява подробностите от каталога и ценовите оферти за вашия акаунт, като заменя по-ранните оферти за същите планове. Начинът, по който крайните точки за поръчване използват тези оферти, е документиран отделно.
• Цените са специфични за вашия акаунт и може да включват индивидуално ценообразуване. В отговора не е посочена валута.
• Извършва справки в каталога в реално време, затова може да е по-бавна от други извиквания за откриване на номера. Резултатите могат да се променят между извикванията.