Skip to content

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

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

Метод 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_id number да да Уникальный идентификатор чата, см. метод "get.chats_report"
date_time iso8601 YYYY-MM-DD hh:mm:ss да да Дата и время когда было отправлено сообщение
Все сообщения должны быть в порядке их отправки, т.е отсортированы по полю "date_time"
text string да Текст сообщения
source enum Оператор, Посетитель, Система да Источник сообщения
Сотрудник
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":[
      {
        "chat_id":"number",
        "date_time":"iso8601",
        "text":"string",
        "source":"enum",
        "employee_id":"number",
        "employee_full_name":"string"
      }
    ]
  }
}

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

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