Отправка WHATSAPP
Для получения возможности отправки WHATSAPP-сообщений необходимо заполнить анкету, после чего будет зарегистрировано имя отправителя и шаблон для отправки сообщений.
Получение WHATSAPP-шаблонов и преобразование в сообщения описано здесь.
Отправка сообщений происходит в режиме чата:
  • если чат инициируется клиентом, первое сообщение должно соответствовать зарегистрированному шаблону. После каждого ответа абонента открывается 24-часовое окно для отправки сообщений с произвольным содержанием. Если абонент не ответил, клиент может отправлять сообщения пользователю вне рамок 24-часового окна с использованием заранее зарегистрированных шаблонов сообщений;
  • если чат инициируется абонентом, в течение 24-часового окна клиент может отправлять сообщения с произвольным содержанием.
post
https://direct.i-dgtl.ru/api
/v1/message
Отправка WHATSAPP-сообщений
Рекомендуемое время ожидания ответа: 70 секунд. Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.
Для использования личного домена в сокращенных ссылках необходимо обратиться в поддержку
Возможные варианты перечислений:
Параметр
Варианты

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

Текстовое WHATSAPP-сообщение, помимо текста, может содержать заголовок, подпись и кнопки.
Для отправки текстового WHATSAPP-сообщения используется следующий объект content:
{
"contentType": "text",
"text": "текст whatsapp-сообщения",
"header": {
"text": "Заголовок сообщения"
},
"footer": {
"text": "Подпись сообщения"
},
"buttons": [
{
"text": "текст кнопки",
"url": "https://i-dgtl.ru"
},
{
"text": "текст второй кнопки",
"phone": "78124269988"
}
]
}
Параметр
Тип
Описание
contentType
string
required
Тип контента (text)
text
string
required
Текст сообщения; строка в кодировке UTF-8 без Byte Order Mark
От 1 до 1000 символов
header
object optional
Заголовок сообщения
header.text
string optonal
Текст для заголовка От 1 до 60 символов
header.documentUrl
string optional
Ссылка на документ для заголовка
header.documentName
string optional
Название документа для заголовка; может присутствовать только при наличии documentUrl
header.imageUrl
string optional
Ссылка на изображение для заголовка
footer
object optional
Подпись сообщения
footer.text
string optional
Текст для подписи; от 1 до 60 символов
buttons
array (objects) optional
Массив с объектами кнопок
buttons.text
string optonal
Текст кнопки; от 1 до 20 символов
buttons.url
string optional
Ссылка, на которую происходит переход при нажатии на кнопку; от 1 до 1000 символов; должна начинаться с http
buttons.phone
string optional
Телефонный номер, на который предлагается сделать вызов при нажатии на кнопку; от 1 до 1000 символов
buttons.payload
string optional
Скрытый текст, который будет передан во входящем сообщении, если пользователь нажмет на кнопку; от 1 до 1000 символов
в объекте header допускается использовать только одно из:
  • text
  • documentUrl и documentName
  • imageUrl

Кнопки в сообщениях

  • в массиве buttons допускается от 1 до 3 объектов
  • в каждом объекте обязателен text
  • существует два типа кнопок:
    • кнопка с ссылкой: содержит text и url или text и phone
    • кнопка с текстом: содержит text и payload
    • передача payload вместе с url или phone не допускается
  • в одном сообщении допускается передача кнопок только одного типа
  • в сообщении допускается только одна кнопка с параметром url
  • в сообщении допускается только одна кнопка с параметром phone
  • при передаче кнопок с текстом допускается не более трех объектов в массиве
  • при передаче кнопок с ссылкой допускается не более двух объектов в массиве
  • наличие кнопок в сообщении не влияет на возможность наличия заголовка и подписи

Примеры объектов

Текст
С заголовком
С заголовком и подписью
С текстовыми кнопками
С кнопками и ссылками
{
"contentType": "text",
"text": "текст сообщения"
}
{
"contentType": "text",
"text": "Текст сообщения",
"header": {
"documentUrl": "https://example.com/document.pdf",
"documentName": "document.pdf"
}
}
{
"contentType": "text",
"text": "Текст сообщения",
"header": {
"imageUrl": "https://example.com/image.png"
},
"footer": {
"text": "Подпись сообщения"
}
}
{
"contentType": "text",
"text": "Текст сообщения",
"buttons": [
{
"text": "текст кнопки 1",
"payload": "id=1"
},
{
"text": "текст кнопки 2",
"payload": "id=2"
}
]
}
{
"contentType": "text",
"text": "Текст сообщения",
"buttons": [
{
"text": "текст кнопки 1",
"url": "https://i-dgtl.ru/"
},
{
"text": "текст кнопки 2",
"phone": "78124269988"
}
]
}

Сообщение с изображением

Для отправки WHATSAPP-сообщения с изображением используется следующий объект content:
{
"contentType": "image",
"imageUrl": "https://image.png",
"imageName": "Изображение",
"header": {
"text": "Заголовок сообщения"
},
"footer": {
"text": "Подпись сообщения"
},
"buttons": [
{
"text": "текст кнопки",
"url": "https://i-dgtl.ru/"
},
{
"text": "текст второй кнопки",
"phone": "78124269988"
}
]
}
Параметр
Тип
Описание
contentType
string
required
Тип контента (image)
imageUrl
string
required
Ссылка на изображение
imageName
string required
Название изображения
Заголовок, подпись и кнопки валидируются по тем же правилам, как и для текстового сообщения

Сообщение с документом

Для отправки WHATSAPP-сообщения с документом используется следующий объект content:
{
"contentType": "document",
"documentUrl": "https://document.pdf",
"documentName": "Документ",
"header": {
"text": "Заголовок сообщения"
},
"footer": {
"text": "Подпись сообщения"
},
"buttons": [
{
"text": "текст кнопки",
"url": "https://i-dgtl.ru/"
},
{
"text": "текст второй кнопки",
"phone": "78124269988"
}
]
}
Параметр
Тип
Описание
contentType
string
required
Тип контента (document)
documentUrl
string
required
Ссылка на документ
documentName
string required
Название документа
Заголовок, подпись и кнопки валидируются по тем же правилам, как и для текстового сообщения

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

JSON
cURL
POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
[
{
"senderName": "SENDER",
"channelType": "WHATSAPP",
"content": {
"contentType": "text",
"text": "Текст сообщения",
"header": {
"imageUrl": "https://example.com/image.png"
},
"footer": {
"text": "Подпись сообщения"
},
"buttons": [
{
"text": "текст кнопки",
"url": "https://i-dgtl.ru/"
},
{
"text": "текст второй кнопки",
"phone": "78124269988"
}
]
},
"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"
]
}
]
curl -X POST 'https://direct.i-dgtl.ru/api/v1/message' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-d '[{"senderName":"SENDER","channelType":"WHATSAPP","content":{"contentType":"text","text":"Текст сообщения","header":{"imageUrl":"https://example.com/image.png"},"footer":{"text":"Подпись сообщения"},"buttons":[{"text":"текст кнопки","url":"https://i-dgtl.ru/"},{"text":"текст второй кнопки","phone":"78124269988"}]},"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"]}]'
Copy link
On this page
post
Отправка WHATSAPP-сообщений
Текстовое сообщение
Заголовок в сообщениях
Кнопки в сообщениях
Примеры объектов
Сообщение с изображением
Сообщение с документом
Пример запроса