База знаний
Диалоги

Методы управления диалогами и сообщениями.


Запрос


get-conversation

Возвращает диалог и сообщения в нем.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-conversation.
conversation_id
Обязательно*
ID диалога.
user_id
ID пользователя связанного с диалогом.

Ответ

{
"success": true,{
"success": true,
"response": {
"messages": [
{
"id": "2044",
"user_id": "802",
"message": "Привет!",
"creation_time": "2023-05-0410:06:30",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "946",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/user.svg",
"user_type": "lead"
},
{
"id": "2045",
"user_id": "377",
"message": "Привет,чем могу помочь?",
"creation_time": "2023-05-0410:06:33",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "946",
"first_name": "Василий",
"last_name": "Петров",
"profile_image": "https://stepchat.io/agent.svg",
"user_type": "agent"
}
...
],
"details": {
"user_id": "802",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/user.svg",
"user_type": "lead",
"id": "946",
"title": "",
"conversation_time": "2023-05-0410:06:30",
"conversation_status_code": "3",
"department": null
}
}
}
"response": {
"messages": [
{
"id": "2044",
"user_id": "802",
"message": "Привет!",
"creation_time": "2023-05-0410:06:30",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "946",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/user.svg",
"user_type": "lead"
},
{
"id": "2045",
"user_id": "377",
"message": "Привет,чем могу помочь?",
"creation_time": "2023-05-0410:06:33",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "946",
"first_name": "Василий",
"last_name": "Петров",
"profile_image": "https://stepchat.io/agent.svg",
"user_type": "agent"
}
...
],
"details": {
"user_id": "802",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/user.svg",
"user_type": "lead",
"id": "946",
"title": "",
"conversation_time": "2023-05-0410:06:30",
"conversation_status_code": "3",
"department": null
}
}
}

Возвращает {"success": true, "response": {"messages": [], "details": ""}}, если диалог не найден.


Запрос


get-conversations


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-conversations.
pagination
Целое число от 1 до N для ограничения количества результатов. Введите 1, чтобы получить первые 100 результатов, 2 - результаты с 101 по 200 и так далее.
status_code
Код статуса возвращенных диалогов. По умолчанию: все диалоги во входящих, исключая диалоги находящиеся в корзине и архиве. Коды статуса: активный = 0, ожидание ответа от пользователя = 1, ожидание ответа от агента = 2, архив = 3, корзина = 4, все = includes all status codes..
routing
Установите значение true, если очередь или маршрутизация активны в разделе Настройки - Чат. По умолчанию: false.
routing_unassigned
Установите значение true, чтобы получать диалоги, не назначенные ни одному агенту. По умолчанию: false.
department
Возвращает диалоги назначенные указанному ID отдела.
source
Возвращает диалоги из указанного источника. Доступные источники: em (Электронная почта), tk (Заявка), wa (WhatsApp), fb (Facebook Messenger), ig (Instagram), tw (Twitter), wc (WeChat), tx (Текстовое сообщение), gb (Сообщения Google Business).
tag
Возвращает диалоги с указанным тегом.

Ответ

{
"success": true,
"response": [
{
"id": "1431",
"user_id": "632",
"message": "Привет!",
"creation_time": "2023-04-24 10:53:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "764",
"message_user_type": "lead",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/media/user.svg",
"conversation_status_code": "2",
"user_type": "lead"
},
{
"id": "1430",
"user_id": "631",
"message": "Привет! Чем могу помочь?",
"creation_time": "2023-04-24 10:38:37",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "763",
"message_user_type": "lead",
"first_name": "Екатерина",
"last_name": "Зайцева",
"profile_image": "https://stepchat.io/media/user.svg",
"conversation_status_code": "2",
"user_type": "lead"
}
...
]
}


Запрос


get-new-conversations


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-new-conversations.
datetime
Обязательно*
Идентификатор диалога или дата и время в следующем формате: ГГГГ-ММ-ДД ЧЧ:ММ:СС. Например, 2023-05-13 13:35:59. Вы можете удалить время и оставить только дату. Даты, хранящиеся в базе данных, используют часовой пояс UTC+0.
routing
Установите значение true, если очередь или маршрутизация активны в разделе Настройки - Чат. По умолчанию: false.
routing_unassigned
Установите значение true, чтобы получать диалоги, не назначенные ни одному агенту. По умолчанию: false.

