Документация на REST API
Направете първата си API заявка към MultiTEL
Започнете със заявка само за четене, разберете отговора и след това изберете справочника за услугата, която искате да изградите.
Изберете 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 интеграция.
Първа заявка: прочетете баланса си
Това четене не купува услуга и не инициира повикване или съобщение.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"API за комуникации v3 връща резултата на приложението в тялото на JSON. Проверете HTTP статуса и status.code, преди да прочетете response; отхвърлена заявка може да няма обект response. Стойностите на кодовете могат да бъдат низове или числа.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Това е измислен пример, а не баланс на акаунт. Третирайте паричните стойности като десетични суми. При диагностика на отхвърлена заявка запазете съобщението от отговора на сървъра, като предварително премахнете идентификационните данни.
Използвайте данните за таксуване правилно
Отговорът за баланса съдържа текущия баланс, валутата и условията за плащане. Той не показва цената на бъдещо повикване, нито пълна фактура. За тези въпроси използвайте съответните операции за тарифи и използване. Съществуващите номера може да са с различни планове от днешния каталог.
Изберете следващата си интеграция
REST API за справка за LRN маршрутизация
Проверете номера за маршрутизация и наличната информация за оператора за телефонен номер в Северна Америка срещу фиксирана цена.
Прочетете ръководството за интеграция →REST API за телефонни номера
Открийте налични държави и номера, прегледайте пълната оферта и управлявайте номерата, които притежавате.
Прочетете ръководството за интеграция →REST API за SMS и MMS
Изпращайте одобрени приложни съобщения и обработвайте приемането, събитията за доставка, сегментирането и таксите.
Прочетете ръководството за интеграция →REST API за спешни повиквания
Регистрирайте номер и адрес на услугата, следете състоянието на активирането и поддържайте записа актуален при промяна на местоположението.
Прочетете ръководството за интеграция →REST API за акаунт и фактуриране
Прочетете баланса и информацията за фактуриране, достъпни за вашата одобрена интеграция.
Прочетете ръководството за интеграция →CNAM и справки за маршрутизация
Прочитайте имената на обаждащите се, разберете нивата на справки и използвайте информацията за маршрутизиране на номера.
CNAM REST справочник →Хостван PBX
Започнете с наличните тарифни планове на услугата и с тенанта, който възнамерявате да конфигурирате.
API за тарифни планове на хостван PBX →Обработка на грешки и повторни опити
- Грешка при автентикация или разрешения
- Проверете дали API идентификационните данни са активирани, дали е разрешена съответната услуга и какво е ограничението за IP адреса на източника. Бисквитката на сесия в портала не е идентификационни данни за интеграция.
- Недостатъчен кредит или липсващо одобрение
- Уредете баланса по акаунта, одобрението за изпращане или изискването за документи, преди да повторите операцията.
- Няма резултат
- Третирайте празната наличност или липсващото име на обаждащия се като обичаен резултат. Не приемайте, че синтактично валиден номер разполага с всяка услуга.
- Изтичане на времето в мрежата или срив на услугата
- За операциите за четене използвайте ограничен брой повторни опити със засилващо се закъснение. При покупка, изпращане или регистрация първо проверете състоянието на операцията; повторението на вече приета заявка може да дублира платено действие.
Поддръжката на идемпотентност зависи от всяко семейство API. API за спешни повиквания поддържа ключове за повторни опити; това не прави произволни заявки към v3 идемпотентни. Запазвайте времевите отпечатъци, върнатите идентификатори и отговорите с премахнати чувствителни данни за поддръжката.
Продължете със справочника на вашия акаунт
Справочникът след вход филтрира операциите според вашите права и активираните услуги. Използвайте точния му хост, типа удостоверяване, полетата на заявката и схемата на отговора. Конзолите могат да изпълняват реални операции, включително покупки и съобщения.