Документация на REST API
REST API за телефонни номера
Открийте налични държави и номера, прегледайте пълната оферта и управлявайте номерата, които притежавате.
Изберете 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/getcountries"Отговорът на v3 съдържа status и масив response. Записите за държави включват isocode, name, countrycode, информация за възможностите и next_function. Наличността зависи от акаунта и от инвентара; наличието на държава не е обещание, че всеки префикс или тип номер е на склад.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}От откриване до активиране
- Изберете държава, подразделение (където се изисква), район и тип номер чрез съответните географски операции.
- Прочетете цените за настройка, месечните цени и цените за използване на избрания номер, каналите, включените количества и изискванията за регистрация.
- Подайте необходимите документи на крайния потребител и проследявайте статуса им. Номерът може да остане в изчакване до одобрение.
- Поръчайте веднъж с точния избор на инвентар и цена. Ако отговорът е несигурен, проверете инвентара си, преди да подадете нова поръчка.
- Конфигурирайте независимо маршрутизирането на гласови повиквания и доставката на съобщения, след което тествайте целия предвиден маршрут.
Обработка на грешки и повторни опити
- Грешка при автентикация или разрешения
- Проверете дали API идентификационните данни са активирани, дали е разрешена съответната услуга и какво е ограничението за IP адреса на източника. Бисквитката на сесия в портала не е идентификационни данни за интеграция.
- Недостатъчен кредит или липсващо одобрение
- Уредете баланса по акаунта, одобрението за изпращане или изискването за документи, преди да повторите операцията.
- Няма резултат
- Третирайте празната наличност или липсващото име на обаждащия се като обичаен резултат. Не приемайте, че синтактично валиден номер разполага с всяка услуга.
- Изтичане на времето в мрежата или срив на услугата
- За операциите за четене използвайте ограничен брой повторни опити със засилващо се закъснение. При покупка, изпращане или регистрация първо проверете състоянието на операцията; повторението на вече приета заявка може да дублира платено действие.
Поддръжката на идемпотентност зависи от всяко семейство API. API за спешни повиквания поддържа ключове за повторни опити; това не прави произволни заявки към v3 идемпотентни. Запазвайте времевите отпечатъци, върнатите идентификатори и отговорите с премахнати чувствителни данни за поддръжката.
Продължете със справочника на вашия акаунт
Справочникът след вход филтрира операциите според вашите права и активираните услуги. Използвайте точния му хост, типа удостоверяване, полетата на заявката и схемата на отговора. Конзолите могат да изпълняват реални операции, включително покупки и съобщения.