Výpis typů speciálních čísel a cen pro danou zemi

Místní čísla vyhledáte pomocí getcountries a getareas. Pro národní čísla, bezplatná čísla, čísla se sdílenými náklady, globální a mobilní čísla volejte other s kódem ISO dané země.

• Skupiny se zobrazují v pevném pořadí a skupiny bez položek se vynechávají.
• Každá položka uvádí cenové tarify vašeho účtu v poli prices. Tarif vyberte podle hodnot polí channels, monthly_price, setup_price, per_minute a free_minutes a uchovejte si jeho price_id pro objednání, pokud jej příslušný koncový bod vyžaduje.
• Pokud se hodnota pole needs_registration vyhodnocuje jako pravdivá, přečtěte si obsah pole restrictions před objednáním. S tímto textem zacházejte jako s nedůvěryhodným obsahem určeným k zobrazení.
• Řiďte se polem next_function: v3/getnumbers/{uuid} umožňuje vybrat konkrétní číslo a v3/order/{uuid} provede objednávku přímo z dané položky.
• Prázdný seznam response s kódem 200 znamená, že v okamžiku požadavku nebyly nalezeny žádné typy speciálních čísel. Pokud byl katalog dočasně nedostupný, odpověď může být neúplná nebo nemusí být platným JSON, proto požadavek zopakujte později.
• Země mimo katalog vracejí kód 404 bez odpovídajícího stavového kódu HTTP. Vždy kontrolujte status.code.

Požadavek

Vyžadováno: ověřování HTTP Basic nebo token Bearer (viz Ověřování a odpovědi API). Při neúspěšném ověření se vrací HTTP 401 ještě před spuštěním vyhledávání.

GET s parametrem isocode v cestě. Pokud je tento segment cesty vynechán, načte se místo něj pole isocode z dat kódovaných jako formulář.

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

Odpověď

Standardní obálka odpovědi. Při úspěchu má status.code hodnotu 200, status.msg je prázdné a status.results udává počet skupin. response je seznam skupin. Pole skupiny: group_key (normalizovaný klíč typu: national, tollfree, sharedcost, global, mobile nebo jiný alfanumerický klíč s malými písmeny); group_name (zobrazovaný název); group_type_uuid (neprůhledný identifikátor typu); items. Skupiny jsou řazeny v pořadí national, tollfree, sharedcost, global, mobile, poté následují ostatní klíče seřazené podle group_name. Skupiny bez položek v items se vynechávají, stejně jako typ místních čísel. Pro US se skupina mobilních čísel vynechává, pokud váš účet nemá povolena mobilní čísla pro US. Položky se řadí podle name (bez rozlišení velkých a malých písmen) a poté podle prefix. Pole položky: uuid (neprůhledný identifikátor položky používaný v next_function); area_uuid (neprůhledný identifikátor skupiny v katalogu); country_uuid (neprůhledný identifikátor země); prefix (úplná předvolba začínající znakem '+' a mezinárodní telefonní předvolbou země); name (název v katalogu; uvozovky mohou být escapovány zpětným lomítkem); metered, overflow a needs_registration (příznaky, které mohou být typu boolean nebo number; každou hodnotu vyhodnocovanou jako pravdivou považujte za ano); restrictions (prázdné, pokud registrace není nutná, jinak text požadavků, který může obsahovat zalomení řádků v HTML a odkaz, ohraničující uvozovky a escapované znaky; zacházejte s ním jako s nedůvěryhodným textem určeným k zobrazení); state (pro US, CA a PR kód státu nebo prázdný seznam, pokud není znám; pro ostatní země kód ISO země); country_iso; is_mobile (1 ve skupině mobilních čísel, jinak 0); number_type (stejné jako group_key); available (počet typu integer, který katalog uvádí pro danou položku, 0, pokud jej neuvádí); sms_coverage (1, pokud některá funkce zmiňuje SMS nebo MMS); returns_numbers (1, pokud lze vypsat konkrétní čísla); next_function ('v3/getnumbers/{uuid}', pokud má returns_numbers hodnotu 1, jinak 'v3/order/{uuid}'); prices; features (seznam řetězců popisujících podporované funkce); group_key; group_type_uuid. Každá položka v prices obsahuje price_id (neprůhledný identifikátor tarifu), is_customer_custom (true, pokud se uplatňuje individuální cena pro váš účet; pouze u tarifů bez zahrnutých kanálů), per_minute a free_minutes (řetězce s desetinnými čísly), setup_price a monthly_price (řetězce se dvěma desetinnými místy) a channels (počet zahrnutých kanálů typu integer). Položky bez jakéhokoli cenového tarifu se vynechávají. Při jednom požadavku se pro každý typ čísla zohlední nejvýše 1000 položek katalogu. Pokud žádný typ nemá položky, response je prázdný seznam a status.results má hodnotu 0. Pokud vyhledávání v živém katalogu selže, odpověď nemusí používat tuto obálku nebo mohou chybět některé skupiny.

Ukázka struktury odpovědi; nejde o živá data účtu ani o aktuální cenovou nabídku.

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

Chyby

• 500: msg 'ISO Code parameter is required': isocode chybí nebo je prázdný. Jde o opravitelnou chybu požadavku. Odpovídající stavový kód HTTP se nenastavuje.
• 404: msg 'Error: no such country': země je neznámá nebo není propojena s katalogem speciálních čísel. Odpovídající stavový kód HTTP se nenastavuje.
• 401: Ověření chybí nebo selhalo. Odesílá se se stavovým kódem HTTP 401.

Dostupnost a vedlejší účinky

• Nevytváří objednávku. Kód tohoto koncového bodu neobsahuje žádný krok účtování poplatků.
• Aktualizuje podrobnosti katalogu a cenové nabídky pro váš účet a nahrazuje dřívější nabídky pro stejné tarify. Způsob, jakým koncové body pro objednávání tyto nabídky používají, je popsán samostatně.
• Ceny jsou specifické pro váš účet a mohou zahrnovat individuální ceny. Odpověď neuvádí měnu.
• Provádí vyhledávání v živém katalogu, a proto může být pomalejší než ostatní volání pro zjišťování dostupné nabídky. Výsledky se mohou mezi jednotlivými voláními měnit.