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 US$ по претрази: 0,25 US$ за 1.000 или 250 US$ за милион. Нема попуста на количину. Ово је претрага информација о рутирању; не упућује телефонски позив.
Читање резултата
{
"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 | Додатни детаљи о локацији, оператеру или пореклу, када су доступни. Могу бити одсутни или празни. |
Не захтевајте да су сва поља рутирања присутна. Конкретно, резултати за бројеве бесплатне за позиваоца могу изоставити детаље о локалном тарифном центру и коду оператера. Враћени LRN није гаранција доступности у реалном времену нити тест квалитета позива.
Користите претраге у току рутирања
- Валидирајте и нормализујте тражени број пре слања.
- Проверите HTTP статус и статус апликације. За отклањање проблема сачувајте запис броја, времена и резултата са уклоњеним осетљивим подацима.
- Користите само поља релевантна за ваше правило рутирања и експлицитно обрадите одсутне вредности.
- Ограничите поновне покушаје након нејасног одговора. Понављање претраге може произвести још једну наплату; овај endpoint нема документован кључ идемпотентности.
Погледајте LRN производ и фиксну цену по упиту. Јавна OpenAPI путања укључује ANI сегмент; примењена LRN имплементација такође прихвата краћи захтев без ANI. lrninfo је засебна операција и не треба је користити уместо ове крајње тачке.
Обрада грешака и поновних покушаја
- Неуспела аутентификација или дозвола
- Проверите да ли је API акредитив омогућен, као и дозвољену услугу и ограничење изворне IP адресе. Колачић сесије портала није акредитив за интеграцију.
- Недовољно кредита или неиспуњено одобрење
- Решите питање стања налога, одобрења за слање или захтева за документацију пре него што поновите операцију.
- Нема резултата
- Празан инвентар или непостојеће име позиваоца третирајте као уобичајен исход. Не претпостављајте да синтаксно исправан број има све услуге.
- Истек мрежне везе или отказивање услуге
- За читање користите ограничен број поновних покушаја са повећањем размака (backoff). Код куповине, слања или регистрације прво проверите стање операције; поновно слање прихваћеног захтева може дуплирати наплативу радњу.
Подршка за идемпотентност зависи од сваке породице API-ја. API за хитне позиве подржава кључеве за поновни покушај; то не значи да је произвољан v3 захтев идемпотентан. За подршку сачувајте временске ознаке, враћене ID-јеве и одговоре са уклоњеним осетљивим подацима.
Наставите са референцом вашег налога
Референца за пријављене кориснике филтрира операције према вашим дозволама и омогућеним сервисима. Користите тачан хост, тип креденцијала, поља захтева и шему одговора из ње. Конзоле могу извршавати операције уживо, укључујући куповине и поруке.