Отправка сообщений в канал Viber
Обновлено: 27 октября 2026
Для отправки сообщений в канал Viber используется метод api/v1/out-messages/viber.
Вызов метода
Чтобы отправить сообщение в канал Viber по методу api/v1/out-messages/viber, отправьте POST-запрос на URL-адрес https://app.edna.by/api/v1/out-messages/viber.
Примеры запросов
Сообщение с текстом
{
"sender": "viber_test",
"phone": "+375299000000",
"content": {
"type": "TEXT",
"text": "Добрый день! Рады представить наш новый метод для отправки сообщений в Viber"
}
}
Сообщение с документом
{
"sender": "viber_test",
"phone": "+375299000000",
"content": {
"type": "DOCUMENT",
"name": "order",
"url": "https://example.com/order.pdf"
}
}
Сообщение с изображением
{
"sender": "viber_test",
"phone": "+375299000000",
"content": {
"type": "IMAGE",
"url": "https://example.com/funny.jpg"
}
}
Сообщение с текстом, изображением и кнопкой-ссылкой
{
"sender": "viber_test",
"phone": "+375299000000",
"content": {
"type": "CARD",
"text": "Добрый день! Узнайте все возможности нашего приложения",
"button": {
"caption": "Узнать возможности",
"action": "https://example.com"
},
"imageUrl": "https://example.com/funny.jpg"
}
}
Параметры запроса
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
outMessageId | string | Необязательный | Внутренний идентификатор исходящего сообщения. Генерируется внешней системой клиента или edna Pulse при отправке сообщения. Максимальная длина строки — 256 символов. |
sender | string | Обязательный | Название канала.
Чтобы узнать название канала, используйте метод API для получения списка каналов — параметр subject.
Получение списка каналов |
phone | string | Обязательный | Адрес получателя — номер телефона в соответствии с форматом стандарта E.164.
Паттерн стандарта: ^+[1-9]\d{1,14}$.
Чтобы узнать адрес получателя, используйте метод API для запроса данных получателей — параметр addresses.address.
Запрос данных получателей |
content | object | Обязательный | Объект с информацией о содержимом сообщения. |
content.type | string | Обязательный | Тип содержимого сообщения.
Возможные значения: - TEXT — текстовое сообщение;
- IMAGE — изображение;
- DOCUMENT — документ;
- CARD — интерактивное сообщение, которое может включать текст, изображение и кнопку-ссылку. |
content.text | string | Обязательный, если content.type = TEXT или CARD | Текст сообщения. Может содержать эмодзи.
Для content.type = TEXT максимальная длина — 1000 символов.
Для content.type = CARD максимальная длина — 256 символов. |
content.url | string | Обязательный, если content.type = IMAGE или DOCUMENT | Общедоступный URL-адрес вложения — изображения или документа. Максимальная длина — 1000 символов.
Поддерживается только протокол HTTPS. URL-адрес вложения должен содержать расширение передаваемого файла. Поддерживаются следующие расширения: - Для content.type = IMAGE — .jpg, .jpeg, .png, .bmp, .gif, .svg, .webp.
- Для content.type = DOCUMENT — .doc, .docx, .pdf, .xls, .xlsx, .xlsm, .csv, .txt, .info, .rtf, .dot, .dotx, .odt, .odf, .fodt, .xps, .pdax, .eps, .ods, .fods, .xltx. |
content.name | string | Необязательный | Имя файла — изображения или документа. Не отображается на устройстве получателя.
Максимальная длина — 25 символов. |
content.button | object | Необязательный | Объект с информацией о кнопке-ссылке.
Если выбран content.type = CARD, то в одном сообщении поддерживается только одна кнопка-ссылка. |
content.button.caption | string | Необязательный | Текст кнопки.
Максимальная длина — 30 символов. |
content.button.action | string | Необязательный | Общедоступный URL-адрес внешнего ресурса, на который выполняется переход по нажатию кнопки-ссылки.
Максимальная длина — 1000 символа. Поддерживается только протокол HTTPS. |
content.imageUrl | string | Необязательный | Общедоступный URL-адрес вложения — изображения. Только для content.type = CARD. Максимальная длина — 1000 символов.
Поддерживается только протокол HTTPS. URL-адрес вложения должен содержать расширение передаваемого файла. Поддерживаются следующие расширения: .jpg, .jpeg, .png, .bmp, .gif, .svg, .webp. |
Формат ответа
{
"outMessageId": "string",
"phone": "string"
}
Пример ответа
{
"outMessageId": "0198adb2-74ee-7583-894b-fd2aa8fff639",
"phone": "+375299000000"
}
Параметры ответа
| Параметр | Тип данных | Описание |
|---|---|---|
outMessageId | string | Внутренний идентификатор исходящего сообщения. Был сгенерирован внешней системой клиента или edna Pulse при отправке сообщения. |
phone | string | Адрес получателя — номер телефона в соответствии с форматом стандарта E.164.
Паттерн стандарта: ^+[1-9]\d{1,14}$.
|