SendSMS
Метод SendSMS
Примените этот метод для отправки SMS сообщения c номера телефона или имени отправителя (альфа-имени). Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/messaging/v1/SendSMS
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
Имя | Тип | Описание |
---|---|---|
Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0 , где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
Параметр | Тип | Описание |
---|---|---|
number | string | номер отправителя / имя отправителя (альфа-имя) |
destination | string | номер получателя |
text | string | текст сообщения |
Выходные параметры
Параметр | Тип | Описание |
---|---|---|
message_id | string | уникальный идентификатор сообщения |
Возможные ошибки
Код | Статус | Пример сообщения | Описание |
---|---|---|---|
404 | Not Found | page not found | некорректно введен URL запроса |
401 | Unauthorized | authorization token is invalid | неправильно указан токен (API-ключ приложения) |
400 | Bad Request | unknown field | невалидный параметр |
400 | Bad Request | syntax error | синтаксическая ошибка |
400 | Bad Request | invalid value | невалидное значение в параметре |
400 | Bad Request | fail to get number info/number does not belong to the client | номер не принадлежит пользователю |
400 | Bad Request | exceeded the limit of segments sms (maximum 10) | превышено количество сегментов в сообщении |
400 | Bad Request | destination is not permitted for delivery | отправка сообщения с неактивированного аккаунта на неподтвержденный номер |
500 | Internal Server Error | incorrect customer status | нет доступа к отправке сообщений из-за статуса аккаунта пользователя (не активирован/заблокирован) |
Примеры
Входные параметры:
{
"number": "79677099159",
"destination": "79677090942",
"text": "Test message"
}
{
"number": "TestAlfaName",
"destination": "79677090942",
"text": "Test message"
}
Выходные параметры:
{
"message_id": "439166538239448536"
}