Qasja në llogari dhe në projekt
Përdorni një llogari API të aktivizuar përmes HTTPS nga një adresë IP e lejuar. Projekti duhet t'i përkasë asaj llogarie dhe nuk duhet të jetë i fshirë. Përdorni identifikuesin unik të projektit nga rrjedha e punës së porosisë së portimit, jo identifikuesin e tij numerik në bazën e të dhënave apo një numër telefoni. Kur ndërtoni një kërkesë, kodojeni identifikuesin e projektit sipas formatit URL.
Kërkesa
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"Kjo pikë fundore nuk lexon trupin e kërkesës, parametra të ndarjes në faqe apo filtër sipas datës.
Përgjigjja
Shembull i trilluar përgjigjeje.
{
"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
}
}
}Fusha e jashtme status.code raporton rezultatin e API. Fusha më vete response.status është përmbledhja e portimit e llogaritur për projektin. Mos i ngatërroni këto dy fusha.
Një përmbledhje nuk është rezultat për të gjithë numrat
Përmbledhja zgjedh In Progress nëse ndonjë numër e ka atë gjendje, përndryshe Pending, përndryshe Completed, përndryshe Rejected. Kur nuk përputhet asnjë gjendje e njohur, përdoret si parazgjedhje Pending. Prandaj, një projekt që përmban si numra me portim të përfunduar, ashtu edhe numra të refuzuar, raporton Completed megjithëse ende ka numra të refuzuar.
Kontrolloni gjithmonë numërimet dhe listën e numrave individualë përpara se të vendosni që i gjithë projekti ka përfunduar. counts.total përfshin çdo rresht të numrave të projektit; numëruesit e tjerë mbulojnë vetëm katër vlerat e njohura të gjendjes dhe shuma e tyre mund të mos jetë e barabartë me totalin kur ekzistojnë vlera të tjera. Një projekt pa numra raporton numërues me vlerë zero dhe një përmbledhje Pending.
Interpretimi i gjendjes së portimit
| Vlera | Etiketa |
|---|---|
| 0 | Pending |
| 1 | In Progress |
| 2 | Completed |
| 9 | Rejected |
Ruani gjendjen numerike dhe lejoni vlera të panjohura. Për etiketat e panjohura përdoret vlera e ruajtur, pa garantuar një etiketë të re. Një gjendje përfundimi e ruajtur ose një datë e planifikuar nuk teston vetvetiu drejtimin e thirrjeve hyrëse apo çdo shërbim të numrit.
Gabimet dhe kufizimet
Kontrolloni si përgjigjen HTTP, ashtu edhe status.code/status.msg. Një projekt që mungon, është fshirë ose nuk i përket llogarisë kthen kodin API 404 me një mesazh që tregon se projekti nuk u gjet. Zbatohen gjithashtu autentikimi dhe kufizimet për adresën IP burimore. Shembujt nuk bëjnë një kërkesë reale dhe një përgjigje e suksesshme nuk është provë që një operator ka pranuar ose përfunduar një transferim.
Efektet
Kjo pikë fundore lexon numërimet e ruajtura të projektit. Në funksionin trajtues të shqyrtuar, ajo nuk dërgon kërkesë transferimi, nuk ndryshon gjendje, nuk nis thirrje dhe nuk debiton llogarinë. Nuk ofron pyetje periodike në kohë reale ndaj operatorit apo abonim në njoftime webhook.