Arendajad

GET/v3/lnp/project/{uniqueid}/status

Kontrollige numbrite teisaldamise projekti olekut

Vaadake projekti kokkuvõtet ja olekute kaupa esitatud arve ilma arvelduse juurdepääsuandmeid hankimata.

Sellel lehel
  1. Juurdepääs kontole ja projektile
  2. Päring
  3. Vastus
  4. Kokkuvõte ei näita kõigi numbrite tulemust
  5. Numbrite teisaldamise oleku tõlgendamine
  6. Vead ja piirangud
  7. Toime

Juurdepääs kontole ja projektile

Kasutage lubatud IP-aadressilt aktiveeritud API kontot üle HTTPS ühenduse. Projekt peab kuuluma sellele kontole ega tohi olla kustutatud. Kasutage numbrite teisaldamise tellimuse töövoost saadud projekti kordumatut identifikaatorit, mitte selle arvulist andmebaasiidentifikaatorit ega telefoninumbrit. Päringu koostamisel kodeerige projekti identifikaator URL-i jaoks.

Päring

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

See lõpp-punkt ei loe päringu sisu, lehekülgedeks jaotamise parameetreid ega kuupäevafiltrit.

Vastus

Väljamõeldud vastuse näide.

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

Välimine väli status.code näitab API tulemust. Eraldi väli response.status on projekti andmetest tuletatud numbrite teisaldamise kokkuvõte. Ärge ajage neid kahte segamini.

Kokkuvõte ei näita kõigi numbrite tulemust

Kokkuvõtteks valitakse In Progress, kui mõnel numbril on see olek; vastasel juhul Pending, seejärel Completed ja seejärel Rejected. Kui ükski teadaolev olek ei vasta, kasutatakse vaikimisi väärtust Pending. Seega näitab projekt, milles on nii lõpetatud teisaldamisega kui ka tagasilükatud numbreid, väärtust Completed, kuigi selles on endiselt tagasilükatud numbreid.

Enne kogu projekti lõpetatuks lugemist kontrollige alati arve ja üksikute numbrite loendit. counts.total hõlmab iga projekti numbri kirjet; teised loendurid hõlmavad ainult nelja teadaolevat olekuväärtust ning muude väärtuste esinemisel ei pruugi nende summa koguarvuga võrduda. Ilma numbriteta projekti kõik loendurid on nullis ja kokkuvõtte väärtus on Pending.

Numbrite teisaldamise oleku tõlgendamine

Numbrite teadaolevad olekuväärtused
VäärtusNimetus
0Pending
1In Progress
2Completed
9Rejected

Säilitage arvuline olek ja arvestage tundmatute väärtustega. Tundmatu nimetuse korral kasutatakse salvestatud väärtust; uus nimetus ei ole garanteeritud. Salvestatud lõpetamisolek või kavandatud kuupäev ei kontrolli iseenesest sissetulevate kõnede marsruutimist ega kõiki numbriga seotud teenuseid.

Vead ja piirangud

Kontrollige nii HTTP vastust kui ka välju status.code/status.msg. Kui projekt puudub, on kustutatud või ei kuulu kontole, tagastatakse API kood 404 koos teatega, et projekti ei leitud. Kehtivad ka autentimise ja lähte-IP piirangud. Näited ei tee tegelikku päringut ning edukas vastus ei tõenda, et sideoperaator on numbri teisaldamise vastu võtnud või lõpetanud.

Toime

See lõpp-punkt loeb projekti salvestatud loendureid. Ülevaadatud töötlejas ei esita see numbri teisaldamise taotlust, ei muuda olekut, ei algata kõnet ega debiteeri kontot. See ei paku sideoperaatori andmete reaalajas perioodilist pärimist ega veebihaagi tellimust.