Riigi erinumbrite tüüpide ja hindade loend

Kohalikke numbreid saab leida funktsioonidega getcountries ja getareas. Riigisiseste, tasuta, jagatud kuludega, ülemaailmsete ja mobiilinumbrite jaoks kutsuge välja other, kasutades riigi ISO-koodi.

• Rühmad kuvatakse kindlas järjekorras ning kirjeteta rühmad jäetakse välja.
• Iga kirje loetleb teie konto hinnapaketid väljal prices. Valige pakett järgmiste väljade alusel: channels, monthly_price, setup_price, per_minute ja free_minutes; säilitage selle price_id tellimiseks, kui vastav otspunkt seda küsib.
• Kui needs_registration on tõeväärtusena tõene, lugege välja restrictions enne tellimist. Käsitlege seda teksti ebausaldusväärse kuvatava sisuna.
• Järgige välja next_function: v3/getnumbers/{uuid} võimaldab valida konkreetse numbri ning v3/order/{uuid} esitab tellimuse otse selle kirje põhjal.
• Tühi response loend koodiga 200 tähendab, et päringu tegemise ajal ei leitud ühtegi erinumbrite tüüpi. Kui kataloog oli ajutiselt kättesaamatu, võib vastus olla mittetäielik või vigases JSON-vormingus, seega proovige hiljem uuesti.
• Kataloogi mittekuuluvate riikide puhul tagastatakse kood 404 ilma vastava HTTP-olekukoodita. Kontrollige alati välja status.code.

Päring

Nõutav on HTTP Basic autentimine või Bearer tõend (vt Autentimine ja API vastused). Autentimise nurjumisel vastatakse enne otsingu käivitamist HTTP-olekukoodiga 401.

GET, mille teekonnas on isocode. Kui see teekonnaosa puudub, loetakse selle asemel vormikodeeritud väli isocode.

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

Vastus

Standardne vastuse ümbris. Õnnestumise korral on status.code väärtus 200, status.msg on tühi ja status.results näitab rühmade arvu. response on rühmade loend. Rühma väljad: group_key (normaliseeritud tüübivõti: national, tollfree, sharedcost, global, mobile või muu väiketähtedest ja numbritest koosnev võti); group_name (kuvatav nimi); group_type_uuid (tüübi identifikaator, mille sisemist struktuuri ei tõlgendata); items. Rühmade järjekord on national, tollfree, sharedcost, global, mobile ning seejärel muud võtmed välja group_name järgi. Rühmad, millel puuduvad items kirjed, jäetakse välja, samuti kohalike numbrite tüüp. Riigi US puhul jäetakse mobiilinumbrite rühm välja, välja arvatud juhul, kui teie kontol on lubatud riigi US mobiilinumbrid. Kirjed sorditakse välja name järgi (suur- ja väiketähti eristamata), seejärel välja prefix järgi. Kirje väljad: uuid (kirje identifikaator, mille sisemist struktuuri ei tõlgendata ja mida kasutatakse väljal next_function); area_uuid (kataloogirühma identifikaator, mille sisemist struktuuri ei tõlgendata); country_uuid (riigi identifikaator, mille sisemist struktuuri ei tõlgendata); prefix (täielik prefiks, mis algab märgiga '+' ja riigi suunakoodiga); name (nimi kataloogis; jutumärgid võivad olla paomärgitud längkriipsuga); metered, overflow ja needs_registration (lipud, mille tüüp võib olla boolean või number; käsitlege iga tõeväärtusena tõest väärtust jaatavana); restrictions (tühi, kui registreerimine pole vajalik; muul juhul nõuete tekst, mis võib sisaldada HTML-reavahetusi ja linki, ümbritsevaid jutumärke ning paomärgitud märke; käsitlege seda ebausaldusväärse kuvatava tekstina); state (riikide US, CA ja PR puhul osariigi kood või tühi loend, kui koodi pole teada; teiste riikide puhul riigi ISO-kood); country_iso; is_mobile (mobiilinumbrite rühmas 1, muul juhul 0); number_type (sama mis group_key); available (kataloogi teatatud arv selle kirje kohta tüübiga integer, teatamata jätmise korral 0); sms_coverage (1, kui mõni võimalus mainib SMS-i või MMS-i); returns_numbers (1, kui konkreetseid numbreid saab loetleda); next_function ('v3/getnumbers/{uuid}', kui returns_numbers väärtus on 1, muul juhul 'v3/order/{uuid}'); prices; features (võimalusi kirjeldavate stringide loend); group_key; group_type_uuid. Iga prices kirje sisaldab välju price_id (paketi identifikaator, mille sisemist struktuuri ei tõlgendata), is_customer_custom (true, kui teie kontole rakendub kohandatud hinnastus; ainult pakettide puhul, milles pole kanaleid hinna sees), per_minute ja free_minutes (kümnendarve esitavad stringid), setup_price ja monthly_price (kahe komakohaga stringid) ning channels (hinna sees olevate kanalite arv tüübiga integer). Kirjed, millel pole ühtegi hinnapaketti, jäetakse välja. Ühe päringu puhul võetakse iga numbritüübi kohta arvesse kuni 1000 kataloogikirjet. Kui ühelgi tüübil pole kirjeid, on response tühi loend ning status.results väärtus on 0. Kui kataloogist reaalajas otsimine nurjub, ei pruugi vastus seda ümbrist kasutada või võivad mõned rühmad puududa.

Vastuse struktuuri näide; see ei ole konto reaalajas andmestik ega kehtiv hinnapakkumine.

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

Vead

• 500: msg 'ISO Code parameter is required': isocode puudub või on tühi. See on parandatav päringuviga. Vastavat HTTP-olekukoodi ei määrata.
• 404: msg 'Error: no such country': riik on tundmatu või pole erinumbrite kataloogiga seotud. Vastavat HTTP-olekukoodi ei määrata.
• 401: autentimine puudub või nurjus. Saadetakse HTTP-olekukoodiga 401.

Saadavus ja kõrvalmõjud

• Ei esita tellimust. Selle otspunkti koodis pole tasu võtmise sammu.
• Värskendab teie konto kataloogiandmeid ja hinnapakkumisi, asendades samade pakettide varasemad hinnapakkumised. Seda, kuidas tellimise otspunktid neid hinnapakkumisi kasutavad, kirjeldatakse eraldi dokumentatsioonis.
• Hinnad on teie kontopõhised ja võivad sisaldada kohandatud hinnastust. Vastuses pole valuutat märgitud.
• Teeb kataloogipäringuid reaalajas, mistõttu võib see olla aeglasem kui muud numbrite leidmiseks tehtavad päringud. Tulemused võivad päringute vahel muutuda.