Tilgang til konto og prosjekt
Bruk en aktivert API-konto over HTTPS fra en tillatt IP-adresse. Prosjektet må tilhøre denne kontoen og må ikke være slettet. Bruk prosjektets unike ID fra arbeidsflyten for porteringsbestillinger, ikke den numeriske database-ID-en eller et telefonnummer. URL-kod prosjekt-ID-en når du bygger en forespørsel.
Forespørsel
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"Dette endepunktet leser verken forespørselskropp, pagineringsparametere eller datofilter.
Svar
Oppdiktet svareksempel.
{
"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
}
}
}Det ytre feltet status.code angir resultatet fra API. Det separate feltet response.status er prosjektets avledede sammendragsstatus for portering. Ikke forveksle disse to.
En sammendragsstatus er ikke et resultat for alle numrene
Sammendragsstatusen blir In Progress hvis minst ett nummer har denne statusen, ellers Pending, ellers Completed, ellers Rejected. Hvis ingen numre har en av de kjente statusene, brukes Pending som standard. Et prosjekt som inneholder numre med både fullført og avvist portering, rapporterer derfor Completed selv om det fortsatt inneholder numre med avvist portering.
Kontroller alltid antallene og listen over de enkelte numrene før du konkluderer med at hele prosjektet er ferdig. counts.total inkluderer hver rad med et nummer i prosjektet; de andre tellerne omfatter bare de fire kjente statusverdiene, og summen av dem kan avvike fra totalen når andre verdier forekommer. Et prosjekt uten numre rapporterer null i alle tellere og sammendragsstatusen Pending.
Tolk porteringsstatusen
| Verdi | Betegnelse |
|---|---|
| 0 | Pending |
| 1 | In Progress |
| 2 | Completed |
| 9 | Rejected |
Behold den numeriske statusen og håndter ukjente verdier. Ved ukjente betegnelser brukes den lagrede verdien; en ny betegnelse er ikke garantert. En lagret fullføringsstatus eller planlagt dato tester ikke i seg selv ruting av innkommende anrop eller alle tjenester på nummeret.
Feil og begrensninger
Kontroller både HTTP-svaret og status.code/status.msg. Et prosjekt som mangler, er slettet eller ikke tilhører kontoen, gir API-kode 404 med en melding om at prosjektet ikke ble funnet. Krav til autentisering og begrensninger for kilde-IP gjelder også. Eksemplene sender ingen faktisk forespørsel, og et vellykket svar er ikke bevis på at en operatør har godtatt eller fullført en portering.
Virkninger
Dette endepunktet leser lagrede antall for prosjektet. I den gjennomgåtte behandlingsfunksjonen sender det ingen porteringsbestilling, endrer ingen status, starter ingen samtale og belaster ikke kontoen. Det tilbyr verken løpende forespørsler til operatøren i sanntid eller abonnement på webhook-varsler.