Получение всех сообщений чата

Метод	`get.chat_messages_report`
Описание	Получение всех сообщений чата
Кому доступен	Партнер, Клиент

Параметры запроса

Название	Тип	Обязательный	Допустимые значения	Описание
`access_token`	string	да		Ключ сессии аутентификации
`user_id`	number	нет		Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`limit`	number	нет		Количество возвращаемых записей. См. раздел "Постраничный вывод"
`offset`	number	нет		Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
`filter`	object	нет		См. раздел "Критерии фильтрации"
`fields`	array	нет		См. раздел "Представление возвращаемых данных"
`sort`	array	нет		См. раздел "Сортировка данных"
`chat_id`	number	да, если нет chat_ids или date_from и date_till		Уникальный идентификатор чата
`chat_ids`	array	да, если нет chat_id или date_from и date_till		Список уникальных идентификаторов чатов
`date_from`	iso8601	да, если нет chat_id или chat_ids	YYYY-MM-DD hh:mm:ss	Дата начала выборки. Максимальное значение интервала не должно превышать 30 дней. Допускается совместное использование с параметрами chat_id и chat_ids.
`date_till`	iso8601	да, если нет chat_id или chat_ids	YYYY-MM-DD hh:mm:ss	Дата окончания выборки. Максимальное значение интервала не должно превышать 30 дней. Допускается совместное использование с параметрами chat_id и chat_ids.

Параметры ответа

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Ответ по умолчанию	Описание
`id`	number		да		да	Уникальный идентификатор сообщения
`chat_id`	number		да		да	Уникальный идентификатор чата, см. метод `"get.chats_report"`
`channel_id`	number		да			Уникальный идентификатор канала чата. Обязательно использовать вместе с фильтром по дате или по chat_id
`channel_type`	enum	`comagic` `yandex.dialogs` `dataapi` `whatsapp` `telegram` `vkontakte_groups` `viber` `telegram_private` `realty_yandex` `avito` `auto_ru` `facebook` `offline_message` `instagram` `waba`	да	да		Тип канала. Обязательно использовать вместе с фильтром по дате или по chat_id
`date_time`	iso8601	YYYY-MM-DD hh:mm:ss		да	да	Дата и время когда было отправлено сообщение Все сообщения должны быть в порядке их отправки, т.е отсортированы по полю `"date_time"`
`is_group_chat`	boolean				да	Обозначает является ли чат групповым
`visitor_id`	number				да	Уникальный идентификатор посетителя
`text`	string				да	Текст сообщения
`source`	enum	`system` - Система; `operator` - Оператор; `visitor` - Посетитель; `retention` - Удерживающие сообщения; `autoinvite` - Автоприглашение; `form_text` - Форма сбора информации; `chat_channel` - Мессенджер; `chatbot` - Чат-бот;			да	Источник сообщения
`resource`	object				да	Информация об отправленном файле в сообщении: `size` - размер файла в байтах `type` - тип файла `file_url` - ссылка на файл `file_name` - название файла `mime_type` - медиа тип
Сотрудник
`employee_id`	number		да	да	да	Уникальный идентификатор сотрудника
`employee_full_name`	string				да	Фамилия Имя Отчество сотрудника

JSON структура запроса

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.chat_messages_report",
 "params":{
  "access_token":"string",
  "chat_id":"number",
  "user_id":"number",
  "offset":"number",
  "limit":"number",
  "filter":{

  },
  "sort":[
   {
    "field":"string",
    "order":"string"
   }
  ],
  "fields":[
   "string"
  ]
 }
}

JSON структура ответа

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "result":{
  "metadata":{

  },
  "data":[
   {
    "id":"number",    
    "chat_id":"number",
    "date_time":"iso8601",
    "is_group_chat": "boolean",
    "visitor_id": "number",
    "text":"string",
    "resource": {
          "size": "number",
          "type": "enum",
          "file_url": "string",
          "file_name": "string",
          "mime_type": "string"
        },
    "source":"enum",
    "employee_id":"number",
    "employee_full_name":"string"
   }
  ]
 }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"