Prieiga prie paskyros ir projekto
Naudokite įgalintą API paskyrą per HTTPS, jungdamiesi iš leidžiamo IP adreso. Projektas turi priklausyti tai paskyrai ir negali būti ištrintas. Naudokite unikalų projekto identifikatorių iš numerių perkėlimo užsakymo proceso, o ne skaitinį jo identifikatorių duomenų bazėje ar telefono numerį. Kurdami užklausą, projekto identifikatorių užkoduokite pagal URL kodavimo taisykles.
Užklausa
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"Šis galinis taškas neskaito užklausos turinio, puslapiavimo parametrų ar datos filtro.
Atsakymas
Išgalvotas atsakymo pavyzdys.
{
"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
}
}
}Išorinis laukas status.code nurodo API rezultatą. Atskiras laukas response.status yra iš projekto duomenų išvesta numerių perkėlimo suvestinė. Nepainiokite šių dviejų laukų.
Suvestinė nėra visų numerių rezultatas
Suvestinėje pasirenkama In Progress, jei bent vienas numeris turi šią būseną; kitu atveju pasirenkama Pending, tada Completed, tada Rejected. Jei nerandama jokios atitinkančios žinomos būsenos, pagal numatytąją nuostatą pasirenkama Pending. Todėl projektui, kuriame yra ir numerių su užbaigtu perkėlimu, ir atmestų numerių, nurodoma Completed, nors jame tebėra atmestų numerių.
Prieš nuspręsdami, kad visas projektas užbaigtas, visada patikrinkite skaitiklius ir atskirų numerių sąrašą. counts.total apima kiekvieną projekto numerio įrašą; kiti skaitikliai apima tik keturias žinomas būsenų reikšmes, todėl, jei yra kitų reikšmių, jų suma gali nesutapti su bendru skaičiumi. Projekte, kuriame nėra numerių, visi skaitikliai yra nuliniai, o suvestinės būsena yra Pending.
Numerių perkėlimo būsenos reikšmė
| Reikšmė | Pavadinimas |
|---|---|
| 0 | Pending |
| 1 | In Progress |
| 2 | Completed |
| 9 | Rejected |
Išsaugokite skaitinę būseną ir numatykite nežinomų reikšmių apdorojimą. Nežinomo būsenos pavadinimo atveju naudojama saugoma reikšmė; naujas pavadinimas negarantuojamas. Vien saugoma užbaigimo būsena ar suplanuota data nepatikrina įeinančių skambučių maršruto ar visų su numeriu susietų paslaugų.
Klaidos ir apribojimai
Patikrinkite ir HTTP atsakymą, ir status.code/status.msg. Jei projekto nėra, jis ištrintas arba nepriklauso paskyrai, grąžinamas API kodas 404 ir pranešimas, kad projektas nerastas. Taip pat taikomas autentifikavimas ir šaltinio IP adreso apribojimai. Pavyzdžiai nesiunčia tikros užklausos, o sėkmingas atsakymas neįrodo, kad operatorius priėmė ar užbaigė numerio perkėlimą.
Poveikis
Šis galinis taškas nuskaito saugomus projekto skaitiklius. Peržiūrėtoje apdorojimo funkcijoje jis nepateikia numerio perkėlimo užsakymo, nekeičia būsenos, nepradeda skambučio ir nenuskaito lėšų iš paskyros. Jis nesuteikia galimybės realiuoju laiku periodiškai užklausti operatoriaus ar užsiprenumeruoti pranešimų per žiniatinklio atgalinius iškvietimus.