Отправка VIBER

Отправка VIBER-сообщений

POST https://direct.i-dgtl.ru/api/v1/message

Метод позволяет отправлять массив одиночных сообщений (от 1 до 1000)

Headers

Name	Type	Description
Authorization*	string	Basic {TOKEN_1}
Content-Type*	string	application/json

Request Body

Name	Type	Description
channelType*	string	Канал отправки (VIBER)
senderName*	string	Имя отправителя. Допускаются VIBER-имена в статусе "Одобрено"
destination*	string	Номер абонента
content*	object	Контент сообщения. Ниже описаны возможные варианты содержимого.
tags	array	Теги сообщения (массив строк). Каждый тег должен соответствовать выражению ^\w+$ (допускаются буквы в любом регистре, цифры и нижнее подчеркивание "_")
useLocalTime	boolean	Флаг, отвечающий за таймзону, в которой будет отправлено сообщение: true – отправка в таймзоне абонента false – отправка по МСК По умолчанию true
localSendTime	string	Нижняя граница допустимого времени отправки сообщения (с учетом значенияuseLocalTime) Дата в формате YYYY-MM-DD hh:mm:ss в диапазоне от (текущее время в UTC - 12 часов) до (текущее время в UTC + 7 дней) По умолчанию сообщение будет отправлено сразу
localCompletionTime	string	Верхняя граница допустимого времени отправки сообщения (с учетом useLocalTime) в диапазоне от localSendTime до (текущее время в UTC + 70 дней)
ttl	integer	Время жизни сообщения в секундах. По истечении ttl сообщению устанавливается финальный статус. 60 ≤ ttl ≤ 86400
hours	array	Допустимые часы отправки (массив чисел). В массиве могут быть переданы целые числа от 0 до 23, каждое из которых соответствует разрешенному для отправки интервалу с учетом useLocalTime; значения должны быть уникальны.
days	array	Допустимые дни отправки (массив чисел). В массиве могут быть переданы целые числа от 1 (пн) до 7 (вс), каждое из которых соответствует разрешенному для отправки дню недели; значения должны быть уникальны.
shortUrl	boolean	Флаг, отвечающий за сокращение ссылок в сообщении: true - ссылки в тексте сообщения будут сокращены По умолчанию false
callbackUrl	string	Адрес для отправки callback
callbackEvents	array	События, по которым будут отправлены callback (массив строк). При наличии callbackUrl и отсутствии callbackEvents в запросе, будет отправлен callback по событию delivered.
externalMessageId	string	Внутренний id сообщения в вашей системе. До 100 символов.

200

В случае успешного запроса возвращается ответ, в котором перечислены идентификаторы сообщений и коды результата. При значении errors = false гарантируется, что все переданные сообщения успешно созданы.

{
  "errors": false,
  "items": [
    {
      "messageUuid": "063474ec-a34f-4558-90c5-984395000004",
      "code": 201
    },
    {
      "messageUuid": "063564ec-a34f-4558-90c5-984395000005",
      "code": 201
    }
  ]
}

401

403

422

402

Рекомендуемое время ожидания ответа: 70 секунд. Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.

Для использования личного домена в сокращенных ссылках необходимо обратиться в поддержку

Возможные варианты перечислений:

Параметр	Варианты
callbackEvents	События для отправки callback

Текстовое сообщение

Для отправки текстового VIBER-сообщения используется следующий объект content:

{
  "contentType": "text",
  "text": "текст viber-сообщения"
}

Параметр	Тип	Описание
contentType	string required	Тип контента (text)
text	string required	Текст сообщения; строка в кодировке UTF-8 без Byte Order Mark От 1 до 1000 символов

Сообщение с графическим вложением

Для отправки VIBER-сообщения с картинкой используется следующий объект content:

{
  "contentType": "image",
  "imageUrl": "<ссылка на изображение>"
}

Параметр	Тип	Описание
contentType	string required	Тип контента (image)
imageUrl	string required	Ссылка на изображение

Сообщение с интерактивными элементами

Для отправки VIBER-сообщения с интерактивными элементами (кнопкой и опционально изображением) используется следующий объект content:

{
  "contentType": "button",
  "text": "текст viber-сообщения",
  "caption": "текст кнопки",
  "action": "<ссылка на кнопке>",
  "imageUrl": "<ссылка на изображение>"
}

Параметр	Тип	Описание
contentType	string required	Тип контента (button)
text	string required	Текст сообщения; строка в кодировке UTF-8 без Byte Order Mark От 1 до 1000 символов
caption	string required	Текст для кнопки От 1 до 30 символов
action	string required	Ссылка для кнопки
imageUrl	string optional	Ссылка на изображение

Пример запроса с минимальным набором параметров

В примере ниже указан минимально необходимый набор параметров для отправки VIBER-сообщения.

JSON

POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvc...
Content-Type: application/json
[
  {
    "senderName": "SENDER",
    "channelType": "VIBER",
    "destination": "7818242882",
    "content": {
      "contentType": "text",
      "text": "Текст VIBER-сообщения"
    }
  }
]

cURL

Пример запроса со всеми параметрами

В примере присутствуют объекты VIBER-сообщений со всеми возможными типами содержимого

JSON

POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvc...
Content-Type: application/json
[
  {
    "senderName": "SENDER",
    "channelType": "VIBER",
    "content": {
      "contentType": "text",
      "text": "текст сообщения https://domain.com"
    },
    "destination": "7818242882",
    "localSendTime": "2020-06-15 18:00:00",
    "localCompletionTime": "2020-06-16 21:00:00",
    "shortUrl": true,
    "callbackUrl": "https://company.com/callback",
    "callbackEvents": [
      "delivered",
      "read",
      "click"
    ],
    "useLocalTime": true,
    "ttl": 43200,
    "hours": [
      12,
      13,
      14
    ],
    "days": [
      1,
      2
    ],
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  {
    "senderName": "SENDER",
    "channelType": "VIBER",
    "destination": "7818242882",
    "callbackUrl": "https://company.com/callback",
    "callbackEvents": [
      "delivered",
      "read"
    ],
    "content": {
      "contentType": "button",
      "text": "текст сообщения",
      "caption": "текст кнопки",
      "action": "<ссылка на кнопке>",
      "imageUrl": "<ссылка на изображение>"
    },
    "localSendTime": "2020-06-15 18:00:00",
    "localCompletionTime": "2020-06-16 21:00:00",
    "useLocalTime": true,
    "ttl": 43200,
    "hours": [
      12,
      13,
      14
    ],
    "days": [
      1,
      2
    ],
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  {
    "senderName": "SENDER",
    "channelType": "VIBER",
    "callbackUrl": "https://company.com/callback",
    "callbackEvents": [
      "delivered",
      "read"
    ],
    "destination": "7818242882",
    "content": {
      "contentType": "image",
      "imageUrl": "<ссылка на изображение>"
    },
    "localSendTime": "2020-06-15 18:00:00",
    "localCompletionTime": "2020-06-16 21:00:00",
    "useLocalTime": true,
    "ttl": 43200,
    "externalMessageId": "10898",
    "hours": [
      12,
      13,
      14
    ],
    "days": [
      1,
      2
    ],
    "tags": [
      "tag1",
      "tag2"
    ]
  }
]

cURL