Skip to content

Получение отчёта по сессиям звонков

Получение отчёта по сессиям звонков

Метод get.calls_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 Дата окончания выбокри
include_ongoing_calls boolean нет Включить текущие вызовы

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
id number да да Уникальный идентификатор сессии звонка
start_time iso8601 YYYY-MM-DD hh:mm:ss да да Дата и время начала сессии звонка
finish_time iso8601 YYYY-MM-DD hh:mm:ss да Время окончания сессии звонка
finish_reason enum да да да Причина окончания сессии звонка. Список возможных причин представлен ниже
direction enum
  • in - Входящая;
  • out - Исходящая
 да да да Направление сессии звонка
cpn_region_id number да да да Уникальный идентификатор региона номера абонента
cpn_region_name string да да да Название региона номера абонента
Операции сценариев
scenario_operations array да нет нет Список всех операций по всем сценариям, участвующих в обработке звонка.
id number Уникальный идентификатор операции сценария
name string Название операции сценария
source enum
  • callapi - Call API Базовый набор
  • callapi_management_call - Call API Управление вызовами
  • callapi_informer_call - Call API Информационный вызов
  • callapi_scenario_call - Call API Вызов сценария
  • va - Звонок ВАТС
  • call_tracking - Аналитика
  • dynamic_call_tracking - Динамический коллтрекинг
  • callout - Callout
  • callback - Callback
  • faxout - Факс
  • sip - Исходящий с SIP
  • sitephone - Сайтфон
  • lead - Лидогенератор
  • retailcrm - Звонок из retailCRM
  • amocrm - Звонок из amoCRM
  • bitrix - Звонок из Bitrix24
  • auto_back_call_by_lost_call - Автоперезвон по пропущенным звонкам
  • sip_trunk - Звонок с SIP-транка
  • facebook_ads - Звонки из Social Network Ads
  • auto_back_call_by_offline_message - Автоперезвон по заявкам
  • private_number - Проверочный звонок для добавления клиентского номера из ЛК
  • auto_out_calls - Исходящий обзвон
  • ivr_informer - Информирование с IVR
  • upload_calls - Звонок из внешней системы
  • progressive_call - Прогрессивный
  • simple_dt - Простой динамический коллтрекинг
  • preserved_calls - Сохранённая переадресация
  • amocrm_extended_integration - Автоперезвон из CRM
  • zoho - Zoho
  • mytarget_ads - Звонки из myTarget Ads
  • pipedrive - Pipedrive
  • hubspot - HubSpot
  • smartis - Звонки из Смартис
  • partner_integration - Партнёрская интеграция
  • vk_ads - Звонки из VK Ads
  • omni_widget - Омниканальный виджет
 да да да Источник звонка
is_lost boolean да да да Признак, что звонок потерянный или успешный
communication_number number да да Для сесии ВАТС пустой всегда, такова сейчас идеология сервиса
communication_page_url string нет нет нет URL страницы на которой находился посетитель в момент обращения или страница последнего взаимодействия посетителя перед обращением.
contact_phone_number string да да Номер контакта от которого поступил звонок в случае входящего звонка или номер контакта на который совершили звонок в случае исходящего звонка.
communication_id number да да Уникальный идентификатор обращения
communication_type enum call да Тип обращения
wait_duration number да да Длительность ожидания абонента до первого разговора с сотрудником. Значение в секундах.
total_wait_duration number да да Полная длительность ожидания абонента на линии. Учитывает все промежутки, когда абонент не разговаривал с сотрудником. Значение в секундах
lost_call_processing_duration number да да Длительность обработки пропущенного звонка. Считается от момента пропущенного разговора до первого успешного. Значение в секундах
talk_duration number да да Длительность разговора. Считается от момента первого разговора абонента с сотрудником до начала постобработки. Значение в секундах
clean_talk_duration number да да Чистая длительность разговора. Учитывает только те промежутки, когда абонент разговаривал с сотрудником. Значение в секундах
total_duration number да да Длительность звонка, значение в секундах
postprocess_duration number да Длительность постобработки, значение в секундах
call_records array да Уникальный идентификатор ссылки на записанный разговор. Можно прослушать вызвав запрос в браузере: https://app.comagic.ru/system/media/talk/{communication_id}/{уникальный индентификатор ссылки на записанный разговор}/
wav_call_records array да Уникальный идентификатор ссылки на записанный разговор в формате wav. Можно прослушать вызвав запрос в браузере: https://app.comagic.ru/system/media/wav/{communication_id}/{уникальный индентификатор ссылки на записанный разговор в формате wav}/
full_record_file_link string да Ссылка на полную запись разговора. Можно прослушать вызвав запрос в браузере: https://media.comagic.ru/{communication_id}/{уникальный индентификатор ссылки на записанный разговор}
voice_mail_records array Уникальный идентификатор ссылки на оставленное голосовое сообщение. Можно прослушать вызвав запрос в браузере: https://app.comagic.ru/system/media/voice_mail/{communication_id}/{уникальный индентификатор ссылки на голосовое сообщение}/
virtual_phone_number string да да да Виртуальный номер
ua_client_id string Уникальный идентификатор в Universal Analytics
ym_client_id string Уникальный идентификатор пользователя Яндекс.Метрики
sale_date iso8601 YYYY-MM-DD hh:mm:ss да да Дата сделки
sale_cost number да да Сумма сделки
is_transfer boolean true, false да да Был ли трансфер в сессии звонка
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
 да Канал.
