Listează tipurile de numere speciale și prețurile pentru o țară

Numerele locale sunt găsite folosind getcountries și getareas. Pentru numere naționale, gratuite, cu cost partajat, globale și mobile, apelați other cu codul ISO al țării.

• Grupurile apar într-o ordine fixă, iar grupurile fără intrări sunt omise.
• Fiecare intrare listează planurile tarifare ale contului dumneavoastră în prices. Alegeți un plan pe baza valorilor sale channels, monthly_price, setup_price, per_minute și free_minutes, și păstrați valoarea sa price_id pentru plasarea comenzii, atunci când acel endpoint o solicită.
• Dacă needs_registration are o valoare evaluată ca adevărată, citiți restrictions înainte de a plasa comanda. Tratați acel text drept conținut de afișat care nu este de încredere.
• Urmați next_function: v3/getnumbers/{uuid} vă permite să alegeți un anumit număr, iar v3/order/{uuid} plasează comanda direct din intrare.
• O listă goală response cu codul 200 înseamnă că nu au fost găsite tipuri de numere speciale la momentul cererii. Dacă accesul la catalog a fost temporar indisponibil, răspunsul poate fi incomplet sau poate să nu fie JSON valid, așa că încercați din nou mai târziu.
• Țările care nu sunt în catalog returnează codul 404 fără un cod de stare HTTP corespunzător. Verificați întotdeauna status.code.

Cerere

Obligatoriu: autentificare HTTP Basic sau token Bearer (consultați Autentificare și răspunsuri API). În cazul unei autentificări eșuate, se răspunde cu HTTP 401 înainte de efectuarea căutării.

GET cu isocode în cale. Dacă segmentul din cale este omis, se citește în schimb un câmp isocode codificat ca formular.

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

Răspuns

Structură standard a răspunsului. În caz de succes, status.code este 200, status.msg este gol, iar status.results reprezintă numărul de grupuri. response este o listă de grupuri. Câmpurile grupului: group_key (cheie normalizată a tipului: national, tollfree, sharedcost, global, mobile sau altă cheie alfanumerică cu litere mici); group_name (nume afișat); group_type_uuid (identificator opac al tipului); items. Grupurile sunt ordonate astfel: national, tollfree, sharedcost, global, mobile, apoi celelalte chei după group_name. Grupurile fără items sunt omise, la fel și tipul local. Pentru US, grupul de numere mobile este omis, cu excepția cazului în care contul dumneavoastră este activat pentru numere mobile din US. Elementele sunt sortate după name (fără distincție între litere mari și mici), apoi după prefix. Câmpurile elementului: uuid (identificator opac al intrării, folosit în next_function); area_uuid (identificator opac al grupului din catalog); country_uuid (identificator opac al țării); prefix (prefix complet care începe cu '+' și codul de apel al țării); name (nume din catalog; ghilimelele pot apărea cu o bară oblică inversă de escapare); metered, overflow și needs_registration (indicatori care pot fi de tip boolean sau number; tratați orice valoare evaluată ca adevărată drept da); restrictions (gol când nu este necesară înregistrarea, altfel un text cu cerințe care poate include întreruperi de linie HTML și un link, ghilimele la început și la sfârșit și caractere escapate; tratați-l drept text de afișat care nu este de încredere); state (pentru US, CA și PR, un cod de stat sau o listă goală când nu se cunoaște niciunul; pentru celelalte țări, codul ISO al țării); country_iso; is_mobile (1 în grupul de numere mobile, altfel 0); number_type (la fel ca group_key); available (număr de tip integer raportat de catalog pentru intrare, 0 când nu este raportat); sms_coverage (1 dacă vreo funcționalitate menționează SMS sau MMS); returns_numbers (1 când pot fi listate numere concrete); next_function ('v3/getnumbers/{uuid}' când returns_numbers este 1, altfel 'v3/order/{uuid}'); prices; features (listă de șiruri de caractere care descriu funcționalitățile); group_key; group_type_uuid. Fiecare intrare din prices conține price_id (identificator opac al planului), is_customer_custom (true când se aplică tarife personalizate pentru contul dumneavoastră; numai pentru planurile fără canale incluse), per_minute și free_minutes (șiruri de caractere care reprezintă numere zecimale), setup_price și monthly_price (șiruri de caractere cu două zecimale) și channels (numărul de canale incluse, de tip integer). Intrările fără niciun plan tarifar sunt omise. Pentru fiecare cerere sunt luate în considerare cel mult 1000 de intrări din catalog pentru fiecare tip de număr. Dacă niciun tip nu are intrări, response este o listă goală, cu status.results 0. Dacă o căutare în timp real în catalog eșuează, răspunsul poate să nu folosească această structură sau pot lipsi grupuri.

Structură de răspuns cu rol ilustrativ; nu reprezintă date în timp real ale contului sau o ofertă de preț actuală.

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

Erori

• 500: msg 'ISO Code parameter is required': isocode lipsește sau este gol. Aceasta este o eroare a cererii care poate fi corectată. Nu este setat un cod de stare HTTP corespunzător.
• 404: msg 'Error: no such country': țara este necunoscută sau nu este asociată catalogului de numere speciale. Nu este setat un cod de stare HTTP corespunzător.
• 401: Autentificarea lipsește sau a eșuat. Trimis cu codul de stare HTTP 401.

Disponibilitate și efecte secundare

• Nu plasează o comandă. În codul acestui endpoint nu apare nicio etapă de taxare.
• Actualizează detaliile catalogului și ofertele de preț pentru contul dumneavoastră, înlocuind ofertele anterioare pentru aceleași planuri. Modul în care endpointurile de comandă folosesc aceste oferte este documentat separat.
• Prețurile sunt specifice contului dumneavoastră și pot include tarife personalizate. Răspunsul nu precizează o monedă.
• Efectuează căutări în timp real în catalog, deci poate fi mai lent decât alte apeluri de descoperire. Rezultatele se pot schimba de la un apel la altul.