Каскадная рассылка#
Каскадная рассылка сообщений по умолчанию недоступна. Для подключения Партнёру необходимо обратиться к курирующему менеджеру.
Типы сообщений, допустимые в каскадной рассылке:
FlashingCall (Voice Code);
Push;
SMS;
Telegram;
Viber;
VK;
WhatsApp.
Последовательность типов сообщений при отправке может быть произвольной.
Причиной для переотправки сообщения является неполучение одного из статусов параметра state «Получено (DELIVERED)» или «Прочитано (READ)» в течение времени жизни сообщения (параметр ttl).
Примечание
Время жизни сообщения по умолчанию задается при настройке интеграционного клиента или передается в параметре ttl при отправке сообщения. Для каждого типа сообщения из цепочки каскада время жизни настраивается отдельно.
Для сообщения типа FlashingCall (Voice Code) возможна переотправка только по статусу «Получено (DELIVERED)».
Для получения отчётов по всем типам сообщений при отправке каскадной цепочки сообщений необходимо в параметре registeredDelivery указать значение «1».
Примеры каскадной рассылки#
1 {
2 "login":"ВАШ_ЛОГИН",
3 "password":"ВАШ_ПАРОЛЬ",
4 "id":"8770631",
5 "destAddr":"Номер_Абонента",
6 "message":{
7 "type":"PUSH",
8 "data":{
9 "title":"Заголовок Push-cсообщения",
10 "text":"Текст уведомления",
11 "serviceNumber":"НОМЕР_ОТПРАВИТЕЛЯ",
12 "ttl":2
13 }
14 },
15 "cascadeChainLink": {
16 "state": "DELIVERED",
17 "message": {
18 "type": "SMS",
19 "data": {
20 "text": "Текст доотправляемого SMS-сообщения",
21 "serviceNumber": "НОМЕР_ОТПРАВИТЕЛЯ_SMS",
22 "ttl": 2
23 }
24 }
25 }
26 }
1 {
2 "login": "ВАШ_ЛОГИН",
3 "password": "ВАШ_ПАРОЛЬ",
4 "id": "8770100",
5 "destAddr": "Номер_Абонента",
6 "message": {
7 "type": "VIBER",
8 "data": {
9 "instantContent": {
10 "type": "TEXT",
11 "data": {
12 "text": "VIBERMESS"
13 }
14 },
15 "serviceNumber": "НОМЕР_ОТПРАВИТЕЛЯ",
16 "ttl": 1
17 }
18 },
19 "cascadeChainLink": {
20 "state": "READ",
21 "message": {
22 "type": "SMS",
23 "data": {
24 "text": "SMSMESS",
25 "serviceNumber": "НОМЕР_ОТПРАВИТЕЛЯ",
26 "ttl": 1,
27 "ttlUnit": "HOURS"
28 }
29 }
30 }
31 }
1 {
2 "login": "ВАШ_ЛОГИН",
3 "password": "ВАШ_ПАРОЛЬ",
4 "destAddr": "НОМЕР_АБОНЕНТА",
5 "message": {
6 "type": "FLASHINGCALL",
7 "data": {
8 "text": "1234",
9 "ttl": 1
10 }
11 },
12 "cascadeChainLink": {
13 "state": "DELIVERED",
14 "message": {
15 "type": "SMS",
16 "data": {
17 "text": "Текст доотправляемого SMS-сообщения",
18 "serviceNumber": "НОМЕР_ОТПРАВИТЕЛЯ_SMS",
19 "ttl": 2
20 }
21 }
22 }
23 }
1 {
2 "login": "ВАШ_ЛОГИН",
3 "password": "ВАШ_ПАРОЛЬ",
4 "useTimeDiff": true,
5 "id": "87706112",
6 "scheduleInfo": {
7 "timeBegin": "09:00",
8 "timeEnd": "21:00",
9 "weekdaysSchedule": "12345",
10 "deadline": "2024-12-31T16:29:30+0300"
11 },
12 "destAddr": "НОМЕР_АБОНЕНТА",
13 "message": {
14 "type": "WHATSAPP",
15 "data": {
16 "instantContent": {
17 "type": "TEXT",
18 "data": {
19 "text": "Текст WhatsApp-сообщения"
20 }
21 },
22 "serviceNumber": "ИМЯ_ОТПРАВИТЕЛЯ",
23 "ttl": 120,
24 "ttlUnit": "SECONDS"
25 }
26 },
27 "cascadeChainLink": {
28 "state": "DELIVERED",
29 "message": {
30 "type": "SMS",
31 "data": {
32 "text": "Текст доотправляемого SMS-сообщения",
33 "serviceNumber": "НОМЕР_ОТПРАВИТЕЛЯ_SMS",
34 "ttl": 10
35 }
36 }
37 }
38 }
1 {
2 "login": "ВАШ_ЛОГИН",
3 "password": "ВАШ_ПАРОЛЬ",
4 "destAddr": "НОМЕР_АБОНЕНТА",
5 "useTimeDiff": true,
6 "id": "superId",
7 "scheduleInfo":
8 {
9 "timeBegin": "10:00",
10 "timeEnd": "12:00",
11 "weekdaysSchedule": "123"
12 },
13 "message":
14 {
15 "type": "TELEGRAM",
16 "data":
17 {
18 "text": "Hello, world!",
19 "link": "https://docs.rapporto.ru/",
20 "serviceNumber": "ИМЯ_ОТПРАВИТЕЛЯ",
21 "ttl": 3600,
22 "ttlUnit": "SECONDS"
23 }
24 },
25 "cascadeChainLink": {
26 "state": "DELIVERED",
27 "message": {
28 "type": "SMS",
29 "data": {
30 "text": "Hello, world! Follow link <https://docs.rapporto.ru>",
31 "serviceNumber": "ИМЯ_ОТПРАВИТЕЛЯ",
32 "ttl": 1,
33 "ttlUnit": "MINUTES"
34 }
35 }
36 }
37 }
1 {
2 "login": "ВАШ_ЛОГИН",
3 "password": "ВАШ_ПАРОЛЬ",
4 "useTimeDiff": false,
5 "id": "8770100",
6 "scheduleInfo": {
7 "timeBegin": "10:00",
8 "timeEnd": "21:00",
9 "weekdaysSchedule": "12345",
10 "deadline": "2029-12-31T16:29:30+0300"
11 },
12 "destAddr": "НОМЕР_ОТПРАВИТЕЛЯ",
13 "message": {
14 "type": "VK",
15 "data": {
16 "text": "VK",
17 "serviceNumber": "ВАШ_СЕРВИСНЫЙ_НОМЕР",
18 "ttl": 1
19 }
20 },
21 "cascadeChainLink": {
22 "state": "DELIVERED",
23 "message": {
24 "type": "VIBER",
25 "data": {
26 "instantContent": {
27 "type": "TEXT",
28 "data": {
29 "text": "VIBER"
30 }
31 },
32 "serviceNumber": "ВАШ_СЕРВИСНЫЙ_НОМЕР",
33 "ttl": 1
34 }
35 },
36 "nextLink": {
37 "state": "DELIVERED",
38 "message": {
39 "type": "FLASHINGCALL",
40 "data": {
41 "text": "Ваш код 2268",
42 "ttl": 1
43 }
44 },
45 "nextLink": {
46 "state": "DELIVERED",
47 "message": {
48 "type": "SMS",
49 "data": {
50 "text": "SMS",
51 "serviceNumber": "ВАШ_СЕРВИСНЫЙ_НОМЕР",
52 "ttl": 1
53 }
54 }
55 }
56 }
57 }
58 }
Параметры каскадной рассылки#
Для отправки цепочки сообщений разного типа в запросе требуется передавать дополнительный блок параметров CascadeChainLink.
Обязательные параметры выделены жирным шрифтом.
Параметр |
Тип данных |
Описание |
|---|---|---|
cascadeChainLink |
object |
Параметры каскадных сообщений. |
cascadeChainLink/state |
enum |
Статус, по которому производится доотправка сообщения. Возможные значения: DELIVERED (производить доотправку, если сообщение не доставлено в течение времени жизни сообщения); READ (производить доотправку, если сообщение не прочитано в течение времени жизни сообщения). |
cascadeChainLink/message |
object |
Параметры доотправляемого сообщения. Аналогично объекту message основного сообщения. |
cascadeChainLink/nextLink |
object |
Параметры следующего доотправляемого сообщения в цепочке. Аналогично объекту cascadeChainLink. |