Распознанный текст
recognized_text array нет нет нет Массив распознанных фраз
id number Уникальный идентификатор фразы
phrase string Фраза
start_time iso8601 >YYYY-MM-DD hh:mm:ss Время начала фразы
is_operator boolean Признак, фраза сотрудника или абонента
edited_phrase string Фраза, изменённая в ЛК CoMagic
Проставленные теги
tags array да Теги, см. метод "get.tags"
tag_name string Название тега
tag_id number Уникальный идентификатор тега
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 Ф.И.О сотрудника, который протсавил тег
Сотрудники участвовавшие в звонке
employees array да Сотрудники, которые участвовали в звонке
employee_id number Уникальный идентификатор сотрудника
employee_full_name string Ф.И.О. сотрудника
is_answered boolean Признак, поднял сотрудник трубку или нет
is_talked boolean Признак, участвовал ли сотрудник в разговоре или нет
Последний ответивший сотрудник
last_answered_employee_id number да Уникальный идентификатор последнего сотрудника, который поднял трубку
last_answered_employee_full_name string да Ф.И.О последнего сотрудника, который поднял трубку
last_answered_employee_rating number да Оценка последнего разговаривавшего сотрудника, которую абонент поставил после завершения звонка
Первый ответивший сотрудник
first_answered_employee_id number да Уникальный идентификатор первого сотрудника, который первый поднял трубку
first_answered_employee_full_name string да Ф.И.О. первого сотрудника, который первый поднял трубку Последний разговаривавший сотрудник
Последний разговаривавший сотрудник
last_talked_employee_id number да Уникальный идентификатор последнего разговаривавшего сотрудника
last_talked_employee_full_name string да Ф.И.О последнего разговаривавшего сотрудника
Первый разговаривавший сотрудник
first_talked_employee_id number да Уникальный идентификатор первого разговаривавшего сотрудника
first_talked_employee_full_name string да Ф.И.О первого разговаривавшего сотрудника
Оператор
operator_phone_number string да Номер оператора, принявшего звонок
Сценарий
scenario_name string да Название сценария по которому началась обработка звонка
scenario_id number да да Уникальный идентификатор сценария по которому началась обработка звонка
Сайт
site_domain_name string да Адрес сайта в интернете. Без указания протокола - "http://" или "https://"
site_id number да да Уникальный идентификатор сайта
Рекламная кампания
campaign_name string да Название рекламной кампании
campaign_id number да да Уникальный идентификатор рекламной кампании
visit_other_campaign boolean true, false Флаг показывает заходил ли посетитель (в пределах персоны) по другим рекламным кампаниям
auto_call_campaign_name string да да Название кампании исходящего обзвона"
Информация о посетителе
visitor_id 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
  • desktop
  • mobile
  • tablet
  • other
 да да Устройство пользователя
