Метод для получения статистики об обзвоне

Параметр

Обязательно

Описание

fields

Да

Через «=» указываются поля, которые нужно получить от системы отчетности. Сами поля перечисляются через запятую.

Список полей:

id – идентификатор звонка;

phone – номер телефона клиента;

duration – длительность диалога;

taskId – идентификатор задания на обзвон;

taskName – имя задания на обзвон;

botId – идентификатор работавшего бота;

botName – имя работавшего бота;

regionId – идентификатор региона, в котором оформлен номер телефона клиента;

timezone – часовой пояс номера телефона клиента;

status – статус результата дозвона телефонии;

responder – тип ответившего на звонок, при работающем модуле определения автоответчиков;

shortNumber -

transferredToOperator – признак отвечающий за то, был перевод звонка на оператора КЦ или нет;

linkToLog – ссылка на лог звонка, по которой разбирают различные ситуации наши инженеры;

createdAt – дата и время создания записи;

updatedAt – дата и время обновления любой информации по записи;

startedAt – дата и время запуска звонка;

price – стоимость диалога;

messages – текстовая транскрибация всего диалога, по ролям и доп информацией о реплике каждого участника диалога;

messagesAsString - текстовая транскрибация всего диалога, по ролям, без доп информации;

recordPath – ссылка на аудиозапись диалога;

externalId – информация, переданная в информации о клиенте, на этапе загрузки;

additional – дополнительная информация, переданная в информации о клиенте, на этапе загрузки;

dialogResults – результат диалога бота, указанный в поле «Подтверждения» в сценарии диалога;

nps - результат диалога бота, указанный в поле «NPS» в сценарии диалога;

isFinished – признак отвечающий за то, будут ли на данного клиента еще попытки дозвона, или данная попытка была последней.

from

Нет

Дата и время, начала диапазона времени, за которое нужно получить статистику.

!!! Необходима конвертация в url (например метод в Python: urllib.parse.quote(test_str))
Для примера: 2022-03-01T21%3A30%3A54%2B00%3A00

to

Нет

Дата и время, окончания диапазона времени, за которое нужно получить статистику.

!!! Необходима конвертация в url (например метод в Python: urllib.parse.quote(test_str))
Для примера: 2022-03-01T21%3A30%3A54%2B00%3A00

limit

Нет

Ограничение количества данных, которые нужно получить.

Максимум: 1 000

offset

Нет

Смещение по позиции полученной информации.

Например, в заданное временное окно было 4 050 звонков. Сделав запрос вы получили доступный максимум, в виде 1 000 записей. Тогда вам нужно повторить запрос, с указанием последней полученной позиции. Получив 1 000 записей, 1 000 и есть наша последняя позиция. Получив еще раз максимальное количество, повторяем запрос указав смешение уже на 2 000 позиций.

Делаем смещение до тех пор, пока количество возвращенных данных не будет меньше запрошенному лимиту.

sort

Нет

Поле, по которому вы хотите отсортировать получаемые данные.

Сортировка доступна по полям: createdAt, updatedAt, startedAt, duration.

«+» сортировка по возрастанию;

«-» сортировка по убыванию.

Поле

Тип

Описание

count

int

Общее количество звонков

items

itemsInfo[

]

Массив информации по каждому звонку

timezone

int

Часовой пояс номера телефона клиента

additional

string

Дополнительная информация, переданная в информации о клиенте, на этапе загрузки

startedAt

string

Дата и время запуска звонка

transferredToOperator

bool

Признак, отвечающий за то, был перевод звонка на оператора КЦ или нет

dialogId

string

Идентификатор диалога

duration

int

Длительность диалога в секундах

createdAt

string

Дата и время создания записи

price

string

Стоимость диалога

dialogResults

string

Результат диалога бота, указанный в поле «Подтверждения» в сценарии диалога

id

string

Идентификатор звонка

botId

string

Идентификатор работавшего бота

recordPath

string

Ссылка на аудиозапись диалога

updatedAt

string

Дата и время обновления информации по записи

botName

string

Имя работавшего бота

externalId

string

Информация, переданная в информации о клиенте, на этапе загрузки

responder

string

Тип ответившего на звонок, при работающем модуле определения автоответчиков

isFinished

bool

Признак, отвечающий за то, будут ли на данного клиента еще попытки дозвона, или данная попытка была последней

nps

string

Результат диалога бота, указанный в поле «NPS» в сценарии диалога

shortNumber

string

"Короткий" номер клиента (используется для sip-телефонии)

phone

string

Номер телефона клиента

regionId

int

Идентификатор региона, в котором оформлен номер телефона клиента

taskName

string

Имя задания на обзвон

taskId

string

Идентификатор задания на обзвон

linkToLog

string

Ссылка на лог звонка, по которой разбирают различные ситуации наши инженеры

status

string

Статус результата дозвона телефонии

messages

messagesInfo[

]

Массив с транскрибацией диалога по ролям и с доп информацией

text

string

Транскрибация реплики author

author

string

Роль того, кто произнес реплику (клиент или робот)

created_at

string

Дата начала озвучивания реплики

messagesAsString

string

Текстовая транскрибация всего диалога, по ролям, без доп информации