Каскадная отправка

Каскадной отправкой называется технология переотправки сообщения по различным каналам. Последовательность каналов задается последовательностью объектов сообщений в массиве cascade– первое сообщение формируется сразу, следующие сообщения последовательно формируются и отправляются в случае неполучения статуса "Доставлено" или "Прочитано" предыдущим сообщением в течение его времени жизни.
post
https://direct.i-dgtl.ru/api
/v1/message/cascade
Отправка каскадных сообщений
Рекомендуемое время ожидания ответа: 70 секунд.
Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.
Для использования личного домена в сокращенных ссылках необходимо обратиться в поддержку
Возможные варианты перечислений:
Параметр
Варианты
callbackEvents
​События для отправки callback​
cascade.channelType
SMS
VIBER
WHATSAPP
VK
TELEGRAM
FLASHCALL ⚠
 может быть только первым  каналом
TEXT_TO_SPEECH
VOICECODE
cascade.condition
​Условия формирования каскадных сообщений​
Параметры, переданные в корневом объекте, применяются к каждому сообщению каскада:
destination
tags
useLocalTime
localSendTime
localCompletionTime
hours
days
shortUrl
callbackUrl
callbackEvents
В объектах callback, отправляемых по каскадным сообщениям, присутствует идентификатор первого сообщения каскада и порядковый номер данного сообщения – cascade_message_uuid и cascade_step соответственно (описано в разделе Получение callback)
Содержимое SMS, FLASHCALL и VK-сообщений
Для каналов SMS, FLASHCALL и VK передается объект content следующего вида:
"content": {
  "text": "текст сообщения"
}
Параметр
Тип
Описание
content.text
string
required
Текст сообщения; строка в кодировке UTF-8 без Byte Order Mark
SMS:
строка от 1 до 5000 символов
VK:
строка от 1 до 2048 символов
FLASHCALL:
строка с числовым кодом длиной 4 символа
Содержимое VIBER-сообщения
Для канала VIBER формат и валидация объекта content описаны в разделе Отправка VIBER ​
Содержимое WHATSAPP-сообщения
Для канала WHATSAPP формат и валидация объекта content описаны в разделе Отправка WHATSAPP​
Содержимое TEXT_TO_SPEECH-сообщения
Для канала TEXT_TO_SPEECH формат и валидация объекта content описаны в разделе Отправка TEXT_TO_SPEECH​
Содержимое VOICECODE-сообщения
Для канала VOICECODE формат и валидация объекта content, а также допустимое значение senderName описаны в разделе Отправка VOICECODE​
Содержимое TELEGRAM-сообщения
Для канала TELEGRAM формат и валидация объекта content, а также допустимое значение senderName описаны в разделе Отправка TELEGRAM​
Пример запроса 1
Каскадная отправка по трем каналам следующего вида:
1.VK-сообщение отправляется первым в соответствии с переданными временны́ми параметрами
2.при отсутствии статуса "Прочитано" через 14400 секунд после отправки формируется VIBER-сообщение
3.VIBER-сообщение отправляется в соответствии с переданными временны́ми параметрами
4.при отсутствии статуса "Прочитано" через 10800 секунд после отправки формируется TELEGRAM-сообщение
5.при отсутствии статуса "Доставлено" через 600 секунд после отправки формируется SMS-сообщение
6.SMS-сообщение отправляется в соответствии с переданными временны́ми параметрами
JSON
cURL
POST https://direct.i-dgtl.ru/api/v1/message/cascade
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
[
  {
    "destination": "79999999999",
    "localSendTime": "2021-01-01 18:00:00",
    "localCompletionTime": "2021-01-05 18:00:00",
    "useLocalTime": true,
    "hours": [
      10,
      11,
      12,
      13,
      14,
      15,
      16,
      17,
      18,
      19,
      20
    ],
    "days": [
      6,
      7
    ],
    "shortUrl": true,
    "callbackUrl": "https://domain.com/callback",
    "callbackEvents": [
      "delivered",
      "price",
      "click"
    ],
    "cascade": [
      {
        "channelType": "VK",
        "senderName": "vk-sender",
        "content": {
          "text": "текст сообщения"
        },
        "condition": "not_read",
        "ttl": 14400
      },
      {
        "channelType": "VIBER",
        "senderName": "viber-sender",
        "content": {
          "contentType": "text",
          "text": "текст сообщения"
        },
        "condition": "not_read",
        "ttl": 10800
      },
      {
        "channelType": "TELEGRAM",
        "senderName": "i-digital_bot",
        "content": {
          "contentType": "text",
          "text": "текст сообщения"
        },
        "condition": "not_delivered",
        "ttl": 600
      },
      {
        "channelType": "SMS",
        "senderName": "sms-sender",
        "content": {
          "text": "текст сообщения"
        }
      }
    ]
  }
]
curl -X POST 'https://direct.i-dgtl.ru/api/v1/message/cascade' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-d '[{"destination":"79999999999","localSendTime":"2021-01-01 18:00:00","localCompletionTime":"2021-01-05 18:00:00","useLocalTime":true,"hours":[10,11,12,13,14,15,16,17,18,19,20],"days":[6,7],"shortUrl":true,"callbackUrl":"https://domain.com/callback","callbackEvents":["delivered","price","click"],"cascade":[{"channelType":"VK","senderName":"vk-sender","content":{"text":"текст сообщения"},"condition":"not_read","ttl":14400},{"channelType":"VIBER","senderName":"viber-sender","content":{"contentType":"text","text":"текст сообщения"},"condition":"not_read","ttl":10800},{"channelType":"TELEGRAM","senderName":"i-digital_bot","content":{"contentType":"text","text":"текст сообщения"},"condition":"not_delivered","ttl":600},{"channelType":"SMS","senderName":"sms-sender","content":{"text":"текст сообщения"}}]}]'
Пример запроса 2
Каскадная отправка кода подтверждения следующего вида:
1.VOICECODE-сообщение отправляется моментально
2.При отсутствии статуса "Доставлено" через 60 секунд после отправки, либо при получении статуса "Не доставлено" формируется и отправляется SMS-сообщение
JSON
cURL
POST https://direct.i-dgtl.ru/api/v1/message/cascade
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
[
  {
    "destination": "79999999999",
    "cascade": [
      {
        "channelType": "VOICECODE",
        "senderName": "voicecode",
        "content": {
          "contentType": "text",
          "text": "Код авторизации от i-digital: 3 2 6 1"
        },
        "condition": "not_delivered",
        "ttl": 60
      },
      {
        "channelType": "SMS",
        "senderName": "sms-sender",
        "content": {
          "text": "Ваш код для авторизации: 3261"
        }
      }
    ]
  }
]
curl -X POST 'https://direct.i-dgtl.ru/api/v1/message/cascade' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-d '[{"destination":"79999999999","cascade":[{"channelType":"VOICECODE","senderName":"voicecode","content":{"contentType":"text","text":"Ваш код: 3-2-6-1"},"condition":"not_delivered","ttl":60},{"channelType":"SMS","senderName":"sms-sender","content":{"text":"Ваш код для авторизации: 3261"}}]}]'

Одиночные сообщения - Previous

Отправка VK

Next - Одиночные сообщения

Получение callback

Last modified 1mo ago

Copy link

On this page

post

Отправка каскадных сообщений

Содержимое SMS, FLASHCALL и VK-сообщений

Содержимое VIBER-сообщения

Содержимое WHATSAPP-сообщения

Содержимое TEXT_TO_SPEECH-сообщения

Содержимое VOICECODE-сообщения

Содержимое TELEGRAM-сообщения

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

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