Listoni llojet e numrave të veçantë dhe çmimet për një shtet

Numrat lokalë gjenden me getcountries dhe getareas. Për numra kombëtarë, pa pagesë për telefonuesin, me kosto të ndarë, globalë dhe celularë, thirrni other me kodin ISO të shtetit.

• Grupet shfaqen në një rend të pandryshueshëm dhe grupet pa zëra nuk përfshihen.
• Çdo zë liston planet e çmimeve të llogarisë suaj te prices. Zgjidhni një plan sipas vlerave të tij për channels, monthly_price, setup_price, per_minute dhe free_minutes, dhe ruani vlerën e tij për price_id për porositjen kur pika përkatëse fundore e kërkon atë.
• Nëse needs_registration ka një vlerë që vlerësohet si e vërtetë, lexoni restrictions përpara se të porositni. Trajtojeni atë tekst si përmbajtje të pabesuar për shfaqje.
• Ndiqni next_function: v3/getnumbers/{uuid} ju lejon të zgjidhni një numër të caktuar, ndërsa v3/order/{uuid} porosit drejtpërdrejt nga zëri.
• Një listë e zbrazët response me kodin 200 do të thotë se në momentin e kërkesës nuk u gjet asnjë lloj numri të veçantë. Nëse katalogu ishte përkohësisht i paarritshëm, përgjigjja mund të jetë e paplotë ose të mos jetë JSON i vlefshëm, ndaj provoni përsëri më vonë.
• Shtetet jashtë katalogut kthejnë kodin 404 pa një status HTTP përkatës. Kontrolloni gjithmonë status.code.

Kërkesa

Kërkohet: HTTP Basic ose token Bearer (shihni Autentikimi dhe përgjigjet e API-së). Autentikimi i dështuar merr përgjigjen HTTP 401 përpara se të kryhet kërkimi.

GET me isocode në shteg. Nëse segmenti i shtegut nuk jepet, në vend të tij lexohet një fushë isocode e koduar si formular.

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

Përgjigjja

Strukturë mbështjellëse standarde. Në rast suksesi, status.code është 200, status.msg është bosh dhe status.results është numri i grupeve. response është një listë grupesh. Fushat e grupit: group_key (çelësi i normalizuar i llojit: national, tollfree, sharedcost, global, mobile ose një çelës tjetër alfanumerik me shkronja të vogla); group_name (emri i shfaqur); group_type_uuid (identifikues opak i llojit); items. Grupet renditen si national, tollfree, sharedcost, global, mobile, pastaj çelësat e tjerë sipas group_name. Grupet pa items nuk përfshihen, ashtu si edhe lloji lokal. Për US, grupi i numrave celularë nuk përfshihet, përveçse kur llogaria juaj është aktivizuar për numra celularë të US. Zërat renditen sipas name (pa dallim mes shkronjave të mëdha dhe të vogla), pastaj sipas prefix. Fushat e zërit: uuid (identifikues opak i zërit që përdoret te next_function); area_uuid (identifikues opak i grupit të katalogut); country_uuid (identifikues opak i shtetit); prefix (prefiksi i plotë që fillon me '+' dhe kodin telefonik të shtetit); name (emri në katalog; thonjëzat mund të shfaqen me një vijë të pjerrët të kundërt përpara si karakter mbrojtës); metered, overflow dhe needs_registration (tregues që mund të jenë boolean ose number; trajtojeni çdo vlerë që vlerësohet si e vërtetë si po); restrictions (bosh kur nuk nevojitet regjistrim, përndryshe tekst me kërkesat që mund të përfshijë ndërprerje rreshtash HTML dhe një lidhje, thonjëza rrethuese dhe karaktere të mbrojtura; trajtojeni si tekst të pabesuar për shfaqje); state (për US, CA dhe PR, një kod shteti ose një listë e zbrazët kur nuk njihet asnjë i tillë; për vendet e tjera, kodi ISO i vendit); country_iso; is_mobile (1 në grupin e numrave celularë, përndryshe 0); number_type (i njëjtë me group_key); available (sasia e raportuar nga katalogu për zërin, e tipit integer, 0 kur nuk raportohet); sms_coverage (1 nëse ndonjë veçori përmend SMS ose MMS); returns_numbers (1 kur mund të listohen numra të caktuar); next_function ('v3/getnumbers/{uuid}' kur returns_numbers është 1, përndryshe 'v3/order/{uuid}'); prices; features (listë vargjesh teksti që përshkruajnë aftësitë); group_key; group_type_uuid. Çdo zë te prices ka price_id (identifikues opak i planit), is_customer_custom (true kur zbatohen çmime të personalizuara për llogarinë tuaj; vetëm për planet pa kanale të përfshira), per_minute dhe free_minutes (vargje teksti me vlera dhjetore), setup_price dhe monthly_price (vargje teksti me dy shifra pas presjes dhjetore), si dhe channels (numri i kanaleve të përfshira, i tipit integer). Zërat pa asnjë plan çmimesh nuk përfshihen. Për çdo kërkesë merren parasysh më së shumti 1000 zëra të katalogut për çdo lloj numri. Nëse asnjë lloj nuk ka zëra, response është një listë e zbrazët me status.results 0. Nëse kërkimi i drejtpërdrejtë në katalog dështon, përgjigjja mund të mos përdorë këtë strukturë mbështjellëse ose mund të mungojnë grupe.

Strukturë ilustruese e përgjigjes; nuk përmban të dhëna të drejtpërdrejta të llogarisë dhe nuk është ofertë aktuale çmimi.

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

Gabimet

• 500: msg 'ISO Code parameter is required': isocode mungon ose është bosh. Ky është një gabim i korrigjueshëm i kërkesës. Nuk caktohet asnjë status HTTP përkatës.
• 404: msg 'Error: no such country': shteti është i panjohur ose nuk është i lidhur me katalogun e numrave të veçantë. Nuk caktohet asnjë status HTTP përkatës.
• 401: Autentikimi mungon ose ka dështuar. Dërgohet me statusin HTTP 401.

Disponueshmëria dhe efektet anësore

• Nuk kryen porosi. Në kodin e kësaj pike fundore nuk shfaqet asnjë hap tarifimi.
• Rifreskon hollësitë e katalogut dhe ofertat e çmimeve për llogarinë tuaj, duke zëvendësuar ofertat e mëparshme për të njëjtat plane. Mënyra se si pikat fundore të porositjes i përdorin këto oferta dokumentohet veçmas.
• Çmimet janë specifike për llogarinë tuaj dhe mund të përfshijnë çmime të personalizuara. Përgjigjja nuk përcakton monedhën.
• Kryen kërkime të drejtpërdrejta në katalog, ndaj mund të jetë më i ngadaltë se thirrjet e tjera për zbulimin e numrave. Rezultatet mund të ndryshojnë nga një thirrje në tjetrën.