Документация на REST API
REST API за SMS и MMS
Изпращайте одобрени приложни съобщения и обработвайте приемането, събитията за доставка, сегментирането и таксите.
Изберете 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 интеграция.
Подгответе SMS заявка
Използвайте одобрен номер за изпращане с активиран SMS, собственост на акаунта, получател, който е дал съгласие за съобщението, и необходимата Brand/Campaign или toll-free верификация. Примерът по-долу изпраща реално съобщение, когато е попълнен с работещи идентификационни данни и номера; той не е sandbox среда.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"Заменете заместителите за подател и получател с международни цифри, включително кода на държавата. За MMS задайте в media поддържан, публично достъпен URL адрес на медията и първо проверете допустимостта за MMS и цените.
Приемането не е доставка
Проверете както външния статус на приложението, така и върнатия резултат за съобщението. Запишете идентификатора на съобщението, предоставен от услугата, и следете статуса на доставка и събитията от webhook. Успешното подаване не може да докаже, че устройството на получателя е получило съобщението.
SMS се таксува на сегмент. Кодирането и дължината на съобщението могат да доведат до няколко сегмента; таксите за медия и тези, свързани с оператори, може да се различават от SMS. Прочетете актуалната продажна цена на акаунта, преди да изпратите. Никога не повтаряйте сляпо изпращане, при което времето е изтекло: първо проверете записания му резултат.
Обработка на грешки и повторни опити
- Грешка при автентикация или разрешения
- Проверете дали API идентификационните данни са активирани, дали е разрешена съответната услуга и какво е ограничението за IP адреса на източника. Бисквитката на сесия в портала не е идентификационни данни за интеграция.
- Недостатъчен кредит или липсващо одобрение
- Уредете баланса по акаунта, одобрението за изпращане или изискването за документи, преди да повторите операцията.
- Няма резултат
- Третирайте празната наличност или липсващото име на обаждащия се като обичаен резултат. Не приемайте, че синтактично валиден номер разполага с всяка услуга.
- Изтичане на времето в мрежата или срив на услугата
- За операциите за четене използвайте ограничен брой повторни опити със засилващо се закъснение. При покупка, изпращане или регистрация първо проверете състоянието на операцията; повторението на вече приета заявка може да дублира платено действие.
Поддръжката на идемпотентност зависи от всяко семейство API. API за спешни повиквания поддържа ключове за повторни опити; това не прави произволни заявки към v3 идемпотентни. Запазвайте времевите отпечатъци, върнатите идентификатори и отговорите с премахнати чувствителни данни за поддръжката.
Продължете със справочника на вашия акаунт
Справочникът след вход филтрира операциите според вашите права и активираните услуги. Използвайте точния му хост, типа удостоверяване, полетата на заявката и схемата на отговора. Конзолите могат да изпълняват реални операции, включително покупки и съобщения.