Приступ налогу и пројекту
Користите активан 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 адресе. Примери не шаљу стварни захтев, а успешан одговор није доказ да је оператор прихватио или завршио пренос.
Ефекти
Ова крајња тачка чита сачуване бројеве ставки пројекта. У прегледаном обрађивачу не подноси захтев за пренос, не мења статус, не покреће позив нити задужује налог. Не омогућава периодично проверавање код оператора у реалном времену нити претплату на обавештења путем веб-куке.