Получение информации о чатах

Метод	`get.chats_report`
Описание	Получение информации о чатах
Кому доступен	Партнер, Клиент

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

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

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Ответ по умолчанию	Описание
`id`	number		да		да	Уникальный идентификатор чата. Все сообщения чата можно получить используя метод `"get.chat_messages_report"`
`status`	enum	`new` - у чат нет сотрудника (не принят в работу) и нет причины завершения чата; `active` - сотрудник принял чат в работу и не завершил (нет причины завершения чата); `lost` - есть причина завершения чата и ни один сотрудник не брал чат в работу ИЛИ - причина завершения чата visitor_disconnected (визитор ушел) ИЛИ - причина завершения чата closed_by_timeout (завершен по таймауту) или closed_by_operator (завершен оператором) И количество сообщений оператора = 0; `succeed` - любой закрытый чат с двусторонней перепиской; `refused` - любой закрытый чат, где есть сообщения от оператора или автоприглашения, но сообщений от посетителя 0 ;	да	да	да	Статус чата
`initiator`	enum	`operator` - Оператор; `visitor` - Посетитель; `autoinvite` - Автоприглашение; `chat_channel` - Мессенджер; `chatbot` - Чат-бот	да	да	да	Инициатор чата
`date_time`	iso8601	YYYY-MM-DD hh:mm:ss		да	да	Дата и время начала чата
`duration`	string		да	да	да	Продолжительность чата. Значение в секундах
`answer_time`	number		да	да	да	Время ответа оператора. Значение в секндах
`communication_number`	number		да	да		Номер обращения. Расcчитывается в рамках персоны.
`communication_page_url`	string		нет	нет	нет	URL страницы на которой находился посетитель в момент обращения или страница последнего взаимодействия посетителя перед обращением.
`communication_id`	number		да		да	Уникальный номер обращения
`communication_type`	enum	`chat`				Тип обращения
`chat_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
`chat_channel_name`	string					Имя канала
`chat_user_id`	string		да	да		User_id из мессенджеров
`chat_username`	string		да	да		Username (ник) из мессенджеров
`messages_count`	number					Количество сообщений в чате
`ua_client_id`	string					Уникальный идентификатор в Universal Analytics
`ym_client_id`	string					Уникальный идентификатор пользователя Яндекс.Метрики
`sale_date`	iso8601	YYYY-DD-MM hh:mm:ss	да	да		Дата сделки
`sale_cost`	number		да	да		Сумма сделки
`is_transfer`	boolean				да	Был ли чат передан другому сотруднику
`release_cause`	enum	`closed_by_timeout` `invite_rejected` `closed_by_operator` `closed_by_visitor` `visitor_banned` `external_window_closed` `visitor_disconnected` `visitor_session_expired` `closed_by_scenario`	да		да	Причина завершения чата
`search_query`	string		да			Поисковый запрос
`search_engine`	string		да			Название поисковой системы
`referrer_domain`	string		да			Домен реферера
`referrer`	string		да			Источник перехода
`entrance_page`	string		да			Страница входа
`gclid`	string		да			Google Click Identifier
`yclid`	string		да			Yandex Click Identifier
`ymclid`	string					Yandex Market Click Identifier
`ef_id`	string		да			Используется для разметки ссылок в системе управления контекстной рекламой AdLense
`channel`	enum	`display` `paid` `affiliate` `messenger` `social` `email` `organic` `internal` `recommendation` `cashed` `referral` `direct`	да			Канал.
Сотрудник принявший чат
`employee_id`	number		да	да	да	Уникальный идентификатор сотрудника
`employee_full_name`	string		да			Фамилия Имя Сотрудника
`employee_raiting`	number				да	Рейтинг оператора выставленный посетителем
`employee_messages_count`	number					Количество сообщений оператора в чате
Проставленные теги
`tags`	array		да			Теги, см. метод `"get.tags"`
`tag_id`	number					Уникальный идентификатор тега
`tag_name`	string					Название тега
`tag_change_time`	iso8601	YYYY-MM-DD hh:mm:ss				Время простановки тега
`tag_type`	enum	`auto`, `manual`				Тип тега
`tag_user_id`	number					Уникальный идентификатор пользователя, который проставил тег
`tag_user_login`	string					Логин пользователя проставившего тег
`tag_employee_id`	number					Уникальный идентификатор сотрудника, который проставил тег
`tag_employee_full_name`	string					Ф.И.О сотрудника, который проставил тег
Сайт
`site_id`	number		да	да	да	Уникальный идентификатор сайта
`site_domain_name`	string		да			Адрес сайта в интернете. Без указания протокола - `"http://"` или `"https://"`
Рекламная кампания
`campaign_id`	number		да	да	да	Уникальный идентификатор рекламной кампании
`campaign_name`	string		да			Название рекламной кампании
`visit_other_campaign`	boolean					Флаг показывает заходил ли посетитель (в пределах персоны) по другим рекламным кампаниям
Информация о посетителе
`visitor_phone_number`	number		да		да	Номер телефона посетителя оставленный в чате
`visitor_id`	number		да	да	да	Уникальный идентификатор посетителя
`person_id`	number		да	да		Уникальный идентификатор персоны
`visitor_type`	enum	Новый, Вернувшийся, Не заполнен	да	да		Тип посетителя
`visitor_session_id`	number		да	да		Уникальный идентификатор сессии посетителя, см. `"get.visitor_sessions_report"`
`visits_count`	number		да			Общее количество посещений посетителя
`visitor_first_campaign_id`	number		да			Уникальный идентификатор первой рекламной кампании.
`visitor_first_campaign_name`	string		да			Название первой рекламной кампании
`visitor_city`	string		да			Город посетителя
`visitor_region`	string		да			Регион посетителя
`visitor_country`	string		да			Страна посетителя
`visitor_device`	enum	`desktop` `mobile` `tablet` `other`	да	да		Устройство посетителя
Свойства посетителя
`visitor_custom_properties`	array		да			Свойства посетителя, которые могут быть заданы через личный кабинет или с помощью JavaScript API [метод `Comagic.setProperty(name, value);`]
`property_name`	string					Имя свойства, которое должно быть присвоено посетителю
`property_value`	string					Значение свойства
Сегменты
`segments`	array		да			Сегменты
`segment_id`	number					Уникальный идентификатор сегмента
`segment_name`	string					Название сегмента
UTM-метки
`utm_source`	string		да			Источник кампании
`utm_medium`	string		да			Канал кампании
`utm_term`	string		да			Ключевое слово кампании
`utm_content`	string		да			Содержание кампании
`utm_campaign`	string		да			Название кампании
OS-метки
`openstat_ad`	string		да			Идентификатор рекламного объявления
`openstat_campaign`	string		да			Идентификатор рекламной кампании
`openstat_service`	string		да			Идентификатор сервиса, предоставляющего услуги
`openstat_source`	string		да			Идентификатор площадки, раздела, страницы, места на странице, на котором было показано соответствующее рекламное объявление
Атрибуты обращения
`attributes`	array	`first` - Первый качественный `through` - Сквозной первый качественный `primary` - Первичное `secondary` - Вторичное `lost` - Потерянное `target` - Целевое `off-target` - Не целевое `quality` - Качественное `rest` - целевые повторные обращения (обращения, совершенные в период повторного обращения, настроенного для сайта в ЛК CoMagic).	да			Атрибуты обращения
Расширенные UTM-метки
`eq_utm_source`	string		да			Расширенная utm_source
`eq_utm_medium`	string		да			Расширенная utm_medium
`eq_utm_term`	string		да			Расширенная utm_term
`eq_utm_content`	string		да			Расширенная utm_content
`eq_utm_campaign`	string		да			Расширенная utm_campaign
`eq_utm_referrer`	string		да			Расширенная utm_referrer
`eq_utm_expid`	string		да			Расширенная utm_expid
Информация об источнике
`source_id`	number		да	да		Идентификатор Источника(детальный).
`source_name`	string		да	да		Источник(детальный). Название источника
`source_new`	string		да	да		Источник(new). Группа источника
`channel_new`	string		да	да		Канал(new). Название канала источника
`channel_code`	string		да	да		Мнемоника канала
`ext_id`	string		да	да		Уникальный идентификатор чата в вашей системе.

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

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.chats_report",
 "params":{
  "access_token":"string",
  "user_id":"number",
  "date_from":"iso8601",
  "date_till":"iso8601",
  "offset":"number",
  "limit":"number",
  "filter":{

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

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

Копировать

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

  },
  "data":[
   {
    "id":"number",
    "status":"enum",
    "initiator":"enum",
    "date_time":"iso8601",
    "duration":"string",
    "answer_time":"number",
    "communication_number":"number",
    "communication_page_url": "string",
    "communication_id":"number",
    "communication_type":"enum",
    "chat_user_id":"sting",
    "chat_username":"sting",
    "chat_channel_type": "enum",
    "chat_channel_name": "string",
    "messages_count":"number",
    "ua_client_id":"string",
    "ym_client_id": "string",
    "sale_date":"iso8601",
    "sale_cost":"number",
    "is_transfer":"boolean",
    "release_cause":"enum",
    "search_query":"string",
    "search_engine":"string",
    "referrer_domain":"string",
    "referrer":"string",
    "entrance_page":"string",
    "gclid":"string",
    "yclid":"string",
    "ymclid":"string",
    "ef_id":"string",
    "channel":"enum",
    "employee_id":"number",
    "employee_full_name":"string",
    "employee_messages_count":"number",
    "employee_raiting":"number",
    "site_id":"number",
    "site_domain_name":"string",
    "campaign_id":"number",
    "campaign_name":"string",
    "visit_other_campaign":"boolean",
    "visitor_id":"number",
        "visitor_phone_number":"number",
    "person_id":"number",
    "visitor_type":"enum",
    "visitor_session_id":"number",
    "visits_count":"number",
    "visitor_first_campaign_id":"number",
    "visitor_first_campaign_name":"string",
    "visitor_city":"string",
    "visitor_region":"string",
    "visitor_country":"string",
    "visitor_device":"enum",
    "utm_source":"string",
    "utm_medium":"string",
    "utm_term":"string",
    "utm_content":"string",
    "utm_campaign":"string",
    "openstat_ad":"string",
    "openstat_campaign":"string",
    "openstat_service":"string",
    "openstat_source":"string",
    "eq_utm_source": "string",
    "eq_utm_medium": "string",
    "eq_utm_term": "string",
    "eq_utm_content": "string",
    "eq_utm_campaign": "string",
    "eq_utm_referrer": "string",
    "eq_utm_expid": "string",
    "attributes":[

    ],
    "visitor_custom_properties":[
     {
      "property_name":"string",
      "property_value":"string"
     }
    ],
    "segments":[
     {
      "segment_id":"number",
      "segment_name":"string"
     }
    ],
    "tags":[
     {
      "tag_id":"number",
      "tag_name":"string",
      "tag_type":"enum",
      "tag_change_time":"iso8601",
      "tag_user_login":"string",
      "tag_user_id":"number",
      "tag_employee_id":"number",
      "tag_employee_full_name":"string"
     }
    ],
    "source_id": "number",
    "source_name": "string",
    "source_new": "string",
    "channel_new": "string",
    "channel_code": "string",
        "ext_id": "string"
   }
  ]
 }
}

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

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