Åtkomst till konto och projekt
Använd ett aktiverat API-konto via HTTPS från en tillåten IP-adress. Projektet måste tillhöra det kontot och får inte vara raderat. Använd projektets unika ID från arbetsflödet för porteringsbeställningar, inte dess numeriska databas-ID eller ett telefonnummer. URL-koda projektets ID när du bygger en begäran.
Begäran
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"Den här ändpunkten läser ingen begärandekropp, inga sidindelningsparametrar och inget datumfilter.
Svar
Påhittat exempel på ett svar.
{
"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 yttre fältet status.code anger resultatet från API. Det separata fältet response.status är projektets härledda sammanfattning av nummerporteringen. Blanda inte ihop dessa två.
En sammanfattning anger inte resultatet för samtliga nummer
Sammanfattningen väljer In Progress om något nummer har den statusen, annars Pending, annars Completed och annars Rejected. Om ingen känd status matchar används Pending som standard. Ett projekt som innehåller både färdigporterade och avvisade nummer rapporterar därför Completed trots att det fortfarande innehåller avvisade nummer.
Kontrollera alltid antalsuppgifterna och listan över enskilda nummer innan du avgör att hela projektet är klart. counts.total omfattar varje rad för ett projektnummer; de övriga räknarna omfattar endast de fyra kända statusvärdena och deras summa kan avvika från totalen om andra värden förekommer. Ett projekt utan nummer rapporterar noll i alla räknare och Pending i sammanfattningen.
Tolka porteringsstatus
| Värde | Benämning |
|---|---|
| 0 | Pending |
| 1 | In Progress |
| 2 | Completed |
| 9 | Rejected |
Behåll det numeriska statusvärdet och hantera även okända värden. Om en benämning är okänd används det lagrade värdet som reserv; någon ny benämning garanteras inte. En lagrad status som anger att porteringen är klar eller ett schemalagt datum innebär inte i sig att inkommande dirigering eller alla tjänster för numret har testats.
Fel och begränsningar
Kontrollera både HTTP-svaret och status.code/status.msg. Om projektet saknas, är raderat eller inte tillhör kontot returneras API-koden 404 med ett meddelande om att projektet inte hittades. Autentisering och begränsningar för källans IP-adress gäller också. Exemplen skickar ingen begäran till den faktiska tjänsten, och ett lyckat svar bevisar inte att en operatör har accepterat eller slutfört en nummerportering.
Effekter
Den här ändpunkten läser lagrade antalsuppgifter för projektet. I den granskade hanteraren skickar den inte in någon porteringsbeställning, ändrar ingen status, startar inget samtal och debiterar inte kontot. Den tillhandahåller varken statusförfrågningar till operatören i realtid eller någon webhook-prenumeration.