Ответ

{
"success": true,
"response": [
{
"id": "1431",
"user_id": "632",
"message": "Привет!",
"creation_time": "2023-04-24 10:53:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "764",
"message_user_type": "lead",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/media/user.svg",
"conversation_status_code": "2",
"user_type": "lead"
},
{
"id": "1430",
"user_id": "631",
"message": "Привет! Чем могу помочь?",
"creation_time": "2023-04-24 10:38:37",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "763",
"message_user_type": "lead",
"first_name": "Екатерина",
"last_name": "Зайцева",
"profile_image": "https://stepchat.io/media/user.svg",
"conversation_status_code": "2",
"user_type": "lead"
}
...
]
}

Возвращает {"success": true, "response": []}, если диалог не найден.


Запрос


get-user-conversations


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-new-conversations.
user_id
Обязательно*
ID пользователя.
exclude_id
Исключить диалог из результата.
agents
Установите значение true, если пользователь является агентом или администратором. По умолчанию: false.

Ответ

{
"success": true,
"response": [
{
"id": "2266",
"user_id": "377",
"message": "Привет, чем могу помочь?",
"creation_time": "2023-05-12 17:30:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "995",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/media/user.svg",
"user_type": "lead",
"conversation_status_code": "3"
},
{
"id": "2266",
"user_id": "5",
"message": "Пожалуйста, оставьте отзыв.",
"creation_time": "2023-05-12 17:30:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "995",
"first_name": "Николай",
"last_name": "Зверев",
"profile_image": "https://stepchat.io/media/user.svg",
"user_type": "agent",
"conversation_status_code": "3"
}
...
]
}

Возвращает {"success": true, "response": []}, если диалог не найден.


Запрос


get-new-user-conversations


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-new-user-conversations.
user_id
Обязательно*
ID пользователя.
datetime
Обязательно*
Идентификатор диалога или дата и время в следующем формате: ГГГГ-ММ-ДД ЧЧ:ММ:СС. Например, 2023-05-13 13:35:59. Вы можете удалить время и оставить только дату. Даты, хранящиеся в базе данных, используют часовой пояс UTC+0.

Ответ

{
"success": true,
"response": [
{
"id": "2266",
"user_id": "377",
"message": "Привет, чем могу помочь?",
"creation_time": "2023-05-12 17:30:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "995",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/media/user.svg",
"user_type": "lead",
"conversation_status_code": "3"
},
{
"id": "2266",
"user_id": "5",
"message": "Пожалуйста, оставьте отзыв.",
"creation_time": "2023-05-12 17:30:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "995",
"first_name": "Николай",
"last_name": "Зверев",
"profile_image": "https://stepchat.io/media/user.svg",
"user_type": "agent",
"conversation_status_code": "3"
}
...
]
}

Возвращает {"success": true, "response": []}, если диалог не найден.


Запрос


search-conversations

Возвращает диалоги соответствующие поиску.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите search-conversations.
search
Обязательно*
Строка поиска. Ищет в именах вложений, сообщениях, а также в адресе электронной почты, имени и фамилии пользователя.

Ответ

{
"success": true,
"response": [
{
"id": "2130",
"user_id": "806",
"message": "Привет! Чем могу помоь?",
"creation_time": "2023-05-05 15:45:38",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "952",
"message_user_type": "admin",
"first_name": "User",
"last_name": "#24254",
"profile_image": "https://stepchat.io/media/user.svg",
"conversation_status_code": "4",
"user_type": "lead"
},
{
"id": "2127",
"user_id": "805",
"message": "Привет! Мне нужна помощь!",
"creation_time": "2023-05-05 08:12:57",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "951",
"message_user_type": "user",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/media/user.svg",
"conversation_status_code": "0",
"user_type": "user"
}
...
]
}

Возвращает {"success": true, "response": []}, если диалог не найден.


Запрос


search-user-conversations

Возвращает диалоги с указанным идентификатором пользователя.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите search-user-conversations.
search
Обязательно*
Строка поиска. Ищет в именах вложений, сообщениях, а также в адресе электронной почты, имени и фамилии пользователя.
id
Обязательно*
ID пользователя.

Ответ

