Lys spesiale nommertipes en pryse vir 'n land

Plaaslike nommers word gevind met getcountries en getareas. Vir nasionale, tolvrye, gedeeldekoste-, wêreldwye en selfoonnommers, roep other met die land se ISO-kode aan.

• Groepe verskyn in 'n vaste volgorde, en groepe sonder inskrywings word weggelaat.
• Elke inskrywing lys jou rekening se prysplanne in prices. Kies 'n plan volgens die waardes van channels, monthly_price, setup_price, per_minute en free_minutes, en bewaar die plan se price_id vir bestellings waar daardie eindpunt dit vereis.
• As needs_registration as waar evalueer, lees restrictions voordat jy bestel. Behandel daardie teks as onvertroude inhoud vir vertoon.
• Volg next_function: v3/getnumbers/{uuid} laat jou 'n spesifieke nommer kies, en v3/order/{uuid} plaas 'n bestelling direk vanaf die inskrywing.
• 'n Leë response-lys met kode 200 beteken dat geen spesiale nommertipes ten tyde van die versoek gevind is nie. As die katalogus tydelik onbereikbaar was, kan die antwoord onvolledig wees of ongeldige JSON bevat; probeer dus later weer.
• Lande buite die katalogus gee kode 404 terug sonder 'n ooreenstemmende HTTP-status. Kontroleer altyd status.code.

Versoek

Vereis: HTTP Basic of 'n Bearer-token (sien Stawing en API-antwoorde). Mislukte stawing word met HTTP 401 beantwoord voordat die opsoekaksie uitgevoer word.

GET met isocode in die pad. As die padsegment weggelaat word, word 'n vormgekodeerde isocode-veld in plaas daarvan gelees.

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

Antwoord

Standaard omhulsel. By sukses is status.code gelyk aan 200, status.msg is leeg, en status.results is die aantal groepe. response is 'n lys groepe. Groepvelde: group_key (genormaliseerde tipesleutel: national, tollfree, sharedcost, global, mobile, of 'n ander alfanumeriese sleutel in kleinletters); group_name (vertoonnaam); group_type_uuid (ondeursigtige tipe-identifiseerder); items. Groepe volg die volgorde national, tollfree, sharedcost, global, mobile, en daarna ander sleutels volgens group_name. Groepe sonder items word weggelaat, en die plaaslike tipe ook. Vir US word die selfoongroep weggelaat tensy jou rekening vir US-selfoonnommers geaktiveer is. Items word volgens name gesorteer (sonder om hoof- en kleinletters te onderskei), en dan volgens prefix. Itemvelde: uuid (ondeursigtige inskrywingidentifiseerder wat in next_function gebruik word); area_uuid (ondeursigtige identifiseerder van die katalogusgroep); country_uuid (ondeursigtige landidentifiseerder); prefix (volledige voorvoegsel wat met '+' en die land se skakelkode begin); name (katalogusnaam; aanhalingstekens kan met 'n terugskuinsstreep ontsnap wees); metered, overflow en needs_registration (vlae wat van tipe boolean of number kan wees; behandel enige waarde wat as waar evalueer as ja); restrictions (leeg wanneer geen registrasie nodig is nie, anders teks met vereistes wat HTML-reëlbreuke en 'n skakel, omsluitende aanhalingstekens en ontsnapte karakters kan bevat; behandel dit as onvertroude teks vir vertoon); state (vir US, CA en PR 'n deelstaatkode, of 'n leë lys wanneer geen kode bekend is nie; vir ander lande die land se ISO-kode); country_iso; is_mobile (1 in die selfoongroep, anders 0); number_type (dieselfde as group_key); available (integer-telling wat die katalogus vir die inskrywing rapporteer, 0 wanneer dit nie gerapporteer word nie); sms_coverage (1 as enige funksie SMS of MMS noem); returns_numbers (1 wanneer spesifieke nommers gelys kan word); next_function ('v3/getnumbers/{uuid}' wanneer returns_numbers gelyk aan 1 is, anders 'v3/order/{uuid}'); prices; features (lys stringe wat vermoëns beskryf); group_key; group_type_uuid. Elke prices-inskrywing het price_id (ondeursigtige planidentifiseerder), is_customer_custom (true wanneer pasgemaakte pryse vir jou rekening geld; slegs vir planne sonder ingeslote kanale), per_minute en free_minutes (desimale stringe), setup_price en monthly_price (stringe met twee desimale plekke), en channels (integer-aantal ingeslote kanale). Inskrywings sonder enige prysplan word weggelaat. Hoogstens 1000 katalogusinskrywings per nommertipe word per versoek oorweeg. As geen tipe inskrywings het nie, is response 'n leë lys met status.results gelyk aan 0. As die regstreekse katalogusopsoekaksie misluk, gebruik die antwoord moontlik nie hierdie omhulsel nie, of kan groepe ontbreek.

Voorbeeld van die antwoordstruktuur; nie regstreekse rekeningdata of 'n huidige kwotasie nie.

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

Foute

• 500: msg 'ISO Code parameter is required': isocode ontbreek of is leeg. Dit is 'n versoekfout wat reggestel kan word. Geen ooreenstemmende HTTP-status word gestel nie.
• 404: msg 'Error: no such country': die land is onbekend of nie aan die katalogus van spesiale nommers gekoppel nie. Geen ooreenstemmende HTTP-status word gestel nie.
• 401: Stawing ontbreek of het misluk. Word met HTTP-status 401 gestuur.

Beskikbaarheid en newe-effekte

• Plaas nie 'n bestelling nie. Geen stap wat koste hef, verskyn in hierdie eindpunt se kode nie.
• Verfris die katalogusbesonderhede en pryskwotasies vir jou rekening en vervang vroeëre kwotasies vir dieselfde planne. Hoe besteleindpunte hierdie kwotasies gebruik, word afsonderlik gedokumenteer.
• Pryse is spesifiek vir jou rekening en kan pasgemaakte pryse insluit. Die antwoord vermeld nie 'n geldeenheid nie.
• Voer regstreekse katalogusopsoekaksies uit en kan dus stadiger wees as ander oproepe om beskikbare nommers te vind. Resultate kan tussen oproepe verander.