Tarkista numeronsiirtoprojektin tila

Tilin ja projektin käyttöoikeudet

Käytä käytössä olevaa API-tiliä HTTPS-yhteydellä sallitusta IP-osoitteesta. Projektin on kuuluttava kyseiselle tilille, eikä se saa olla poistettu. Käytä numeronsiirtotilauksen työnkulusta saatavaa projektin yksilöllistä tunnistetta, älä sen numeerista tietokantatunnistetta tai puhelinnumeroa. URL-koodaa projektin tunniste pyyntöä muodostaessasi.

Pyyntö

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"

Tämä päätepiste ei lue pyynnön runkoa, sivutusparametreja eikä päivämääräsuodatinta.

Vastaus

Kuvitteellinen vastausesimerkki.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

Ulompi kenttä status.code ilmoittaa API-kutsun tuloksen. Erillinen kenttä response.status on projektin tiedoista johdettu numeronsiirron yhteenveto. Älä sekoita näitä keskenään.

Yhteenveto ei ilmaise kaikkien numeroiden tulosta

Yhteenvedon tilaksi valitaan In Progress, jos jollakin numerolla on kyseinen tila, muutoin Pending, sen jälkeen Completed ja viimeiseksi Rejected. Jos mikään tunnettu tila ei täsmää, oletuksena käytetään tilaa Pending. Projekti, jossa on sekä valmiiksi siirrettyjä että hylättyjä numeroita, ilmoittaa siksi tilan Completed, vaikka siinä on edelleen hylättyjä numeroita.

Tarkista aina lukumäärät ja yksittäisten numeroiden luettelo ennen kuin päättelet koko projektin olevan valmis. counts.total sisältää kaikki projektin numerorivit; muut laskurit kattavat vain neljä tunnettua tila-arvoa, eikä niiden summa välttämättä vastaa kokonaismäärää, jos muitakin arvoja esiintyy. Projekti, jossa ei ole numeroita, ilmoittaa kaikkien laskurien arvoksi nollan ja yhteenvedon tilaksi Pending.

Numeronsiirron tilan tulkitseminen

Säilytä numeerinen tila ja varaudu myös tuntemattomiin arvoihin. Jos nimike on tuntematon, sen sijaan käytetään tallennettua arvoa; uutta nimikettä ei taata. Tallennettu valmistumistila tai ajoitettu päivämäärä ei itsessään tarkoita, että saapuvan liikenteen reititys tai kaikki numeron palvelut olisi testattu.

Virheet ja rajoitukset

Tarkista sekä HTTP-vastaus että status.code/status.msg. Jos projekti puuttuu, on poistettu tai ei kuulu tilille, palautetaan API-koodi 404 ja ilmoitus siitä, ettei projektia löydy. Myös todennusvaatimukset ja lähde-IP-osoitteen rajoitukset ovat voimassa. Esimerkit eivät lähetä pyyntöä varsinaiseen palveluun, eikä onnistunut vastaus todista operaattorin hyväksyneen tai suorittaneen numeronsiirtoa.

Vaikutukset

Tämä päätepiste lukee projektin tallennetut lukumäärät. Katselmoidussa käsittelijässä se ei lähetä numeronsiirtotilausta, muuta tilaa, käynnistä puhelua eikä veloita tiliä. Se ei tarjoa operaattorin tilatietojen reaaliaikaista kyselyä eikä webhook-tilausta.