Gauti šalies specialiųjų numerių tipų ir kainų sąrašą

Vietiniai numeriai randami naudojant getcountries ir getareas. Nacionaliniams, nemokamiems, bendrų išlaidų, pasauliniams ir mobiliesiems numeriams iškvieskite other su šalies ISO kodu.

• Grupės pateikiamos nustatyta tvarka, o grupės be įrašų praleidžiamos.
• Kiekvieno įrašo jūsų paskyrai taikomi kainų planai pateikiami lauke prices. Pasirinkite planą pagal jo laukus channels, monthly_price, setup_price, per_minute ir free_minutes, ir išsaugokite jo price_id užsakymui, jei užsakymo galinis taškas jo reikalauja.
• Jei needs_registration reikšmė laikoma teisinga, perskaitykite restrictions prieš užsakydami. Šį tekstą laikykite nepatikimu rodomu turiniu.
• Vadovaukitės next_function: v3/getnumbers/{uuid} leidžia pasirinkti konkretų numerį, o v3/order/{uuid} pateikia užsakymą tiesiogiai pagal įrašą.
• Tuščias response sąrašas su kodu 200 reiškia, kad užklausos metu nerasta specialiųjų numerių tipų. Jei katalogas buvo laikinai nepasiekiamas, atsakymas gali būti neišsamus arba netinkamo JSON formato, todėl bandykite dar kartą vėliau.
• Šalims, kurių nėra kataloge, grąžinamas kodas 404 be atitinkamo HTTP būsenos kodo. Visada tikrinkite status.code.

Užklausa

Būtinas HTTP Basic autentifikavimas arba Bearer prieigos raktas (žr. „Autentifikavimas ir API atsakymai“). Jei autentifikavimas nepavyksta, prieš pradedant paiešką grąžinamas HTTP 401 atsakymas.

GET užklausa su isocode kelyje. Jei kelio segmentas praleistas, vietoj jo nuskaitomas formos koduote užkoduotas laukas isocode.

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

Atsakymas

Standartinė atsakymo struktūra. Sėkmės atveju status.code yra 200, status.msg yra tuščias, o status.results nurodo grupių skaičių. response yra grupių sąrašas. Grupės laukai: group_key (normalizuotas tipo raktas: national, tollfree, sharedcost, global, mobile arba kitas raktas iš mažųjų raidžių ir skaitmenų); group_name (rodomas pavadinimas); group_type_uuid (neinterpretuojamas tipo identifikatorius); items. Grupės rikiuojamos tokia tvarka: national, tollfree, sharedcost, global, mobile, tada kiti raktai pagal group_name. Grupės be items praleidžiamos, taip pat praleidžiamas vietinių numerių tipas. Šaliai US mobiliųjų numerių grupė praleidžiama, nebent jūsų paskyroje įjungta galimybė naudoti US mobiliuosius numerius. Įrašai rikiuojami pagal name (neskiriant didžiųjų ir mažųjų raidžių), tada pagal prefix. Įrašo laukai: uuid (neinterpretuojamas įrašo identifikatorius, naudojamas lauke next_function); area_uuid (neinterpretuojamas katalogo grupės identifikatorius); country_uuid (neinterpretuojamas šalies identifikatorius); prefix (visas prefiksas, prasidedantis „+“ ir šalies telefono kodu); name (pavadinimas kataloge; kabučių simboliai gali būti apsaugoti atgaliniu brūkšniu); metered, overflow ir needs_registration (požymiai, kurių tipas gali būti boolean arba number; bet kurią teisinga laikomą reikšmę vertinkite kaip „taip“); restrictions (tuščias, kai registracija nereikalinga, kitu atveju – reikalavimų tekstas, kuriame gali būti HTML eilučių lūžių ir nuoroda, tekstą gaubiančios kabutės ir apsaugoti simboliai; laikykite jį nepatikimu rodomu tekstu); state (šalims US, CA ir PR – valstijos kodas arba tuščias sąrašas, kai kodas nežinomas; kitoms šalims – šalies ISO kodas); country_iso; is_mobile (1 mobiliųjų numerių grupėje, kitu atveju 0); number_type (toks pat kaip group_key); available (katalogo pateiktas įrašo kiekis, kurio tipas integer, arba 0, kai kiekis nepateiktas); sms_coverage (1, jei bet kurioje funkcijos aprašo eilutėje minima SMS arba MMS); returns_numbers (1, kai galima gauti konkrečių numerių sąrašą); next_function ('v3/getnumbers/{uuid}', kai returns_numbers yra 1, kitu atveju 'v3/order/{uuid}'); prices; features (galimybes aprašančių eilučių sąrašas); group_key; group_type_uuid. Kiekviename prices įraše yra price_id (neinterpretuojamas plano identifikatorius), is_customer_custom (true, kai jūsų paskyrai taikoma individuali kainodara; tik planams be įtrauktų kanalų), per_minute ir free_minutes (dešimtainius skaičius vaizduojančios eilutės), setup_price ir monthly_price (eilutės su dviem skaitmenimis po kablelio) ir channels (įtrauktų kanalų skaičius, kurio tipas integer). Įrašai, neturintys nė vieno kainų plano, praleidžiami. Per vieną užklausą nagrinėjama ne daugiau kaip 1000 kiekvieno numerio tipo katalogo įrašų. Jei nė vienas tipas neturi įrašų, response yra tuščias sąrašas, o status.results yra 0. Jei tiesioginė paieška kataloge nepavyksta, atsakymas gali neatitikti šios struktūros arba jame gali trūkti grupių.

Pavyzdinė atsakymo struktūra; tai nėra dabartiniai paskyros duomenys ar šiuo metu galiojantis kainos pasiūlymas.

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

Klaidos

• 500: msg 'ISO Code parameter is required': isocode nepateiktas arba tuščias. Tai ištaisoma užklausos klaida. Atitinkamas HTTP būsenos kodas nenustatomas.
• 404: msg 'Error: no such country': šalis nežinoma arba nesusieta su specialiųjų numerių katalogu. Atitinkamas HTTP būsenos kodas nenustatomas.
• 401: autentifikavimo duomenys nepateikti arba autentifikavimas nepavyko. Siunčiama su HTTP būsenos kodu 401.

Prieinamumas ir šalutinis poveikis

• Užsakymas nepateikiamas. Šio galinio taško kode nėra mokesčio nuskaitymo veiksmo.
• Atnaujina jūsų paskyros katalogo duomenis ir kainų pasiūlymus, pakeisdamas ankstesnius tų pačių planų pasiūlymus. Kaip užsakymo galiniai taškai naudoja šiuos pasiūlymus, aprašyta atskirai.
• Kainos taikomos konkrečiai jūsų paskyrai ir gali apimti individualią kainodarą. Atsakyme valiuta nenurodoma.
• Atlieka tiesiogines paieškas kataloge, todėl gali veikti lėčiau nei kiti numerių paieškos iškvietimai. Skirtingų iškvietimų rezultatai gali keistis.