{
"success": true,
"response": [
{
"id": "3362",
"user_id": "2",
"message": "Привет! Чем могу помоь?",
"creation_time": "2023-06-24 17:34:39",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "1364",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/media/user.svg",
"user_type": "lead",
"conversation_status_code": "0"
},
{
"id": "3345",
"user_id": "1195",
"message": "Привет! Мне нужна помощь!",
"creation_time": "2023-06-24 17:06:23",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "1363",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/media/user.svg",
"user_type": "lead",
"conversation_status_code": "2"
}
...
]
}

Возвращает {"success": true, "response": []}, если диалог не найден.


Запрос


new-conversation

Возвращает диалоги с указанным идентификатором пользователя.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите new-conversation.
user_id
Обязательно*
ID пользователя связанного с диалогом.
status_code
Код статуса возвращенных диалогов. По умолчанию: все диалоги во входящих, исключая диалоги находящиеся в корзине и архиве. Коды статуса: активный = 0, ожидание ответа от пользователя = 1, ожидание ответа от агента = 2, архив = 3, корзина = 4, все = includes all status codes..
title
Заголовок диалога. По умолчанию: пусто.
department
ID отдела. Получить ID можно в разделе Настройки - Чат - Отделы. По умолчанию: -1.
agent_id
ID агента диалога. По умолчанию: -1.
source
Источник диалога. По умолчанию: false.
extra
Дополнительные значения диалога. По умолчанию: false.
tags
Теги диалога, разделенные запятыми. По умолчанию: false.

Ответ

{
"success": true,
"response": {
"messages": [],
"details": {
"user_id": "882",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/user.svg",
"user_type": "lead",
"id": "1007",
"title": "",
"conversation_time": "2023-05-15 12:51:39",
"conversation_status_code": "0",
"department": null
}
}
}

Другие возможные ответы: Массив с деталями разговора при успешном выполнении, в противном случае пользователь не найден, сообщение об ошибке MySQL.


Запрос


update-conversation-status

Обновляет код статуса диалога.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите update-conversation-status.
conversation_id
Обязательно*
ID диалога.
status_code
Обязательно*
Код статуса возвращенных диалогов. По умолчанию: все диалоги во входящих, исключая диалоги находящиеся в корзине и архиве. Коды статуса: активный = 0, ожидание ответа от пользователя = 1, ожидание ответа от агента = 2, архив = 3, корзина = 4.

Ответ

{
"success": true,
"response": true
}

Возвращает invalid-status-code, если код статуса недопустим.


Запрос


update-conversation-department

Обновляет код статуса диалога.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите update-conversation-department.
conversation_id
Обязательно*
ID диалога.
department
Обязательно*
ID отдела. Получить ID можно в разделе Настройки - Чат - Отделы. ID отдела не проверяются на валидность, поэтому убедитесь, что он существует. Установите значение false, чтобы удалить отдел.
message
Строка с сообщением для уведомления агентов. Если установлено, все агенты, назначенные в новый отдел, будут уведомлены по электронной почте.

Ответ

{
"success": true,
"response": true
}


Запрос


update-conversation-agent

Назначает или обновляет агента в диалоге.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите update-conversation-department.
conversation_id
Обязательно*
ID диалога.
agent_id
Обязательно*
ID агента. Установите значение false, чтобы удалить агента.
message
Строка с сообщением для уведомления агентов. Если установлено, все агенты, назначенные в новый отдел, будут уведомлены по электронной почте.

Ответ

{
"success": true,
"response": true
}


Запрос


set-rating

Назначает или обновляет агента в диалоге.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите set-rating.
settings
Обязательно*
Введите следующий массив в формате JSON: { "settings": { "conversation_id": "ID", "rating": "ОЦЕНКА" }}. Замените ID на ID диалога для оценки, замените ОЦЕНКА на 1 для положительной оценки или на 0 для отрицательной.
payload
Полезная нагрузка сообщения в формате JSON.
message_id
ID сообщения для обновления.
message
Содержание сообщения.
user_id
ID пользователя связанного с сообщением.

Ответ

{
"success": true,
"response": true
}


Запрос


get-rating

Назначает или обновляет агента в диалоге.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-rating.
user_id
Обязательно*
ID агента.

Ответ

{
"success": true,
"response": [4,2]
}

Массив ответа: [количество положительных оценок, количество отрицательных оценок]. В приведенном выше примере есть 4 положительные оценки и 2 отрицательные оценки.


