Omnichannel webhooks
Стаття надає інформацію про різні типи автоматичних повідомлень, що повʼязані з функціоналом омніканальності, перелік їх параметрів та приклади у JSON-форматі.
sms_sent
SMS відправлено.
Якщо ви отримали лише автоматичне повідомлення типу "sms_sent" – це означає, що SMS було успішно відправлено. Якщо після нього ви отримали ще й сповіщення "sms_lost" – це означатиме, що користувачу не надійшла SMS.
event (string)
client_user_id (string)
project_id (int)
category_id (int)
template_id (int)
sms_id (int)
ts (int)
omnichannel(int)
channel (string)
{
"0": {
"event": "sms_sent",
"client_user_id": "test123",
"project_id": 99,
"category_id": 1,
"template_id": 15,
"sms_id": 1233,
"ts": 1549382627,
"omnichannel": 1,
"channel" : "sms"
}
}
}
- ts – час відправки автоматичного повідомлення Webhook у форматі unix timestamp;
- omnichannel – цей параметр доданий для розділення автоматичних повідомлень, що стосуються відправки електронних листів та функціоналу омніканальності. За замовчуванням, має значення "1";
- category_id – категорія відправки ("1" – system: системна відправка, "2" – custom: відправка з маркетингової кампанії);
- sms_id – ідентифікатор SMS повідомлення.
sms_lost
SMS не доставлено.
event (string)
client_user_id (string)
project_id (int)
category_id (int)
template_id (int)
sms_id (int)
ts (int)
omnichannel(int)
channel (string)
{
"0": {
"event": "sms_lost",
"client_user_id": "test123",
"project_id": 99,
"category_id": 1,
"template_id": 15,
"sms_id": 1233,
"ts": 1549382627,
"omnichannel": 1,
"channel" : "sms
}
}
}
- ts – час відправки автоматичного повідомлення Webhook у форматі unix timestamp;
- omnichannel – цей параметр доданий для розділення автоматичних повідомлень, що стосуються відправки електронних листів та функціоналу омніканальності. За замовчуванням, має значення "1";
- category_id – категорія відправки ("1" – system: системна відправка, "2" – custom: відправка з маркетингової кампанії);
- sms_id – ідентифікатор SMS повідомлення.
sms_click
Факт натискання користувача на клікабельний елемент в шаблоні SMS (наприклад, посилання).
event (string)
client_user_id (string)
project_id (int)
category_id (int)
template_id (int)
sms_id (int)
ts (int)
omnichannel(int)
channel (string)
link (string)
{
"0": {
"event": "sms_click",
"client_user_id": "test123",
"project_id": 99,
"category_id": 1,
"template_id": 15,
"sms_id": 1233,
"ts": 1549382627,
"omnichannel": 1,
"channel" : "sms",
"link" : "example.com"
}
}
}
- ts – час відправки автоматичного повідомлення Webhook у форматі unix timestamp;
- omnichannel – цей параметр доданий для розділення автоматичних повідомлень, що стосуються відправки електронних листів та функціоналу омніканальності. За замовчуванням, має значення "1";
- category_id – категорія відправки ("1" – system: системна відправка, "2" – custom: відправка з маркетингової кампанії);
- sms_id – ідентифікатор SMS повідомлення;
- link – посилання, за яким перейшов користувач з SMS повідомлення.
Updated 7 months ago