Свойства посетителя
visitor_custom_properties array да Свойства посетителя, которые могут быть заданы помощью JavaScript API [метод Comagic.setProperty]
property_name string Имя свойства, которое должно быть присвоено
property_value string Значение свойства
Сегменты
segments array да Сегменты
segment_id number Уникальный идентификатор сегмента
segment_name string Название сегмента
Call API
call_api_request_id number да Уникальный идентификатор запроса к API, который запросе.
call_api_external_id string да Уникальный идентификатор, который может быть события звонка с внешней системой.
Контакт из адресной книги
contact_id number да Уникальный идентификатор контакта
contact_full_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 да да Уникальный идентификатор звонка в вашей системе.

Причины окончания сессии звонка

Мнемоника Описание
numb_not_exists Виртуальный номер не найден
incorrect_input Некорректный ввод
numb_is_inactive Виртуальный номер не активен
sitephone_is_not_configured Сайтфон не настроен
app_is_inactive Клиент деактивирован
numa_in_black_list Вызывающий абонент в чёрном списке
no_active_scenario Не найден активный сценарий
simple_forwarding_is_not_configured Аналитика: простая переадресация не настроена
site_not_exists Сайт не найден
call_generator_is_not_configured Лидогенератор не настроен
add_cdr_timeout Не определена
success_finish Не определена
api_permission_denied Доступ к Call API запрещён
api_ip_now_allowed IP-адрес не в списке разрешённых
component_is_inactive Компонент не активен
employee_not_exists Сотрудник не найден
not_enough_money Недостаточно средств
platform_not_found Обратитесь в службу технической поддержки
internal_error Обратитесь в службу технической поддержки
incorrect_config Недопустимая конфигурация
communication_unavailable Недоступный тип связи
subscriber_disconnects Абонент разорвал соединение
no_operation Нет операции для обработки
scenario_not_found Сценарий не найден
transfer_disconnects Отключение сотрудника при трансфере
scenario_disconnects Отключение сотрудника при запуске сценария
fax_session_done Факс принят
no_resources Лимит клиента исчерпан
another_operator_answer Дозвонились до другого сотрудника
subscriber_busy Абонент занят
subscriber_not_responsible Абонент не отвечает
subscriber_number_problems Проблемы с телефонным номером абонента. Обратитесь в службу технической поддержки.
operator_answer Дозвонились до сотрудника
locked_numb Звонки на этот номер запрещены настройками безопасности
call_not_allowed_on_tp Звонок запрещен согласно тарифному плану
account_not_found Не найден лицевой счёт
contract_not_found Не найден договор
operator_busy Сотрудник занят
operator_not_responsible Сотрудник не отвечает
operator_disconnects Сотрудник разорвал соединение
operator_number_problems Проблемы с телефонным номером сотрудника. Обратитесь в службу технической поддержки.
timeout Время дозвона истекло
operator_channels_busy Закончились доступные линии на номере переадресации
locked_phone Проблемы с сетью
max_in_call_reached Достигнут лимит линий для входящих звонков
max_out_call_reached Достигнут лимит линий для исходящих звонков
employee_busy Сотрудник разговаривает в другом звонке
employee_busy_after_call Сотрудник занят после звонка
phone_group_inactive_by_schedule Группа номеров неактивна согласно расписанию
sip_offline SIP-линия не зарегистрирована
employee_inactive Сотрудник неактивен
employee_inactive_by_schedule Сотрудник неактивен согласно расписанию
employee_phone_inactive Номер сотрудника неактивен
employee_phone_inactive_by_schedule Номер сотрудника неактивен согласно расписанию
action_interval_exceeded Превышен интервал, указанный на операции
group_phone_inactive Номер в группе недоступен
no_operator_confirmation Сотрудник не подтвердил вызов
max_transition_count_exceeded Достигнуто максимальное количество переходов по операциям сценария
disconnect_before_call_processing Разъединение до обработки вызова
no_success_subscriber_call Не дозвонились до абонента
no_success_operator_call Не дозвонились до сотрудника
group_inactive_by_schedule Группа сотрудников неактивна согласно расписанию
net_lock Сеть оператора заблокирована
fmc_is_disabled Услуга FMC отключена
fmc_is_locked FMC-линия заблокирована
processing_method_not_found Способ обработки не найден
employee_without_phones
group_without_phones
no_operator_cdr_found Вызовы сотрудникам не найдены
in_call_not_allowed Прием входящих звонков запрещен
phone_protocol_not_allowed_by_status Звонки с данного типа номера запрещены статусом
employee_status_break Сотрудник в статусе "Перерыв"
employee_status_do_not_disturb Сотрудник в статусе "Не беспокоить"
employee_status_not_at_workplace Сотрудник в статусе "Нет на месте"
employee_status_not_at_work Сотрудник в статусе "Нет на работе"
sip_trunk_is_locked SIP-транк заблокирован
numa_in_spam_list Спам-звонок
numa_dnd_interval Звонили недавно
limit_exceeded Достигнут финансовый лимит
no_money Недостаточно средств
out_call_not_allowed Исходящие звонки запрещены
out_call_not_allowed_by_status Исходящие звонки запрещены статусом
external_call_not_allowed Внешние звонки запрещены
external_call_not_allowed_by_status Внешние звонки запрещены статусом
internal_call_not_allowed Внутренние звонки запрещены
internal_call_not_allowed_by_status Внутренние звонки запрещены статусом
call_enqueued Вызов поставлен в очередь
employee_status_auto_out_call Сотрудник в статусе "Исходящий обзвон"
employee_status_available Сотрудник в статусе "Доступен"
too_many_identical_incoming_calls Слишком много одинаковых входящих звонков
employee_auto_status_do_not_disturb Сотрудник в автоматическом статусе "Не беспокоить"
auto_out_calls_not_allowed_by_status Исходящий обзвон запрещен статусом

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

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

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

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

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

    },
    "data": [
      {
        "id": "number",
        "start_time": "iso8601",
        "finish_time": "iso8601",
        "virtual_phone_number": "string",
        "is_transfer": "boolean",
        "finish_reason": "enum",
        "direction": "enum",
        "source": "enum",
        "communication_number": "number",
        "communication_page_url": "string",
        "communication_id": "number",
        "communication_type": "enum",
        "is_lost": "boolean",
        "cpn_region_id": "number",
        "cpn_region_name": "string",
        "wait_duration": "number",
        "total_wait_duration": "number",
        "lost_call_processing_duration" :"number",
        "talk_duration": "number",
        "clean_talk_duration": "number",
        "total_duration": "number",
        "postprocess_duration": "number",
        "ua_client_id": "string",
        "ym_client_id": "string",
        "sale_date": "iso8601",
        "sale_cost": "number",
        "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",
        "site_id": "number",
        "site_domain_name": "string",
        "campaign_id": "number",
        "campaign_name": "string",
        "auto_call_campaign_name": "string",
        "visit_other_campaign": "boolean",
        "visitor_id": "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",
        "last_answered_employee_id": "number",
        "last_answered_employee_full_name": "string",
        "last_answered_employee_rating": "number",
        "first_answered_employee_id": "number",
        "first_answered_employee_full_name": "string",
        "scenario_id": "number",
        "scenario_name": "string",
        "call_api_external_id": "string",
        "call_api_request_id": "number",
        "contact_phone_number": "string",
        "contact_full_name": "string",
        "contact_id": "number",
        "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": [

        ],
        "call_records": [

        ],
        "voice_mail_records": [

        ],
        "recognized_text": [
          {
            "id": "number",
            "phrase": "string",
            "start_time": "iso8601",
            "is_operator": "boolean",
            "edited_phrase": "string"
          }
        ],
        "tags": [
          {
            "tag_id": "number",
            "tag_name": "string",
            "tag_type": "enum",
            "tag_change_time": "iso8601",
            "tag_user_id": "number",
            "tag_user_login": "string",
            "tag_employee_id": "number",
            "tag_employee_full_name": "string"
          }
        ],
        "visitor_custom_properties": [
          {
            "property_name": "string",
            "property_value": "string"
          }
        ],
        "segments": [
          {
            "segment_id": "number",
            "segment_name": "string"
          }
        ],
        "employees": [
          {
            "employee_id": "number",
            "employee_full_name": "string",
            "is_answered": "boolean"
          }
        ],
        "operator_phone_number": "string",
        "scenario_operations": [
          {
            "name": "string",
            "id": "number"
          }
        ],
        "source_id": "number",
        "source_name": "string",
        "source_new": "string",
        "channel_new": "string",
        "channel_code": "string",
                "ext_id": "string"
      }
    ]
  }
}

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

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