Документация на REST API
REST API за справка за LRN маршрутизация
Проверете номера за маршрутизация и наличната информация за оператора за телефонен номер в Северна Америка срещу фиксирана цена.
Изберете API и идентификационни данни заедно
Одобрените акаунти за разработчици и автоматизация, фирми и доставчици на комуникационни услуги могат да интегрират активираните услуги. Индивидуалният разработчик не трябва да се представя за фирма. SMS/MMS от приложения изискват съответното одобрение за изпращане и регистрация. Услугата за физически лица и семейства няма достъпен за клиента API за иницииране на съобщения.
| Семейство API | Базов URL | Автентикация и резултат |
|---|---|---|
| Комуникации v3 | https://api.multitel.net/v3 | Одобрени Basic идентификационни данни; допустими предоставени токени само за операциите, които ги поддържат. JSON status и response. |
| Регистрация за спешни повиквания | https://api.multi.tel/emergency | Одобрени Basic идентификационни данни или изрично предоставен bearer достъп. JSON code, message и data. |
| REST интеграции в портала | Хост и операция, показани в справката за разработчици във вашия акаунт | Използвайте документираните идентификационни данни, обхвати и схема на съответната операция. Заявките от сесия в браузър са отделен начин за достъп. |
Задайте MULTITEL_API_USERNAME и MULTITEL_API_PASSWORD чрез конфигурацията за тайни на вашия сървър, преди да използвате примерите. Никога не ги вграждайте в публичен JavaScript за браузър, в URL адреси или в системи за контрол на версиите. Специалните идентификационни данни се управляват в настройките за API интеграция.
Проверка на номер
GET /v3/lrn/{number} приема номера на получателя в пътя. По избор може да се зададе номер на инициатора като /v3/lrn/{number}/{ani} за информация, зависеща от произхода. Използвайте североамерикански цифри с кода на държавата, когато е приложимо; примерите използват резервирани измислени номера.
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"Изпълнението на проверка с валидни идентификационни данни се таксува. Цената е 0,00025 щ.д. за проверка: 0,25 щ.д. за 1000 или 250 щ.д. за милион. Няма отстъпки за обем. Това е проверка на информация за маршрутизиране; тя не осъществява телефонно повикване.
Прочитане на резултата
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Този измислен пример демонстрира само формата на отговора; той не е измерен резултат от маршрутизиране. Проверете status.code, преди да използвате response. Полето cost е низ с префикс на валута, а не JSON число.
| Поле | Значение |
|---|---|
lrn | Location Routing Number, използван за идентифициране на направлението за маршрутизиране. |
ported | Индикатор за пренасяне на номера, предоставен от тази проверка: обикновено 0 или 1. Не го използвайте като доказателство за собственост или допустимост за услуга. |
ocn | Operating Company Number, когато е предоставен. |
lata | Local Access and Transport Area, когато е предоставена. |
rc | Тарифен център, когато е предоставен. |
city, state, lec, lectype, jurisdiction, local | Допълнителни подробности за местоположението, оператора или произхода, когато са налични. Те може да липсват или да са празни. |
Не изисквайте всяко поле за маршрутизиране да присъства. По-специално, резултатите за безплатни номера (toll-free) могат да пропускат подробности за локален тарифен център и кодове на оператора. Върнатият LRN не е гаранция в реално време за достижимост, нито тест за качеството на повикването.
Използвайте проверките в работния си процес за маршрутизиране
- Валидирайте и нормализирайте заявения номер, преди да го изпратите.
- Проверявайте HTTP статуса и статуса на приложението. Пазете запис с премахнати чувствителни данни на номера, часа и резултата за отстраняване на проблеми.
- Използвайте само полетата, които са от значение за вашето правило за маршрутизиране, и обработвайте липсващите стойности изрично.
- Ограничавайте повторните опити след несигурен отговор. Повторението на проверка може да доведе до ново таксуване; за тази крайна точка няма документиран ключ за идемпотентност.
Вижте продукта LRN и фиксираната цена. Публичният OpenAPI път включва ANI сегмент; внедрената реализация на LRN приема и по-кратка заявка без ANI. lrninfo е отделна операция и не трябва да се използва вместо тази крайна точка.
Обработка на грешки и повторни опити
- Грешка при автентикация или разрешения
- Проверете дали API идентификационните данни са активирани, дали е разрешена съответната услуга и какво е ограничението за IP адреса на източника. Бисквитката на сесия в портала не е идентификационни данни за интеграция.
- Недостатъчен кредит или липсващо одобрение
- Уредете баланса по акаунта, одобрението за изпращане или изискването за документи, преди да повторите операцията.
- Няма резултат
- Третирайте празната наличност или липсващото име на обаждащия се като обичаен резултат. Не приемайте, че синтактично валиден номер разполага с всяка услуга.
- Изтичане на времето в мрежата или срив на услугата
- За операциите за четене използвайте ограничен брой повторни опити със засилващо се закъснение. При покупка, изпращане или регистрация първо проверете състоянието на операцията; повторението на вече приета заявка може да дублира платено действие.
Поддръжката на идемпотентност зависи от всяко семейство API. API за спешни повиквания поддържа ключове за повторни опити; това не прави произволни заявки към v3 идемпотентни. Запазвайте времевите отпечатъци, върнатите идентификатори и отговорите с премахнати чувствителни данни за поддръжката.
Продължете със справочника на вашия акаунт
Справочникът след вход филтрира операциите според вашите права и активираните услуги. Използвайте точния му хост, типа удостоверяване, полетата на заявката и схемата на отговора. Конзолите могат да изпълняват реални операции, включително покупки и съобщения.