Skip to content

Получение детализированного отчёта истории списаний по всем плечам звонковых сессий

Получение детализированного отчёта истории списаний по всем плечам звонковых сессий

Метод get.financial_call_legs_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 Дата окончания выборки

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
start_time iso8601 YYYY-MM-DD hh:mm:ss да да Дата и время плеча
direction enum
  • in - Входящие;
  • out - Исходящие
да да да Направление плеча
source enum
  • callapi - Call API;
  • callapi_informer_call - Call API информационный звонок;
  • callapi_scenario_call - Call API вызов сценария
  • callback - Callback;
  • callout - Callout;
  • call_tracking- Аналитика;
  • dynamic_call_tracking - Динамический коллтрекинг;
  • va - Виртуальная АТС;
  • sip - Исходящий с SIP;
  • consultant - Звонок через Консультант;
  • lead - Звонок через Лидогенератор;
  • sitephone - Звонок через Сайтфон;
  • faxout - Исходящий факс;
  • retailcrm - retailCRM
да да да Источник плеча
call_session_id number да да да Уникальный идентификатор сессии звонка, см. метод "get.calls_report"
leg_id number да да да Уникальный идентификатор звонка, см. метод "get.call_legs_report"
В рамках одной сессии звонка возможно несколько вызовов
calling_phone_number string да да да Номер телефона звонящего
called_phone_number string да да да Номер телефона на который звонили
duration number да да да Продолжительность звонка, значение в секундах
chargeable_duration number да да да Тарифицированная длительность звонка, значение в секундах
direction_type enum
  • international - Международные;
  • national - Междугородние;
  • local - Местные (Москва и Московская область);
  • mobile - Мобильные
да да да Тип направления звонка
cost_per_minute number да да да Стоимость за минуту
total_charge number да да да Общая стоимость звонка
bonuses_charge number да да да Оплачено бонусами

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

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

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

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

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

    },
    "data":[
      {
        "start_time":"iso8601",
        "direction":"enum",
        "source":"enum",
        "call_session_id":"string",
        "leg_id":"number",
        "calling_phone_number":"string",
        "called_phone_number":"string",
        "duration":"number",
        "chargeable_duration":"number",
        "direction_type":"enum",
        "cost_per_minute":"number",
        "total_charge":"number",
        "bonuses_charge":"number"
      }
    ]
  }
}

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

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