Отправка сообщений по каскаду в канал Viber
Для от правки сообщений в канал Viber по каскаду используется метод /api/cascade/schedule.
В этой статье описана отправка сообщений по каскаду с использование метода /api/cascade/schedule и объекта viberContent.
Подробную информацию о методе /api/cascade/schedule смотрите в статье:
Вызов метода
Чтобы отправить сообщение в канал Viber через каскад по методу /api/cascade/schedule, отправьте POST-запрос на URL-адрес https://app.edna.io/api/cascade/schedule.
Примеры запросов
Сообщение с текстом
{
"requestId": "test-001",
"cascadeId": 1,
"subscriberFilter": {
"address": "77771234567",
"type": "PHONE"
},
"startTime": "2021-01-21T08:00:00Z",
"content": {
"viberContent": {
"contentType": "TEXT",
"text": "Добрый день! Рады представить наш новый канал для общения с клиентами. Здесь вы можете задавать все интересующие вопросы."
}
}
}
Сообщение с изображением
{
"requestId": "test-001",
"cascadeId": 1,
"subscriberFilter": {
"address": "77771234567",
"type": "PHONE"
},
"startTime": "2021-01-21T08:00:00Z",
"content": {
"viberContent": {
"contentType": "IMAGE",
"attachment": {
"url": "https://www.gstatic.com/webp/gallery/1.jpg",
"name": "Lorem Ipsum"
}
}
}
}
Сообщение с документом
{
"requestId": "test-001",
"cascadeId": 1,
"subscriberFilter": {
"address": "77771234567",
"type": "PHONE"
},
"startTime": "2021-01-21T08:00:00Z",
"content": {
"viberContent": {
"contentType": "DOCUMENT",
"attachment": {
"url": "https://www.gstatic.com/webp/gallery/1.jpg",
"name": "Lorem Ipsum"
}
}
}
}
Сообщение с кнопкой и изображением
{
"requestId": "test-001",
"cascadeId": 1,
"subscriberFilter": {
"address": "77771234567",
"type": "PHONE"
},
"startTime": "2021-01-21T08:00:00Z",
"content": {
"viberContent": {
"caption": "Название кнопки",
"action": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
"text": "Текст сообщения",
"contentType": "BUTTON",
"attachment": {
"url": "https://www.gstatic.com/webp/gallery/1.jpg",
"name": "Lorem Ipsum"
}
}
}
}
Параметры viberContent
Подробную информацию об общих параметрах метода /api/cascade/schedule смотрите в статье:
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
contentType | string | Обязательный | Тип содержимого сообщения. Возможные значения указываются в верхнем регистре:
- TEXT — текстовое сообщение;
- IMAGE — изображение;
- DOCUMENT — документ, вложенный в сообщение;
- VIDEO — сообщение, содержащее видео;
- AUDIO — сообщение, содержащее звук;
- BUTTON — кнопка;
- LOCATION — сообщение с координатами, адресом и описанием места. Координаты преобразуются в снимок Google maps. |
footer | object | Необязательный | Подпись. Отоб ражается под сообщением приглушенным цветом текста. |
text | string | Необязательный | Текст сообщения. Оформление текста |
header | object | Необязательный | Заголовок сообщения. Можно выбрать один из следующих вариантов заголовка: текст, изображение, документ. Для текстового заголовка нужно указать сам текст заголовка, заголовок может содержать одну переменную. Сам заголовок отображается жирным текстом перед сообщением. Для мультимедиа заголовка можно указать ссылку на документ или изображение. |
attachment | object | Необязательный | Содержит информацию о вложении. |
attachment.url | string | Обязательный | Ссылка на вложение: изображение, файл, видео или аудио. |
attachment.name | string | Необязательный | Название изображения, файла, видео или аудио. Максимальная длина — 25 символов. |
location | object | Необязательный | Содержит информацию о местонахождении. |
location.longitude | string | Обязательный | Координаты (долгота). |
location.latitude | string | Обязательный | Координаты (широта). |
location.address | string | Необязательный | Адрес на карте. |
caption | string | Необязательный | Название кнопки. |
action | string | Необязательный | Ссылка для кнопки. |
Оформление текста
Правила экранирования кавычек в тексте
Знаки кавычек “ или ‘ должны быть отделены знаком \ в отправляемом сообщении.
Пример правильного оформления:
"text": "Мария! Ждем ва с на Мастер-класс \"Готовим вместе c Tefal\" 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(7172)100-00-00"
"text": "Мария! Ждем вас на Мастер-класс «Готовим вместе c Tefal» 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(7172)100-00-00"
Пример неправильного оформления:
"text": "Мария! Ждем вас на Мастер-класс "Готовим вместе с Tefal" 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(7172)100-00-00"
Типы вложений
Отправляемые вложения должны соответствовать следующим требованиям:
| Тип вложения | Поддерживаемый формат | Допустимый размер |
|---|---|---|
| document | Любой корректный MIME-тип. | 100 МБ |
| image | image/jpeg, image/png. | 5 МБ |
| audio | audio/aac, audio/mp4, audio/amr, audio/mpeg, audio/ogg. Кодек=opus (NWB) и ACC. | 16 МБ |
| video | video/mp4, video/3gpp. Поддерживается только формат MPEG 4 и 3GPP c кодеком H.264 (MPEG-4 Part 10) и AAC для аудио. | 16 МБ |
Формат ответа
{
"requestId": "string"
}
Пример ответа
{
"requestId": "test-001"
}
Параметры ответа
| Параметр | Тип данных | Описание |
|---|---|---|
requestId | string | Внутренний идентификатор исходящего сообщения. Был сгенерирован внешней системой клиента при отправке сообщения. |