Обрабатывает приветственное сообщение бота, то есть сообщение, которое бот отправляет в качестве первого (проактивного) приветствия клиенту.
В качестве приветственного сообщения может быть текст, текст с вложением, просто вложение (без текста), а также текст в разметке Markdown.
В запросе должен быть указан
clientId или threadsClientId. clientId можно использовать только для авторизованных клиентов, threadsClientId можно использовать для любых клиентов. Если указаны оба параметра, приоритет у clientId. | Параметр | Тип | Описание |
text | string (необязательно) | Сообщение бота |
clientId | string (необязательно) | Внешний ID клиента. Этот параметр устарел, вместо него используйте threadsClientId. |
threadsClientId | long (необязательно) | Внутренний ID клиента |
attachments | array of object (необязательно) | Поля: • url — URL файла, строка до 4000 символов• name — Имя файла, строка до 1000 символов• type — MIME-тип файла, строка до 256 символов• size — Размер файла в байтах, целое число |
formattedText | string (необязательно) | Сообщение бота. В нём может содержаться текст в разметке Markdown. Рекомендуется передать текстовое представление сообщения в поле text для отображения в пользовательском интерфейсе. |
receivedAt | string (необязательно) | Время получения сообщения, дата в формате UTC: yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ |
quickReplies | array (необязательно) | Поля: • type — Тип быстрого ответа. Возможные значения: TEXT для текстовых сообщений, WEBVIEW для интерактивных веб-форм.• text — Текст, строка до 4000 символов.• shown_text — Текстовое содержимое, необязательный параметр, строка до 2000 символов. Используется только в комбинации с параметром text. Если параметр указан, этот текст отправляется как клиентское сообщение после нажатия на кнопку быстрого ответа.• callback_data — Текстовое содержимое, необязательный параметр, строка до 255 символов. Название события, которое будет передаваться, когда вызван JS SDK API для последующей обработки заказчиком на стороне сайта.• imageUrl — URL иконки кнопки, строка до 4000 символов.• url — Ссылка на прикрепленный файл, строка до 4000 символов. Длина и количество быстрых ответов настраивается в БД: message.max-quick-replies, message.max-quick-reply-length |
settings | Object (необязательно) | Дополнительные настройки сообщения |
settings.blockInput | boolean (необязательно) | Параметр, который указывает, заблокировано ли поле ввода сообщения (true — заблокировано, false — не заблокировано). Работает только для быстрых ответов. |
Пример curl
$ curl 'http: //localhost:8080/api/v1/chatbot/greet' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"clientId": "1",
"threadsClientId": 1,
"text": "текст приветствия"
}'
HTTP запрос
POST /api/v1/chatbot/greet HTTP/1.1
Content-Type: application/json
Authorization: Bearer <token>
Content-Length: 70
Host: localhost: 8080
{
"clientId": "1",
"threadsClientId": 1,
"text": "текст приветствия"
}
Пример успешного HTTP ответа
HTTP/1.1 200 OK
Пример сообщения с быстрым ответом
Пример curl
$ curl 'http: //localhost:8080/api/v1/chatbot/stub/greet' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"action": "INIT_CHAT",
"clientId": "1",
"threadsClientId": 1,
"sessionId": "1",
"questionId": 43,
"receivedAt": "2022-05-18T08:45:07.259Z",
"quickReplies": [
{
"type": "TEXT",
"text": "быстрый ответ 1",
"imageUrl": null,
"url": null,
"shown_text": null,
"callback_data": null
},
{
"type": "TEXT",
"text": "быстрый ответ 2",
"imageUrl": null,
"url": null,
"shown_text": null,
"callback_data": null
}
],
"settings": {
"blockInput": true,
"masked": false
}
}'
HTTP запрос
POST /api/v1/chatbot/stub/greet HTTP/1.1
Content-Type: application/json
Authorization: Bearer <token>
Content-Length: 553
Host: localhost: 8080
{
"action": "INIT_CHAT",
"clientId": "1",
"threadsClientId": 1,
"sessionId": "1",
"questionId": 43,
"receivedAt": "2022-05-18T08:45:07.259Z",
"quickReplies": [
{
"type": "TEXT",
"text": "quick reply 1",
"imageUrl": null,
"url": null,
"shown_text": null,
"callback_data": null
},
{
"type": "TEXT",
"text": "quick reply 2",
"imageUrl": null,
"url": null,
"shown_text": null,
"callback_data": null
}
],
"settings": {
"blockInput": true,
"masked": false
}
}
Пример успешного HTTP ответа
HTTP/1.1 200 OK