Listaa maan erikoisnumerotyypit ja hinnat

Paikallisia numeroita haetaan kutsuilla getcountries ja getareas. Hae valtakunnallisia numeroita, ilmaisnumeroita, jaetun maksun numeroita, maailmanlaajuisia numeroita ja matkapuhelinnumeroita kutsumalla other maan ISO-koodilla.

• Ryhmät esitetään kiinteässä järjestyksessä, ja ryhmät, joissa ei ole tietueita, jätetään pois.
• Kunkin tietueen tilikohtaiset hinnastot luetellaan kentässä prices. Valitse hinnasto kenttien channels, monthly_price, setup_price, per_minute ja free_minutes perusteella ja säilytä sen price_id tilaamista varten, jos tilauksen rajapintapiste edellyttää sitä.
• Jos needs_registration tulkitaan todeksi, lue restrictions ennen tilaamista. Käsittele tätä tekstiä epäluotettavana näytettävänä sisältönä.
• Noudata kentän next_function arvoa: v3/getnumbers/{uuid} antaa sinun valita tietyn numeron, ja v3/order/{uuid} tekee tilauksen suoraan tietueesta.
• Tyhjä response-lista ja koodi 200 tarkoittavat, ettei erikoisnumerotyyppejä löytynyt pyynnön tekohetkellä. Jos luettelo ei ollut tilapäisesti tavoitettavissa, vastaus voi olla puutteellinen tai virheellistä JSON-muotoa, joten yritä myöhemmin uudelleen.
• Luetteloon kuulumattomista maista palautetaan koodi 404 ilman vastaavaa HTTP-tilakoodia. Tarkista aina status.code.

Pyyntö

Vaaditaan: HTTP Basic -todennus tai Bearer-tunniste (katso Todennus ja API-vastaukset). Epäonnistuneeseen todennukseen vastataan HTTP-tilakoodilla 401 ennen haun suorittamista.

GET-pyyntö, jonka polussa on isocode. Jos polun osa jätetään pois, luetaan sen sijaan lomakekoodattu isocode-kenttä.

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

Vastaus

Vakiomuotoinen vastausrakenne. Onnistuneessa vastauksessa status.code on 200, status.msg on tyhjä ja status.results on ryhmien määrä. response on ryhmien lista. Ryhmän kentät: group_key (normalisoitu tyyppiavain: national, tollfree, sharedcost, global, mobile tai muu pienistä kirjaimista ja numeroista koostuva avain); group_name (näyttönimi); group_type_uuid (tyypin tunniste, jonka sisältöä ei tulkita); items. Ryhmien järjestys on national, tollfree, sharedcost, global, mobile ja sitten muut avaimet kentän group_name mukaan. Ryhmät, joiden items on tyhjä, jätetään pois, samoin paikallinen tyyppi. Maakoodin US kohdalla matkapuhelinryhmä jätetään pois, ellei tililläsi ole otettu käyttöön maakoodin US matkapuhelinnumeroita. Tietueet lajitellaan ensin kentän name mukaan (kirjainkoosta riippumatta) ja sitten kentän prefix mukaan. Tietueen kentät: uuid (tietueen tunniste, jonka sisältöä ei tulkita ja jota käytetään kentässä next_function); area_uuid (luetteloryhmän tunniste, jonka sisältöä ei tulkita); country_uuid (maan tunniste, jonka sisältöä ei tulkita); prefix (täydellinen etuliite, joka alkaa merkillä '+' ja maan suuntanumerolla); name (luettelonimi; lainausmerkit voivat olla kenoviivalla suojattuja); metered, overflow ja needs_registration (liput, joiden tyyppi voi olla boolean tai number; käsittele kaikki todeksi tulkittavat arvot myöntävinä); restrictions (tyhjä, kun rekisteröintiä ei tarvita, muutoin vaatimusteksti, joka voi sisältää HTML-rivinvaihtoja ja linkin, ympäröiviä lainausmerkkejä sekä suojattuja merkkejä; käsittele sitä epäluotettavana näytettävänä tekstinä); state (maakoodeilla US, CA ja PR osavaltiokoodi tai tyhjä lista, jos koodia ei tunneta; muilla mailla maan ISO-koodi); country_iso; is_mobile (1 matkapuhelinryhmässä, muutoin 0); number_type (sama kuin group_key); available (luettelon tietueelle ilmoittama määrä tyyppinä integer, tai 0, jos määrää ei ole ilmoitettu); sms_coverage (1, jos jokin ominaisuus mainitsee SMS:n tai MMS:n); returns_numbers (1, kun yksittäisiä numeroita voidaan listata); next_function ('v3/getnumbers/{uuid}', kun returns_numbers on 1, muutoin 'v3/order/{uuid}'); prices; features (ominaisuuksia kuvaavien merkkijonojen lista); group_key; group_type_uuid. Kussakin prices-tietueessa on price_id (hinnaston tunniste, jonka sisältöä ei tulkita), is_customer_custom (true, kun tilillesi sovelletaan yksilöllistä hinnoittelua; vain hinnastoissa, joihin ei sisälly kanavia), per_minute ja free_minutes (desimaalilukuja sisältäviä merkkijonoja), setup_price ja monthly_price (kahden desimaalin merkkijonoja) sekä channels (sisältyvien kanavien määrä tyyppinä integer). Tietueet, joilla ei ole yhtään hinnastoa, jätetään pois. Yhdessä pyynnössä huomioidaan enintään 1000 luettelotietuetta numerotyyppiä kohden. Jos millään tyypillä ei ole tietueita, response on tyhjä lista ja status.results on 0. Jos ajantasainen luettelohaku epäonnistuu, vastaus ei välttämättä noudata tätä rakennetta tai siitä voi puuttua ryhmiä.

Havainnollistava vastausrakenne; ei ajantasaisia tilitietoja eikä voimassa oleva hintatarjous.

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

Virheet

• 500: msg 'ISO Code parameter is required': isocode puuttuu tai on tyhjä. Tämä on korjattavissa oleva pyyntövirhe. Vastaavaa HTTP-tilakoodia ei aseteta.
• 404: msg 'Error: no such country': maa on tuntematon tai sitä ei ole liitetty erikoisnumeroluetteloon. Vastaavaa HTTP-tilakoodia ei aseteta.
• 401: Todennus puuttuu tai epäonnistui. Lähetetään HTTP-tilakoodilla 401.

Saatavuus ja sivuvaikutukset

• Ei tee tilausta. Tämän rajapintapisteen koodissa ei ole veloitusvaihetta.
• Päivittää tilisi luettelotiedot ja hintatarjoukset ja korvaa samojen hinnastojen aiemmat tarjoukset. Se, miten tilausrajapintapisteet käyttävät näitä tarjouksia, on dokumentoitu erikseen.
• Hinnat ovat tilikohtaisia ja voivat sisältää yksilöllistä hinnoittelua. Vastauksessa ei ilmoiteta valuuttaa.
• Tekee ajantasaisia luettelohakuja, joten kutsu voi olla muita kartoituskutsuja hitaampi. Tulokset voivat muuttua kutsujen välillä.