Dohvat vrsta posebnih brojeva i cijena za određenu državu

Lokalni brojevi pronalaze se pomoću getcountries i getareas. Za nacionalne brojeve, besplatne brojeve, brojeve s podijeljenim troškovima, globalne i mobilne brojeve pozovite other s ISO oznakom države.

• Grupe se prikazuju utvrđenim redoslijedom, a grupe bez stavki izostavljaju se.
• Svaka stavka navodi cjenovne planove za vaš račun u polju prices. Odaberite plan prema vrijednostima polja channels, monthly_price, setup_price, per_minute i free_minutes, a njegov price_id sačuvajte za naručivanje ako ga odgovarajuća krajnja točka zahtijeva.
• Ako needs_registration ima vrijednost koja se smatra istinitom, pročitajte restrictions prije naručivanja. Taj tekst smatrajte nepouzdanim sadržajem za prikaz.
• Slijedite next_function: v3/getnumbers/{uuid} omogućuje odabir određenog broja, a v3/order/{uuid} naručuje izravno iz stavke.
• Prazan popis response s kodom 200 znači da u trenutku zahtjeva nisu pronađene posebne vrste brojeva. Ako je katalog bio privremeno nedostupan, odgovor može biti nepotpun ili ne biti valjan JSON, pa pokušajte ponovno kasnije.
• Za države koje nisu u katalogu vraća se kod 404 bez odgovarajućeg HTTP statusa. Uvijek provjerite status.code.

Zahtjev

Obavezno: HTTP Basic ili token Bearer (pogledajte Autentifikacija i odgovori API-ja). Ako autentifikacija ne uspije, vraća se HTTP 401 prije pokretanja pretraživanja.

GET s parametrom isocode u putanji. Ako se taj segment putanje izostavi, umjesto njega čita se polje isocode kodirano u formatu obrasca.

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

Odgovor

Standardna omotnica odgovora. U slučaju uspjeha status.code ima vrijednost 200, status.msg je prazan, a status.results predstavlja broj grupa. response je popis grupa. Polja grupe: group_key (normalizirani ključ vrste: national, tollfree, sharedcost, global, mobile ili drugi alfanumerički ključ s malim slovima); group_name (naziv za prikaz); group_type_uuid (neprozirni identifikator vrste); items. Grupe su poredane ovim redoslijedom: national, tollfree, sharedcost, global, mobile, a zatim ostali ključevi prema polju group_name. Grupe bez stavki u polju items izostavljaju se, kao i lokalna vrsta. Za US grupa mobilnih brojeva izostavlja se osim ako je na vašem računu omogućena upotreba mobilnih brojeva za US. Stavke se razvrstavaju prema polju name (bez razlikovanja velikih i malih slova), a zatim prema polju prefix. Polja stavke: uuid (neprozirni identifikator stavke koji se upotrebljava u polju next_function); area_uuid (neprozirni identifikator grupe u katalogu); country_uuid (neprozirni identifikator države); prefix (puni predbroj koji počinje znakom '+' i pozivnim brojem države); name (naziv iz kataloga; navodnici mogu biti zapisani s prethodećom obrnutom kosom crtom); metered, overflow i needs_registration (zastavice koje mogu biti tipa boolean ili number; svaku vrijednost koja se smatra istinitom tumačite kao da); restrictions (prazno ako registracija nije potrebna, inače tekst uvjeta koji može sadržavati HTML prijelome redaka i poveznicu, okolne navodnike i znakove zapisane izlaznim sekvencama; smatrajte ga nepouzdanim tekstom za prikaz); state (za US, CA i PR oznaka savezne države ili prazan popis ako oznaka nije poznata; za ostale države ISO oznaka države); country_iso; is_mobile (1 u grupi mobilnih brojeva, inače 0); number_type (isto kao group_key); available (broj tipa integer koji katalog prijavljuje za stavku, 0 ako broj nije prijavljen); sms_coverage (1 ako se u bilo kojoj značajci spominje SMS ili MMS); returns_numbers (1 ako je moguće izlistati konkretne brojeve); next_function ('v3/getnumbers/{uuid}' ako returns_numbers ima vrijednost 1, inače 'v3/order/{uuid}'); prices; features (popis nizova znakova koji opisuju mogućnosti); group_key; group_type_uuid. Svaka stavka u polju prices ima price_id (neprozirni identifikator plana), is_customer_custom (true kada se primjenjuju prilagođene cijene za vaš račun; samo za planove bez uključenih kanala), per_minute i free_minutes (decimalni brojevi zapisani kao nizovi znakova), setup_price i monthly_price (nizovi znakova s dvije decimale) te channels (broj uključenih kanala tipa integer). Stavke bez ijednog cjenovnog plana izostavljaju se. Po zahtjevu se razmatra najviše 1000 stavki kataloga za svaku vrstu broja. Ako nijedna vrsta nema stavki, response je prazan popis, a status.results ima vrijednost 0. Ako pretraživanje kataloga uživo ne uspije, odgovor možda neće upotrebljavati ovu omotnicu ili će neke grupe nedostajati.

Ilustrativni oblik odgovora; ne predstavlja podatke računa uživo ni aktualnu cjenovnu ponudu.

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

Pogreške

• 500: msg 'ISO Code parameter is required': isocode nedostaje ili je prazan. To je pogreška u zahtjevu koja se može ispraviti. Ne postavlja se odgovarajući HTTP status.
• 404: msg 'Error: no such country': država je nepoznata ili nije povezana s katalogom posebnih brojeva. Ne postavlja se odgovarajući HTTP status.
• 401: Autentifikacija nedostaje ili nije uspjela. Šalje se s HTTP statusom 401.

Dostupnost i popratni učinci

• Ne izvršava narudžbu. U kodu ove krajnje točke nema koraka naplate.
• Osvježava pojedinosti kataloga i cjenovne ponude za vaš račun, zamjenjujući prethodne ponude za iste planove. Način na koji krajnje točke za naručivanje upotrebljavaju te ponude dokumentiran je zasebno.
• Cijene su specifične za vaš račun i mogu uključivati prilagođene cijene. U odgovoru nije navedena valuta.
• Pretražuje katalog uživo, pa može biti sporiji od drugih poziva za pronalaženje brojeva. Rezultati se mogu promijeniti između poziva.