Dokumentacja REST API
API REST wyszukiwania routingu LRN
Sprawdź numer routingu i dostępne informacje o operatorze dla północnoamerykańskiego numeru telefonu za stałą cenę.
Wybierz API i poświadczenie razem
Zatwierdzone konta dla programistów i automatyzacji, firm oraz dostawców usług komunikacyjnych mogą integrować włączone usługi. Indywidualny programista nie musi udawać firmy. SMS/MMS wysyłane przez aplikacje wymagają odpowiedniej zgody na wysyłkę i rejestracji. Usługa dla osób prywatnych i rodzin nie udostępnia klientom API do inicjowania wysyłki wiadomości.
| Rodzina API | Bazowy adres URL | Uwierzytelnianie i wynik |
|---|---|---|
| Komunikacja v3 | https://api.multitel.net/v3 | Zatwierdzone poświadczenia Basic; kwalifikujące się udostępnione tokeny tylko dla operacji, które je obsługują. JSON status i response. |
| Rejestracja numerów alarmowych | https://api.multi.tel/emergency | Zatwierdzone poświadczenia Basic lub specjalnie udostępniony dostęp bearer. JSON code, message i data. |
| Integracje REST portalu | Host i operacja wskazane w dokumentacji dla programistów Twojego konta | Używaj danych uwierzytelniających, zakresów uprawnień i schematu opisanych dla danej operacji. Żądania sesji przeglądarki stanowią odrębny kanał dostępu. |
Przed użyciem przykładów ustaw MULTITEL_API_USERNAME i MULTITEL_API_PASSWORD w konfiguracji sekretów swojego serwera. Nigdy nie umieszczaj ich w publicznym JavaScripcie przeglądarki, adresach URL ani w repozytorium kodu. Dedykowanymi poświadczeniami zarządzasz w ustawieniach integracji API.
Wyszukaj numer
GET /v3/lrn/{number} przyjmuje numer docelowy w ścieżce. Opcjonalny numer źródłowy można podać jako /v3/lrn/{number}/{ani} dla informacji zależnych od źródła. Używaj cyfr północnoamerykańskich z numerem kierunkowym kraju, tam gdzie ma to zastosowanie; w przykładach użyto zarezerwowanych fikcyjnych numerów.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123"curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123/12025550124"Wykonanie wyszukiwania z prawidłowymi poświadczeniami jest płatne. Stawka wynosi 0,00025 USD za wyszukiwanie: 0,25 USD za 1000 lub 250 USD za milion. Nie ma rabatów wolumenowych. To wyszukiwanie informacji routingowych; nie wykonuje połączenia telefonicznego.
Odczytaj wynik
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Ten zmyślony przykład pokazuje wyłącznie kształt odpowiedzi; nie jest zmierzonym wynikiem routingu. Przed użyciem response sprawdź status.code. Pole cost jest ciągiem znaków z prefiksem waluty, a nie liczbą JSON.
| Pole | Znaczenie |
|---|---|
lrn | Location Routing Number używany do identyfikacji miejsca docelowego routingu. |
ported | Wskaźnik przenoszenia numeru dostarczany przez to wyszukiwanie: zwykle 0 lub 1. Nie traktuj go jako dowodu własności ani uprawnienia do usługi. |
ocn | Operating Company Number, jeśli został podany. |
lata | Local Access and Transport Area, jeśli została podana. |
rc | Centrum taryfowe (rate center), jeśli zostało podane. |
city, state, lec, lectype, jurisdiction, local | Dodatkowe informacje o lokalizacji, operatorze lub źródle, jeśli są dostępne. Mogą być nieobecne lub puste. |
Nie wymagaj obecności wszystkich pól routingu. W szczególności wyniki dla numerów bezpłatnych mogą pomijać lokalne centrum taryfowe i kody operatora. Zwrócony LRN nie jest gwarancją osiągalności w czasie rzeczywistym ani testem jakości połączenia.
Użyj wyszukiwań w swoim przepływie routingu
- Zweryfikuj i znormalizuj żądany numer przed wysłaniem.
- Sprawdź status HTTP i status aplikacji. Zachowaj zapis numeru, czasu i wyniku z usuniętymi danymi wrażliwymi na potrzeby rozwiązywania problemów.
- Używaj tylko pól istotnych dla Twojej reguły routingu i jawnie obsługuj brakujące wartości.
- Ogranicz liczbę ponowień po niejednoznacznej odpowiedzi. Powtórzenie wyszukiwania może spowodować kolejną opłatę; ten punkt końcowy nie ma udokumentowanego klucza idempotentności.
Zobacz produkt LRN i stałą cenę. Publiczna ścieżka OpenAPI zawiera segment ANI; wdrożona implementacja LRN akceptuje też krótsze żądanie bez ANI. lrninfo to osobna operacja i nie należy jej stosować zamiast tego punktu końcowego.
Obsługa błędów i ponowień
- Błąd uwierzytelniania lub uprawnień
- Sprawdź, czy poświadczenie API jest włączone, jaka usługa jest dozwolona oraz jakie obowiązuje ograniczenie źródłowego adresu IP. Plik cookie sesji portalu nie jest poświadczeniem integracji.
- Niewystarczające środki lub brak wymaganej zgody
- Uzupełnij środki na koncie, uzyskaj zgodę na wysyłkę lub dostarcz wymagany dokument, zanim powtórzysz operację.
- Brak wyniku
- Puste zasoby numerów lub brak nazwy dzwoniącego traktuj jako zwykły wynik. Nie zakładaj, że poprawny składniowo numer obsługuje każdą usługę.
- Przekroczenie czasu sieci lub awaria usługi
- Dla operacji odczytu stosuj ograniczoną liczbę ponowień z rosnącymi odstępami między próbami. Przy zakupie, wysyłce lub rejestracji najpierw sprawdź stan operacji; ponowienie przyjętego żądania może powielić płatną czynność.
Obsługa idempotentności zależy od danej rodziny API. połączeń alarmowych API obsługuje klucze ponowień, ale to nie czyni dowolnych żądań v3 idempotentnymi. Zachowaj znaczniki czasu, zwrócone identyfikatory i odpowiedzi z usuniętymi danymi wrażliwymi na potrzeby pomocy technicznej.
Przejdź do dokumentacji swojego konta
Dokumentacja dostępna po zalogowaniu filtruje operacje według Twoich uprawnień i włączonych usług. Korzystaj z jej dokładnego hosta, typu poświadczeń, pól żądania i schematu odpowiedzi. Konsole mogą wykonywać operacje na żywo, w tym zakupy i wysyłanie wiadomości.