SendMessage

Метод SendMessage

Примените метод SendMessage для отправки сообщений в различные каналы связи. Пока отправить сообщение можно только в канал Telegram Verify, другие каналы будут доступны позднее.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/messaging/v1/SendMessage

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Параметр Тип Описание
channel Channel канал отправки сообщения
telegram_verify_attribute telegramVerifyAttribute атрибуты отправки сообщения в канал Telegram Verify

Channel

Параметр Тип Канал
4 enum Telegram Verify

telegramVerifyAttribute

Параметр Тип Описание
destination string номер телефона получателя от 9 до 15 символов в формате 79999999999
code string код верификации от 4 до 8 символов (только цифры)

Выходные параметры

Параметр Тип Описание
message_id string идентификатор сообщения
channel Channel канал отправки сообщения

Примеры

Входные параметры:

{
 "channel": 4,
 "telegram_verify_attributes": {
   "destination": "79001234567",
   "code": "1234"
 }
}

Выходные параметры:

{
   "message_id": "439166538239448536",
   "channel": 4
}

Возможные ошибки

Код Статус Пример сообщения Описание
400 Bad Request unknown field неизвестное поле
400 Bad Request failed to unmarshal request body невалидный JSON
400 Bad Request invalid value for enum field channel неправильное значение поля channel
400 Bad Request failed to get request body не получилось прочитать тело запроса
400 Bad Request channel type must be specified не получилось прочитать тело запроса
400 Bad Request incorrect attributes for атрибуты не соответствуют выбранному каналу
400 Bad Request Telegram Verify destination must be between 9 and 15 digits неправильный формат номера получателя в канале Telegram Verify
400 Bad Request Telegram Verify OTP code must be between 4 and 8 digits неправильный формат кода верификации в канале Telegram Verify
400 Bad Request This channel is not supported now канал временно не поддерживается
401 Unauthorized incorrect authorization token неверный api-токен авторизации
403 Forbidden Telegram Verify service is not active услуга Telegram Verify не подключена в этом приложении
404 Not Found page not found некорректно введен URL-адрес запроса

Содержание статьи