Запрос


get-new-message

Возвращает сообщения диалога после указанной даты/ID.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-new-message.
user_id
Обязательно*
ID пользователя в диалоге.
conversation_id
Обязательно*
ID диалога.
datetime
Обязательно*
Идентификатор диалога или дата и время в следующем формате: ГГГГ-ММ-ДД ЧЧ:ММ:СС. Например, 2023-05-13 13:35:59. Вы можете удалить время и оставить только дату. Даты, хранящиеся в базе данных, используют часовой пояс UTC+0.

Ответ

{
"success": true,
"response": [
{
"id": "2319",
"user_id": "377",
"message": "Добро пожаловать в чат тех. поддержки!",
"creation_time": "2023-05-12 18:04:50",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "1004",
"first_name": "Виртуальный",
"last_name": "Помошник",
"profile_image": "https://stepchat.io/bot.svg",
"user_type": "bot"
},
{
"id": "2320",
"user_id": "877",
"message": "Спасибо! Мне нужна помощь!",
"creation_time": "2023-05-12 18:04:51",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "1004",
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/user.svg",
"user_type": "lead"
}
...
]
}

Возвращает {"success": true, "response": []}, если диалог не найден.


Запрос


get-last-message

Возвращает сообщения диалога после указанной даты/ID.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-new-message.
conversation_id
Обязательно*
ID диалога.
exclude_message
Если установлено, исключает сообщения с заданным текстом. По умолчанию: false.
user_id
Если установлено, проверяет только сообщения, созданные с указанным ID пользователя. По умолчанию: false.

Ответ

{
"success": true,
"response": {
"message": "Добро пожаловать в чат тех. поддержки!",
"attachments": "",
"payload": ""
}
}


Запрос


send-message

Добавляет новое сообщение в существующий диалог.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите send-message.
user_id
Обязательно*
ID пользователя, отправляющего сообщение. Используйте API get-bot-id, чтобы получить ID бота.
conversation_id
Обязательно*
ID диалога.
message
Содержание сообщения.
attachments
Массив в формате JSON вложений. Синтаксис массива: [["имя", "ссылка"], ["имя", "ссылка"], ...]. Замените имя на имя вложения и ссылку на полный URL-адрес вложения. Загрузку вложений на удаленный сервер необходимо выполнить отдельно, этот аргумент принимает только URL файлов, которые уже загружены. По умолчанию: [].
conversation_status_code
Код статуса диалога. Коды статуса: активный = 0, ожидание ответа от пользователя = 1, ожидание ответа от агента = 2, архив = 3, корзина = 4.. Установите значение skip для того, чтобы оставить текущий статуса диалога.
payload
Массив в формате JSON для дополнительной информации. Вы можете установить любое значение. Синтаксис массива: { "ключ": значение, "ключ": значение, ... }.
queue
Установите значение true, если очередь активна в разделе Настройки - Чат - Очередь. По умолчанию: false.
recipient_id
ID пользователя, который будет получать сообщение. Используйте этот атрибут, чтобы определить язык пользователя.

Ответ

{
"success": true,
"response": {
"status": "success",
"message-id": 123456,
"queue": false,
"notifications": ["sms", "email"],
"message": "Текст сообщения",
}
}

Другие возможные ответы: недопустимый код статуса, сообщение об ошибке MySQL.


Запрос


update-message

Обновляет существующее сообщение.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите update-message.
message_id
Обязательно*
ID сообщения.
message
Содержание сообщения.
attachments
Массив в формате JSON вложений. Синтаксис массива: [["имя", "ссылка"], ["имя", "ссылка"], ...]. Замените имя на имя вложения и ссылку на полный URL-адрес вложения. Загрузку вложений на удаленный сервер необходимо выполнить отдельно, этот аргумент принимает только URL файлов, которые уже загружены. По умолчанию: [].
payload
Массив в формате JSON для дополнительной информации. Вы можете установить любое значение. Синтаксис массива: { "ключ": значение, "ключ": значение, ... }.

Ответ

{
"success": true,
"response": true
}


Запрос


delete-message

Удаляет существующее сообщение.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите delete-message.
message_id
Обязательно*
ID сообщения.

Ответ

{
"success": true,
"response": true
}


Запрос


delete-attachments

