Достъп до акаунта и проекта
Използвайте активиран API акаунт през HTTPS от разрешен IP адрес. Проектът трябва да принадлежи на този акаунт и да не е изтрит. Използвайте уникалния идентификатор на проекта от процеса за заявяване на пренос на номера, а не неговия числов идентификатор в базата данни или телефонен номер. При съставяне на заявка приложете URL кодиране към идентификатора на проекта.
Заявка
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"Тази крайна точка не чете тяло на заявката, параметри за разделяне на страници или филтър по дата.
Отговор
Измислен примерен отговор.
{
"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
}
}
}Външното поле status.code показва резултата от API извикването. Отделното поле response.status е изчисленото обобщение на преноса на номера за проекта. Не бъркайте двете полета.
Обобщението не е резултат за всички номера
За обобщението се избира In Progress, ако поне един номер е с това състояние, иначе Pending, след това Completed, а накрая Rejected. Ако няма съвпадащо известно състояние, стойността по подразбиране е Pending. Затова проект, който съдържа както номера със завършен пренос, така и номера с отхвърлен пренос, показва Completed, въпреки че все още съдържа отхвърлени номера.
Винаги преглеждайте броячите и списъка с отделните номера, преди да заключите, че целият проект е завършен. counts.total включва всеки ред, който свързва проекта с номер; другите броячи обхващат само четирите известни стойности на състоянието и сумата им може да се различава от общия брой, когато има други стойности. При проект без номера всички броячи са нула, а обобщението е Pending.
Тълкуване на състоянието на преноса
| Стойност | Етикет |
|---|---|
| 0 | Pending |
| 1 | In Progress |
| 2 | Completed |
| 9 | Rejected |
Запазвайте числовото състояние и допускайте обработката на неизвестни стойности. При неизвестни етикети се използва съхранената стойност; не е гарантирано, че ще бъде върнат нов етикет. Самото наличие на съхранено състояние за завършване или насрочена дата не представлява проверка на маршрутизирането на входящите повиквания или на всяка услуга за номера.
Грешки и ограничения
Проверявайте както HTTP отговора, така и status.code/status.msg. За проект, който липсва, е изтрит или не принадлежи на акаунта, се връща API код 404 със съобщение, че проектът не е намерен. Прилагат се и ограниченията за удостоверяване и за изходния IP адрес. Примерите не изпращат реална заявка, а успешният отговор не е доказателство, че оператор е приел или завършил пренос.
Ефекти
Тази крайна точка чете съхранените броячи на проекта. В прегледания обработчик тя не подава заявка за пренос, не променя състояние, не започва повикване и не задължава акаунта със сума. Не предоставя периодични проверки при оператора в реално време или абонамент за известия чрез уебкука.