/api/v1/sendBulkViber
Отправка сообщения(-ий) на множество списков, а также персональные сообщения в пакетном режиме
URL запроса
POST https://app.sms.by/api/v1/sendBulkViber
Если вам нужно отправить 1 сообщение на список номеров, тогда используйте параметр 'message_type': 'bulk', как в примере ниже, передавая массив номеров:
Особенностью отправки сообщения Viber является наличие трех вариантов: text, image или button.
Варианты заполнения приведены в образце api запроса.
Внимание!
Вариант image может быть использован только в рассылке с message_type = bulk.
В варианте button параметр button_link не должен превышать 150 символов.
Параметр image_url в вариантах button и image должен иметь ссылку на изображение, которое находится в открытом доступе.
Образец api запроса
'delivery_list': [ '375291111111', '375292222222', ]Если вам требуется отправлять каждое сообщение на отдельный номер телефона, то используйте 'message_type': 'personal', передавая каждый раз текст сообщения и номер телефона. Например:
'delivery_list': [
{
'phone': '375291111111',
'text': 'personal message 1'
},
{
'phone': '375292222222',
'text': 'personal message 2'
}
]Для планирования рассылки вы можете указывать время рассылки через параметр schedule_time, в формате YYYY-MM-DDTHH:mm:ssОсобенностью отправки сообщения Viber является наличие трех вариантов: text, image или button.
Варианты заполнения приведены в образце api запроса.
Внимание!
Вариант image может быть использован только в рассылке с message_type = bulk.
В варианте button параметр button_link не должен превышать 150 символов.
Параметр image_url в вариантах button и image должен иметь ссылку на изображение, которое находится в открытом доступе.
Образец api запроса
{
"token": "eyJpdiI6IjJzOFlFcXBmOUZEcGJlYzlzeFJValE9PSIsInZhbHV",
"callback_url": "http://example-site.com/webhook.php",
"messages": [
{
"alphaname_id": "444",
"name": "mailing list 1",
"message_type": "personal",
"schedule_time": "2024-10-30T22:56:00",
"content": {
"type": "button",
"image_url": "https://example-site.com/images/image.jpg",
"caption": "Push me"
},
"delivery_list": [
{
"phone": "375291111111",
"text": "personal message 1.1",
"button_link": "https://example-site.com/some_action/1"
},
{
"phone": "375292222222",
"text": "personal message 1.2",
"button_link": "https://example-site.com/some_action/2"
}
]
},
{
"alphaname_id": "444",
"name": "mailing list 2",
"message_type": "personal",
"schedule_time": "2024-10-30T22:56:00",
"content": {
"type": "text"
},
"delivery_list": [
{
"phone": "375291111111",
"text": "personal message 2.1"
},
{
"phone": "375292222222",
"text": "personal message 2.2"
}
]
},
{
"alphaname_id": "444",
"name": "mailing list 3",
"message_type": "bulk",
"schedule_time": "2024-10-30T22:56:00",
"content": {
"type": "button",
"image_url": "https://example-site.com/images/image.jpg",
"button_link": "https://example-site.com/some_action",
"caption": "Button",
"text": "message text 3"
},
"delivery_list": [
"375291111111",
"375292222222"
]
},
{
"alphaname_id": "444",
"name": "mailing list 4",
"message_type": "bulk",
"schedule_time": "2024-10-30T22:56:00",
"content": {
"type": "text",
"text": "message text 4"
},
"delivery_list": [
"375291111111",
"375292222222"
]
},
{
"alphaname_id": "444",
"name": "mailing list 5",
"message_type": "bulk",
"schedule_time": "2024-10-30T22:56:00",
"content": {
"type": "image",
"image_url": "https://example-site.com/images/image.jpg"
},
"delivery_list": [
"375291111111",
"375292222222"
]
}
]
}Параметры
| Параметр | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| token | query | string | Да | Ваш API ключ |
| callback_url | query | string | Нет | URL, на который (если параметр задан) будет выслан ответ по работе метода в асинхронном режиме |
| messages | query | array | Да | Массив сообщения (Образец объекта в описании запроса) |
Ответы
200 — Выполнено успешно
{
"uuid": "cc9c8043-8caf-11ef-b035-9e8f47954dec",
"success": "OK"
}