Dostęp do konta i projektu
Korzystaj z aktywnego konta API przez HTTPS z dozwolonego adresu IP. Projekt musi należeć do tego konta i nie może być usunięty. Użyj unikatowego identyfikatora projektu z procesu składania zlecenia przeniesienia numerów, a nie jego liczbowego identyfikatora w bazie danych ani numeru telefonu. Podczas tworzenia żądania zakoduj identyfikator projektu na potrzeby użycia w adresie URL.
Żądanie
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"Ten punkt końcowy nie odczytuje treści żądania, parametrów stronicowania ani filtra dat.
Odpowiedź
Przykład fikcyjnej odpowiedzi.
{
"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
}
}
}Pole na poziomie zewnętrznym status.code podaje wynik API. Odrębne pole response.status zawiera zbiorczy status przenoszenia numerów wyznaczony dla projektu. Nie myl tych dwóch informacji.
Status zbiorczy nie jest wynikiem dla wszystkich numerów
Jako status zbiorczy wybierany jest In Progress, jeśli dowolny numer ma ten status, w przeciwnym razie Pending, następnie Completed, a następnie Rejected. Jeśli nie ma pasującego znanego statusu, domyślnie wybierany jest Pending. Projekt zawierający zarówno numery, których przenoszenie zakończono, jak i numery odrzucone zgłasza zatem Completed, mimo że nadal zawiera odrzucone numery.
Zawsze sprawdzaj liczniki i listę poszczególnych numerów, zanim uznasz cały projekt za zakończony. counts.total uwzględnia każdy rekord numeru w projekcie; pozostałe liczniki obejmują tylko cztery znane wartości statusu i mogą nie sumować się do liczby całkowitej, gdy występują inne wartości. Projekt bez numerów zwraca zerowe wartości liczników i status zbiorczy Pending.
Interpretacja statusu przenoszenia numerów
| Wartość | Etykieta |
|---|---|
| 0 | Pending |
| 1 | In Progress |
| 2 | Completed |
| 9 | Rejected |
Zachowuj liczbową wartość statusu i obsługuj również nieznane wartości. W przypadku nieznanych etykiet zwracana jest zapisana wartość; nie ma gwarancji otrzymania nowej etykiety. Sam zapisany status zakończenia lub zaplanowany termin nie stanowi testu trasowania połączeń przychodzących ani wszystkich usług danego numeru.
Błędy i ograniczenia
Sprawdzaj zarówno odpowiedź HTTP, jak i status.code/status.msg. W przypadku projektu, który nie istnieje, został usunięty lub nie należy do konta, zwracany jest kod API 404 z komunikatem o nieznalezieniu projektu. Obowiązują również wymagania uwierzytelniania i ograniczenia dotyczące źródłowego adresu IP. Przykłady nie wysyłają rzeczywistych żądań, a pomyślna odpowiedź nie dowodzi, że operator zaakceptował lub zakończył przeniesienie numeru.
Skutki działania
Ten punkt końcowy odczytuje zapisane wartości liczników projektu. W sprawdzonej procedurze obsługi nie składa zlecenia przeniesienia numeru, nie zmienia statusu, nie inicjuje połączenia ani nie obciąża konta. Nie udostępnia odpytywania operatora w czasie rzeczywistym ani subskrypcji powiadomień webhook.