SendMessage

Метод SendMessage

Примените метод SendMessage, чтобы отправлять:

  1. Сообщения в Telegram с кодом для входа
  2. SMS на номера с высокой активностью в сети оператора — инструкция

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

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

Авторизация

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

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

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

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

ПараметрТипОписание
channelChannelканал отправки сообщения
telegram_verify_attributetelegramVerifyAttributeатрибуты отправки сообщения в канал Telegram Verify
number_lookup_sms_attributesnumberLookupSmsAttributesатрибуты отправки сообщения в канал Умная проверка номеров (УПН) → SMS

Channel

ПараметрТипКанал
4enumTelegram Verify
5enumУПН → SMS

telegramVerifyAttribute

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

numberLookupSmsAttributes

ПараметрТипОписание
activity_scorestringпорог активности в сети номера получателя от 0 до 1 (например, 0.5 или 0.6)
numberstringномер/имя отправителя SMS
destinationstring11-значный мобильный номер получателя SMS в формате 79999999999
textstringтекст SMS-сообщения от 1 до 1 600 символов

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

ПараметрТипОписание
message_idstringидентификатор сообщения
channelChannelканал отправки сообщения
activity_resultstringполученная оценка активности в сети номера получателя (только для "channel": 5)

Примеры

Входные параметры для канала Telegram Verify:

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

Выходные параметры для канала Telegram Verify:

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

Входные параметры для канала УПН → SMS (условие отправки: оценка активности номера получателя должна быть ≥ порога 0.5):

{
"channel": 5,
"number_lookup_sms_attributes": {
  "activity_score": "0.5",
  "number": "79991112233",
  "destination": "79139999999",
  "text": "Test message"
   }
}

Выходные параметры для канала УПН → SMS (оценка активности номера получателя (0.7) ниже порога (0.5) — SMS не отправлено):

{
  "message_id": "439166538239448536",
  "channel": 5,
  "activity_result": 0.7
}

Выходные параметры для канала УПН → SMS (оценка активности номера получателя (0.4) ниже порога (0.5) — SMS не отправлено):

{
  "activity_result": 0.4,
  "error": {
     "message": "message not sent: recipient activity result is below the configured activity score",
  "message_id": "439166538239448536"
  }
}

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

КодСтатусПример сообщенияОписание
400Bad Requestunknown fieldнеизвестное поле
400Bad Requestfailed to unmarshal request bodyневалидный JSON
400Bad Requestinvalid value for enum field channelнеправильное значение поля channel
400Bad Requestfailed to get request bodyне получилось прочитать тело запроса
400Bad Requestchannel type must be specifiedне получилось прочитать тело запроса
400Bad Requestincorrect attributes forатрибуты не соответствуют выбранному каналу
400Bad RequestTelegram Verify destination must be between 9 and 15 digitsнеправильный формат номера получателя в канале Telegram Verify
400Bad RequestTelegram Verify OTP code must be between 4 and 8 digitsнеправильный формат кода верификации в канале Telegram Verify
400Bad RequestThis channel is not supported nowканал временно не поддерживается
400Bad Requestactivate the Telegram Verify service first in your Exolve applicationуслуга Telegram Verify отключена в этом приложении
400Bad Requestactivate the number lookup service first in your Exolve applicationУслуга «Умная проверка номеров» отключена в этом приложении
401Unauthorizedincorrect authorization tokenневерный API-токен авторизации
404Not Foundpage not foundнекорректно введен URL-адрес запроса
404Not Foundno information on this numberнет данных об активности номера в сети — SMS не отправлено (для канала УПН → SMS)