Метод SendMessage
Примените метод SendMessage, чтобы отправлять:
- Сообщения в Telegram с кодом для входа
- SMS на номера с высокой активностью в сети оператора — инструкция
Точка подключения: Выполните 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 |
| number_lookup_sms_attributes | numberLookupSmsAttributes | атрибуты отправки сообщения в канал Умная проверка номеров (УПН) → SMS |
Channel
| Параметр | Тип | Канал |
|---|---|---|
| 4 | enum | Telegram Verify |
| 5 | enum | УПН → SMS |
telegramVerifyAttribute
| Параметр | Тип | Описание |
|---|---|---|
| destination | string | номер получателя от 9 до 15 символов в формате 79999999999 |
| code | string | код верификации от 4 до 8 символов (только цифры) |
numberLookupSmsAttributes
| Параметр | Тип | Описание |
|---|---|---|
| activity_score | string | порог активности в сети номера получателя от 0 до 1 (например, 0.5 или 0.6) |
| number | string | номер/имя отправителя SMS |
| destination | string | 11-значный мобильный номер получателя SMS в формате 79999999999 |
| text | string | текст SMS-сообщения от 1 до 1 600 символов |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| message_id | string | идентификатор сообщения |
| channel | Channel | канал отправки сообщения |
| activity_result | string | полученная оценка активности в сети номера получателя (только для "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"
}
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 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 | канал временно не поддерживается |
| 400 | Bad Request | activate the Telegram Verify service first in your Exolve application | услуга Telegram Verify отключена в этом приложении |
| 400 | Bad Request | activate the number lookup service first in your Exolve application | Услуга «Умная проверка номеров» отключена в этом приложении |
| 401 | Unauthorized | incorrect authorization token | неверный API-токен авторизации |
| 404 | Not Found | page not found | некорректно введен URL-адрес запроса |
| 404 | Not Found | no information on this number | нет данных об активности номера в сети — SMS не отправлено (для канала УПН → SMS) |