Метод: GET
Authorization: Bearer Token (Метод для получения токена по логину и паролю)
URL: https://tcl.twin24.ai/api/analyse/v1/search/cis/sessions
Описание параметров метода:
Поле | Обязательно | Принимаемые значения | Описание |
---|---|---|---|
fields | да |
| Параметр, отвечающий по каким полям будет осуществляться поиск сессий. Можно использовать больше одного поля, поля оказываются через запятую. |
to | нет | url encoded дата в формате:
Например: decoded: encoded: | Дата и время конца поиска статистики. Поле, по которому высчитывается дата, указывается в параметре |
fields | нет | Любые значения, перечисленные через запятую без пробела: taskName,taskId,taskCreatedAt,taskUpdatedAt,taskStatus,callId,startedAt,number,callingNumber, | Список полей, которые необходимо вывести. Если не передавать параметр, то будут выведены все поля, кроме variables. variables-var_name - поле, содержащее значение стартовой переменной с именем var_name, переданной при добавлении кандидата (как через апи метод, так и через интерфейс или excell реестр) |
limit | нет | Целое число от 1 до 1000 | Количество записей на одной странице. Максимум 1000. |
offset | нет | Целое число от 0 | "Отступ" от начала записей. То есть с какой записи начинать вывод. |
page | нет | Целое число от 0 | Номер "страницы" с записями. |
archive | нет | true/false | Упаковать выданный файл в архив. Актуально только при наличии output. |
output | нет | CSV/EXCEL | Выдать файл в CSV или EXCEL. Если не передавать, то в ответе будет json. |
filename | нет | Строка | Название файла. Актуально только при наличии output. |
callId | нет | Идентификатор | Фильтрация по идентификатору звонка. |
withPrice | нет | true/false | Если true, то в ответе будут звонки только с ненулевой стоимостью. |
sort | нет | +startedAt, +duration, -startedAt, -duration | Способ сортировки и поле, по которому будет сортировка. "+" - по возрастанию. "-" - по убыванию. |
periodBy | нет | createdAt, updatedAt, startedAt, finishedAt, billedAt | Поле, по которому будет работать фильтрация по from и to. По умолчанию: startedAt. Рекомендуется использовать createdAt, как наиболее эффективный. |
autoCallCandidateId | нет | Идентификатор | Фильтрация по идентификатору кандидата. |
taskId | нет | Идентификатор | Фильтрация по идентификатору задания. |
Описание полей ответа:
Поле | Тип | Обязательно | Описание |
---|---|---|---|
count | int | да | Общее количество записей. |
items | Array[Object] | да | Массив записей. |
| taskName | string | нет | Имя задания на обзвон. |
| taskId | string | нет | Идентификатор задания на обзвон. |
| taskCreatedAt | string | нет | Дата создания задания на обзвон. |
| taskUpdatedAt | string | нет | Дата последнего обновления в задании на обзвон. |
| taskStatus | string | нет | Статус задания на обзвон. Возможные значения:
|
| callId | string | нет | Идентификатор звонка. |
| startedAt | string | нет | Дата и время начала звонка. |
| number | string | нет | Номер телефона, на который был вызов. |
| callingNumber | string | нет | Номер телефона, с которого был вызов. |
| botId | string | нет | Идентификатор бота. |
| botName | string | нет | Имя бота. |
| regionName | string | нет | Регион вызываемого абонента. |
| timezone | int | нет | Таймзона вызываемого абонента. |
| messagesAsString | string | нет | Сообщения диалога строкой. |
| messages | Array[Object] | нет | Массив сообщений. |
| | authorType | string | нет | Тип автора сообщения (BOT, CLIENT). |
| | createdAt | string | нет | Дата создания сообщения. |
| | body | string | нет | Текс сообщения. |
| resultsString | string | нет | Значение из поля "Подтверждение результата". |
| allResults | Object | нет | Объект с результатами разговора. Обязательно включает поля "nps" и "confirmation". Опционально (при наличии) включает поля со значением произвольных реультатов. |
| emotion | string | нет | Определенная эмоция. |
| hungUpBy | string | нет | Кто "повесил трубку". Возможные значения:
|
| gender | string | нет | Определенный гендер. |
| nps | string | нет | Значение из поля "nps". |
| isAssistantRequest | string | нет | Запросил ли бот помощь. |
| markers | string | нет | Маркеры. |
| duration | int | нет | Длительность разговора. |
| externalId | string | нет | Внутренний системный идентификатор. |
| clientExternalId | string | нет | Внешний идентификатор клиента, заданный при добавлении кандидата (как через апи метод, так и через интерфейс или excell реестр). |
| additional | string | нет | Дополнительные данные о диалоге. |
| recordPath | string | нет | Ссылка на аудиозапись диалога. |
| currentStatusName | string | нет | Текущий статус диалога. Возможные значения:
|
| humanStatusName | string | нет | Текстовая расшифровка статуса диалога. Возможные значения: На русском:
На английском:
|
| mainCallDiscount | string | нет | Скидка за разговор (транк клиента). |
| mainCallDuration | int | нет | Длительность разговора (транк клиента). |
| autoCallCost | string | нет | Всегда равен 0. |
| autoCallDiscount | string | нет | Всегда равен 0. |
| autoCallDuration | int | нет | Всегда равен 0. |
| autoCallTotalCost | string | нет | Всегда равен 0. |
| robotCallDiscount | string | нет | Скидка за разговор робота. |
| robotCallDuration | int | нет | Длительность разговора робота. |
| transferCallDiscount | string | нет | Скидка за перевод звонка. |
| transferCallDuration | int | нет | Длительность звонка после перевода. |
| companyId | int | нет | Идентификатор компании. |
| autoCallCandidateId | string | нет | Идентификатор кандидата. |
| amd | string | нет | Результат работы amd (система определения автоответчиков). Возможные значения:
|
| isCallEfficiency | string | нет | Результативность вызова. Возможные значения:
|
| totalCost | string | нет | Стоимость диалога. |
| mainCallCost | string | нет | Стоимость разговора (транк клиента). |
| mainCallTotalCost | string | нет | Стоимость разговора робота со скидкой. |
| robotCallCost | string | нет | Стоимость разговора робота. |
| robotCallTotalCost | string | нет | Стоимость разговора робота со скидкой. |
| transferCallCost | string | нет | Стоимость разговора после перевода. |
| transferCallTotalCost | string | нет | Стоимость разговора после перевода со скидкой. |
| variables-name | string | нет | variables-var_name - поле, содержащее значение стартовой переменной с именем var_name, переданной при добавлении кандидата (как через апи метод, так и через интерфейс или excell реестр) |