Удаляет все вложения диалога или сообщения.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите delete-attachments.
conversation_id
ID диалога, который содержит вложения для удаления. По умолчанию: false.
message_id
ID сообщения, который содержит вложения для удаления. По умолчанию: false.

Ответ

{
"success": true,
"response": true
}


Запрос


update-message-status

Обновляет код статуса нескольких сообщений на прочитано.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите update-message-status.
message_ids
Массив ID сообщений в формате JSON, например: [1, 212, 124].
user_id
ID пользователя который отправлял сообщение.

Ответ

{
"success": true,
"response": true
}


Запрос


get-agents-in-conversation

Обновляет код статуса нескольких сообщений на прочитано.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-agents-in-conversation.
conversation_id
Обязательно*
ID диалога. Может быть массивом с ID диалогов.

Ответ

{
"1546": [
{
"id": 5463,
"first_name": "Иван",
"last_name": "Иванов",
"profile_image": "https://stepchat.io/user.svg",
"conversation_id": 1546
},
{
"id": 6413,
"first_name": "Генадий",
"last_name": "Уткин",
"profile_image": "https://stepchat.io/user.svg",
"conversation_id": 1546
},
...
],
...
}


Запрос


transcript

Экспортирует диалог в файл CSV или TXT и возвращает URL.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите transcript.
conversation_id
Обязательно*
ID диалога.
type
Установите значение csv для экспорта диалога в формате CSV, установите значение txt для экспорта разговора в текстовый файл. По умолчанию: false.

Ответ

{
"success": true,
"response": "https://stepchat.io/uploads/conversation-1021.csv"
}

Возвращает {"success": true, "response": false}, если диалог не найден.


Запрос


direct-message

Отправляет личное сообщение.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите direct-message.
user_ids
Обязательно*
Массив ID пользователей, например: [45, 89, 65].
message
Обязательно*
Сообщение.
subject
Тема. Требуется только для электронной почты. По умолчанию: false.

Ответ

{
"success": true,
"response": true
}


Запрос


messaging-platforms-send-message

Отправляет личное сообщение.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите messaging-platforms-send-message.
message
Обязательно*
Сообщение.
conversation_id
Обязательно*
ID диалога.
message_id
ID сообщения. Используйте этот аргумент, чтобы избежать дублирования сообщений.

Ответ

{
"success": true,
"response": true
}


Запрос


count-conversations

Отправляет личное сообщение.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите count-conversations.
status_code
Код статуса диалога. Коды статуса: активный = 0, ожидание ответа от пользователя = 1, ожидание ответа от агента = 2, архив = 3, корзина = 4. По умолчанию: false.

Ответ

{
"success": true,
"response": 123456
}


Запрос


check-conversations-assignment

Отправляет личное сообщение.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите check-conversations-assignment.
conversation_ids
Обязательно*
Массив ID диалогов, например: [45, 565, 68].
agent_id
ID агента. По умолчанию: false.
department_id
ID отдела. По умолчанию: false.

Ответ

{
"success": true,
"response": [1234, 5, ...]
}


Запрос


get-last-agent-in-conversation

Возвращает последнего агента, который ответил в диалоге.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-last-agent-in-conversation.
conversation_id
Обязательно*
ID диалога.

Ответ

{
"success": true,
"response": {
"id": 123,
"first_name": "Иван",
"last_name": "Иванов",
"email": "email@example.com",
"password": "$P$BcCpYeU21wYnXKW2LpJj/F9xRdSmLM/"
}
}

Возвращает false, если в диалоге нет ответов от агентов.


Запрос


execute-bot-message

Возвращает последнего агента, который ответил в диалоге.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите execute-bot-message.
name
Обязательно*
Имя сообщения бота. Доступные значения: offline, follow_up, welcome.
conversation_id
Обязательно*
ID диалога.
last_name_message
Используйте, чтобы отображать разные текстовые отрывки в административной области и панели управления чатом. По умолчанию: false.
check
Установите значение false, чтобы отправить сообщение, даже если оно уже было отправлено менее 10 дней назад. По умолчанию: true.

Ответ

{
"success": true,
"response": {
"message": "Текст сообщения.",
"attachments": [],
"id": 123,
"settings": {
"active": true,
"title": "",
"message": ""
}
}
}

ID - это ID сообщения, которое было только что создано.