Перейти к основному содержимому

POST /api/message

Общий метод для отправки любых типов сообщений.

Параметры запроса

Полный URL запроса

https://cp.redsms.ru/api/message

Параметры URL

fields

Параметр является необязательным, значение по умолчанию uuid,status,status_time,to.

Позволяет явно указать какие поля объекта сообщения необходимо вернуть в теле успешного ответа.

В значении необходимо указать необходимые поля, разделённые запятой ,. Примеры значений:

  • ?fields=uuid,status – в ответе будут только поля UUID и статуса сообщения;
  • ?fields=uuid,status,to,parts – в ответе будут поля UUID, статус, номер телефона получателя и количество частей.

Тело запроса

ПолеТипОписание
routestringОдин или несколько типов сообщения, разделённых запятой ,
Необязательный параметр, значение по умолчанию – sms
fromstringИмя отправителя, от которого будет отправлено сообщение
Параметр не обязателен для сообщений facll, hlr, ping и pushok
В случае, если параметр не указан для сообщений типа sms или viber, будет использовано соответствующее имя отправителя по умолчанию, указанное в настройках в личном кабинете
textstringТекст сообщения
Не обязателен для сообщений hlr и ping
tostringНомер телефона получателя
Может содержать несколько получателей, разделенных символом, указанным в параметре phoneDelimeter
phoneDelimeterstringРазделитель номеров телефонов для массовой отправки сообщений
Значение по умолчанию – ,
textDelimeterstringРазделитель номеров телефонов для массовой отправки уникальных сообщений
Значение по умолчанию – :
startTimetimestampВремя отправки отложенного сообщения
Не может быть позднее 7 календарных дней от текущего времени
validityintegerМаксимальное время ожидания статуса сообщения в секундах
Минимальное значение – 60 (600 для SMS), максимальное – 86400 (24 часа)
dlrUrlstringURL Webhook для получения обновлений статуса по созданным сообщениям
viber_imageUrlstringURL изображения для сообщения Viber
viber_btnTextstringТекст, отображаемый на кнопке в сообщении Viber
viber_btnUrlstringURL ссылки для кнопки в сообщении Viber
viber_fromstringИмя отправителя Viber
Если не указано, будет использовано имя отправителя по умолчанию, указанное в настройках в личном кабинете
viber_textstringТекст сообщения Viber
Позволяет указать разный текст в каскадном сообщении
viber_validityintegerМаксимальное время ожидания статуса сообщения Viber, аналогично validity
viber_tostringНомер телефона получателя сообщения Viber
Позволяет отправить каскадное сообщение разным получателям
vk_fromstringИмя отправителя VK в каскадном сообщении
vk_textstringТекст сообщения VK
Позволяет указать разный текст в каскадном сообщении
vk_validityintegerМаксимальное время ожидания статуса сообщения VK, аналогично validity
vk_tostringНомер телефона получается сообщения VK
Позволяет отправить каскадное сообщение разным получателям
voice_voiceenumОдин из вариантов голоса для синтеза речи в сообщении Voice
Возможные значения: alyss, jane, oksana, omazh, zahar, ermil, erkanyavas
voice_speedfloatСкорость воспроизведения аудиодорожки в сообщении Voice
Допустимо значение от 0.1 до 3.0
voice_emotionenumОдин из вариантов интонации для синтеза речи в сообщении Voice
Возможные значения: neutral, good, evil
Поддерживается только для русского языка и голосов jane и omazh
voice_fromstringИмя отправителя для сообщения Voice
Обязательно для заполнения в каскадном сообщении, содержащем Voice
voice_textstringТекст сообщения Voice
Позволяет указать разный текст в каскадном сообщении
voice_validityintegerМаксимальное время ожидания статуса сообщения Voice, аналогично validity
voice_tostringНомер телефона получателя сообщения Voice
Позволяет отправить каскадное сообщение разным получателям
sms_fromstringИмя отправителя для SMS в каскадном сообщении
sms_textstringТекст сообщения SMS
Позволяет указать разный текст в каскадном сообщении
sms_validityintegerМаксимальное время ожидания статуса SMS, аналогично validity
sms_tostringНомер телефона получателя SMS
Позволяет отправить каскадное сообщение разным получателям
hlr_validityintegerМаксимальное время ожидания статуса HLR, аналогично validity
ping_validityintegerМаксимальное время ожидания статуса PING, аналогично validity

Структура ответа

Пример тела ответа успешного создания одного сообщения:

{
"items": [
{
"uuid": "c7cc074a-c356-11ee-b2e1-0242c0a86496",
"status": "created",
"status_time": 1707048799,
"to": "+79018027654"
}
],
"errors": [],
"count": 1,
"success": true
}

Поле items содержит массив объектов сообщения с полями, указанными в параметре fields.

Пример тела ответа с ошибкой:

{
"error_message": "error while creating messages",
"errors": [
{
"to": "+1234567890",
"message": "bad number rejected"
}
],
"success": false
}

Пример тела ответа на запрос с двумя корректными сообщениями и одним некорректным:

{
"items": [
{
"uuid": "16171818-c35d-11ee-9f36-0242c0a86496",
"status": "created",
"status_time": 1707051506,
"to": "+79019998876"
},
{
"uuid": "1624e9ac-c35d-11ee-90d6-0242c0a86496",
"status": "created",
"status_time": 1707051506,
"to": "+79999999987"
}
],
"errors": [
{
"to": "+1234567890",
"message": "bad number rejected"
}
],
"count": 2,
"success": true
}

Возможные коды ответа

КодОписание
200Успешно создано хотя бы одно сообщение
400Не передано ни одного корректного сообщения, либо сработало одно из ограничений
401Недействительная авторизация – проверьте значения заголовков и наличие ограничений белого списка IP в личном кабинете
404Некорректный URL запроса – убедитесь, что путь запроса не заканчивается на /
420Недостаточно средств для отправки сообщения
Только при включённой опции «Не создавать сообщения при недостаточном количестве средств»
500Непредвиденная ошибка сервера