Получение истории чата

Обновлено 6 марта 2025

GET

/chatapi/bot/{token}/client/{clientId}/history

Получение истории переписки бота с клиентом.

Запрос

Path Parameters

token

string

required

Токен канала Chat API. Значение токена можно получить при добавлении интеграции в проекте SaluteBot в Studio.

clientId

string

required

Идентификатор клиента.Значение clientId генерируется клиентом(вашим приложением). Произвольная строка.

Query Parameters

dateFrom

int64

Unix-время в миллисекундах, начиная с которого нужно загружать историю.

dateTo

int64

Unix-время в миллисекундах, вплоть до которого нужно загружать историю.

pageSize

int32

По умолчанию: 10

Число сообщений на странице.

pageNum

int32

По умолчанию: 0

Номер страницы.

Ответы

• 200

OK

• application/json

• Схема
• Пример из схемы

Schema

pageSize

int32

required

Число сообщений на странице.

pageNumber

int32

required

Номер страницы.

total

int64

required

Общее число полученных сообщений.

messages

object[]

required

Список полученных сообщений.

Array [

type

EventType (string)

required

Возможные значения: [request, botResponse, humanResponse, state]

Тип события

message

object

required

oneOf

• BotResponse
• HumanResponse

token

string

Токен канала Chat API.

clientId

string

required

Значение clientId генерируется клиентом(вашим приложением). Произвольная строка.

questionId

uuid

required

Идентификатор сообщения. Значение должно быть уникально в рамках вашей интеграции, рекомендуется uuid v4.

data

object

required

Содержимое ответа бота. JSON объект может быть расширен из сценария любыми дополнительными полями. По умолчанию содержит список реплик бота и текстовый ответ. Возможные типы реплик описаны в https://developers.sber.ru/docs/ru/salutebot/chatapi-integration.

replies

object[]

Список реплик сформированных в рамках обработки запроса клиента

answer

string

Текст ответа бота на запрос клиента. Содержит склеенный список текстовых фраз.

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}$

Время отправки запроса по часовому поясу UTC.

token

string

Токен канала Chat API.

clientId

string

required

Значение clientId генерируется клиентом(вашим приложением). Произвольная строка.

questionId

uuid

required

Идентификатор сообщения. Значение должно быть уникально в рамках вашей интеграции, рекомендуется uuid v4.

data

object

required

Содержимое кастомного ответа бота, отправленного с помощью reply с типом raw.

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}$

Время отправки запроса по часовому поясу UTC.

endSession

boolean

required

Завершена ли текущая сессия.

]

{
  "pageSize": 0,
  "pageNumber": 0,
  "total": 0,
  "messages": [
    {
      "type": "request",
      "message": {
        "query": "string",
        "clientId": "string",
        "clientInfo": {
          "firstName": "string",
          "lastName": "string",
          "userPic": "string"
        },
        "questionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "data": {},
        "timestamp": "2020-04-01T12:30:00.000",
        "cid": "string"
      }
    }
  ]
}

Loading...

Loading...