Получение статистики по заданию

Метод: GET

Authorization: Bearer Token (Метод для получения токена по логину и паролю)

URL: https://tcl.twin24.ai/api/analyse/v1/search/cis/sessions

cURL (пример)

curl --location 'https://tcl.twin24.ai/api/analyse/v1/search/cis/sessions?fields=taskName%2Cid%2Camd%2CtaskId%2Cnumber%2CbotName%2CvariablesString%2CresultsString%2CdialogResult%2CvariablesString&limit=100&from=2024-01-01T00%3A00%3A00%2B00%3A00&to=2024-02-01T00%3A00%3A00%2B00%3A00&offset=0&page=1&companyId=0001&callingNumber=70000000000&isIncoming=false&status=ANSWERED' \
--header 'accept: application/json' \
--header 'Authorization: Bearer TOKEN'

Описание параметров метода:

Поле	Обязательно	Принимаемые значения	Описание
fields	да	id taskName taskId createdAt startedAt finishedAt billedAt updatedAt speakerFinishedAt number callingNumber botId botName timezone messagesAsString resultsString variablesString clientExternalId dialogResult advStatus_ru nps duration externalId recordPath currentStatusName mainCallDiscount mainCallDuration robotCallDuration transferCallDuration companyId companyName price resellerPrice resellerCompanyId resellerCompanyName mainCallCost mainCallTotalCost robotCallCost robotCallTotalCost transferCallCost transferCallTotalCost isIncoming amd autoCallCandidateId	Параметр, отвечающий поля будут отображены в ответе. Поля указываются через запятую.
limit	нет	Целое число от 1 до 1000	Количество записей на одной странице. Максимум 1000.
offset	нет	Целое число от 0	"Отступ" от начала записей. То есть с какой записи начинать вывод.
page	нет	Целое число от 0	Номер "страницы" с записями.
from	нет	url encoded дата в формате: `ГГГГ-ММ-ДДTчч:мм:сс+чч:мм` Например: decoded: `2023-06-13T00:00:00+00:00` encoded: `2023-06-13T00%3A00%3A00%2B00%3A00`	Дата и время начала поиска статистики.
to	нет	url encoded дата в формате: `ГГГГ-ММ-ДДTчч:мм:сс+чч:мм` Например: decoded: `2023-06-13T00:00:00+00:00` encoded: `2023-06-13T00%3A00%3A00%2B00%3A00`	Дата и время конца поиска статистики.
companyId	нет	целое число	Идентификатор компании в TWIN. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.
phone	нет	целое число	Номер телефона. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.
isIncoming	нет	true/false	true - если входящие; false - если исходящие. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.
sort	нет	createdAt, startedAt, finishedAt, billedAt, speakerFinishedAt, duration, price. По умолчанию сортировка происходит по полю startedAt.	Каждое поле сортировки может иметь специальный префикс, указывающий желаемый порядок сортировки: + (по возрастанию, по умолчанию) или - (по убыванию).
taskId	нет	целое число	Идентификатор задания на обзвон. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.
id	нет	целое число	Идентификатор звонка. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.
status	нет	CANCEL, ANSWERED, NOANSWER, BUSY, CONGESTION, CHANUNAVAIL, FAILED, BLACKLIST, DIAL, INPROGRESS, FZ230, INVALID, UNAVAILABLE, EMPTY_AON	Текущий статус звонка. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.
FilterPeriodBy	нет	createdAt, updatedAt, startedAt. По умолчанию используется поле startedAt. Дата в формате ISO8601	Фильтрации по начальной и конечной датам.
autoCallCandidateId	нет	целое число	Идентификатор кандидата. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.

Ответ в формате JSON

{
    "count": 1,
    "items": [
        {
            "id": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "taskName": "TWIN TEST",
            "taskId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "createdAt": "2024-01-01T00:00:18.722982Z",
            "startedAt": "2024-01-01T00:00:18.722136Z",
            "finishedAt": "2024-01-01T00:00:38.484110Z",
            "billedAt": "2024-01-01T00:00:57.902230Z",
            "updatedAt": "2024-01-01T00:00:57.908504Z",
            "speakerFinishedAt": "2024-01-01T00:00:38.484000Z",
            "number": "70000000000",
            "callingNumber": "70000000001",
            "botId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "botName": "TWIN BOT",
            "timezone": 10800,
            "messagesAsString": "BOT:  Добрый день, как ваши дела? \nCLIENT: Привет, дела - хорошо.",
            "resultsString": "{\"nps\": \"Успех\", \"confirmation\": \"Успех\"}",
            "variablesString": "{\"tryNumber\": 0, \"recordPath\": \"https://tcl.twin24.ai/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download\", \"humanNumber\": 0, \"resultNumber\": 0, \"tryCandidate\": 0, \"answeredNumber\": 0, \"humanCandidate\": 0, \"resultCandidate\": 0, \"answeredCandidate\": 0}",
            "dialogResult": "Успех",
            "advStatus_ru": "Успешный",
            "nps": "Успех",
            "duration": 17,
            "externalId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "clientExternalId": null,
            "recordPath": "https://minio.twin24.ai/twin-cis-production/records/1672/2024/1/1/0000000000000000000000000_1_1.mp3",
            "currentStatusName": "ANSWERED",
            "mainCallDiscount": "0",
            "mainCallDuration": 17,
            "robotCallDuration": 17,
            "transferCallDuration": 0,
            "companyId": 1758,
            "companyName": "0001 | ТВИН: TEST",
            "price": "0.0",
            "resellerPrice": "0.000000",
            "resellerCompanyId": null,
            "resellerCompanyName": null,
            "mainCallCost": "0.00",
            "mainCallTotalCost": "0.0",
            "robotCallCost": "0.00",
            "robotCallTotalCost": "0.0",
            "transferCallCost": "0",
            "transferCallTotalCost": null,
            "isIncoming": false,
            "amd": "NOT_DEF",
            "autoCallCandidateId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd"
        }
    ]
}

Описание полей ответа:

Поле	Описание	Тип поля
count	Общее количество записей.	Integer
items	Массив записей.	Array[Object]
\| id	Идентификатор звонка.	String
\| taskName	Имя задания на обзвон.	String
\| taskId	Идентификатор задания на обзвон.	String
\| createdAt	Дата и время создания задания на обзвон.	String
\| startedAt	Дата и время запуска задания на обзвон.	String
\| finishedAt	Дата и время окончания задания на обзвон.	String
\| billedAt	Дата и время расчета стоимости выполнения задания на обзвон.	String
\| updatedAt	Дата и время последнего обновления задания на обзвон.	String
\| speakerFinishedAt	Дата и время окончания разговора.	String
\| number	Номер с которого звонили клиенту.	String
\| callingNumber	Номер на который звонили клиенту.	String
\| botId	Идентификатор сценария бота, использованного в задании на обзвон.	String
\| botName	Имя сценария бота.	String
\| timezone	Смещение временной зоны в секундах относительно UTC.	Integer
\| messagesAsString	Транскрибация диалога.	String
\| resultsString	Сохраненные в блоке "Результат" данные: Подтверждение; NPS.	String
\| variablesString	Сохраненные переменные.	String
\| dialogResult	Значение из блока "Результат" при выборе "Зафиксировать результативность": "Успех" или "null".	String
\| advStatus_ru	Значение из блока "Результат" при выборе "Зафиксировать результативность": "Успешно".	String
\| nps	Значение из блока "Результат" в NPS.	String
\| duration	Продолжительность звонка в секундах.	Integer
\| externalId	Внутренний системный идентификатор.	String
\| clientExternalId	Внешний идентификатор клиента.	Boolean
\| recordPath	Веб-адрес записи разговора.	String
\| currentStatusName	Текущий статус задания на обзвон. Возможные значения: CANCEL – Отменен ANSWERED – Успешный; NOANSWER – Нет ответа; BUSY – Абонент занят; CONGESTION – Вызов отклонен оператором связи; CHANUNAVAIL – Нет связи с телефонной линией; FAILED – Ошибка; SCHEDULED – Запланирован; BLACKLIST – В черном списке; DIAL – Набор номера; INPROGRESS – В процессе; FZ230 – Запрет звонка по ФЗ-230; INVALID – Ошибка формата номера; UNAVAILABLE – Номер недоступен; EXPIRED – Срок ожидания соединения истек.	String
\| mainCallDiscount	Скидка за разговор (транк клиента).	String
\| mainCallDuration	Длительность разговора (транк клиента) в секундах.	Integer
\| robotCallDuration	Продолжительность работы робота в секундах.	Integer
\| transferCallDuration	Длительность звонка после перевода в секунадх.	Integer
\| companyId	Идентификатор компании.	Integer
\| companyName	Идентифиактор компании и имя компании.	String
\| price	Стоимость всего разговора.	String
\| resellerPrice	Стоимость разговора для реселлера.	String
\| resellerCompanyId	Идентификатор компании реселлера.	Boolean
\| resellerCompanyName	Имя компании реселлера.	Boolean
\| mainCallCost	Общая стоимость звонка.	String
\| mainCallTotalCost	Общая стоимость звонка.	String
\| robotCallCost	Стоимость распознавания роботом.	String
\| robotCallTotalCost	Стоимость разговора робота со скидкой.	String
\| transferCallCost	Стоимость разговора после перевода.	String
\| transferCallTotalCost	Стоимость разговора после перевода со скидкой.	Boolean
\| isIncoming	Входящий/Исходящий вызов (true/false).	Boolean
\| amd	Режим работы определителя человека или робота.	String
\| autoCallCandidateId	Идентификатор кандидата.	String

Поле	Тип	Обязательно	Описание
count	int	да	Общее количество записей.
items	Array[Object]	да	Массив записей.
\| id	string	нет	Идентификтор звонка.
\| taskName	string	нет	Имя задания на обзвон.
\| taskId	string	нет	Идентификатор задания на обзвон.
\| createdAt	string	нет	Дата и время создания задания на обзвон.
\| startedAt	string	нет	Дата и время запуска задания на обзвон.
\| finishedAt	string	нет	Дата и время окончания выполнения задания на обзвон.
\| billedAt	string	нет	Дата и время расчёта стоимости выполнения задания на обзвон.
\| updatedAt	string	нет	Дата и время последнего обновления задания на обзвон.
\| speakerFinishedAt	string	нет	Дата и время окончания разговора.
\| number	string	нет	Номер с которого звонили клиенту.
\| callingNumber	string	нет	Номер на который звонили клиенту.
\| dialogResult	string	нет	Записывается значение из блока "Результат" в котором выбрано "Зафиксировать результативность". Может принимать значения: "Успех"; "null".
\| advStatus_ru	string	нет
\| botId	string	нет	ID сценария бота, который использовался в задании на обзвон.
\| nps	string	нет
\| duration	string	нет
\| botName	string	нет	Имя сценария бота.
\| timezon	string	нет	Cмещение временной зоны в секундах относительно координированного всемирного времени (UTC)
\| messagesAsString	string	нет	Транскрибация диалога.
\| resultsString	string	нет	Содержит сохраненные в блоке "Результат": Подтверждение; NPS.
\| variablesString	string	нет	Содержит сохраненные переменные.

\| taskStatus	string	нет	Статус задания на обзвон. Возможные значения: ERROR_PREPARING – Ошибка подготовки PREPARING – Подготавливается к запуску MAX_CPS – Превышен лимит CPS для аккаунта. Приостановлено TIMEOUT – Таймаут обзвона. Аварийное завершение PAUSED_NO_ROUTE – Приостановлено. Нет маршрутов для вызовов READY – Готово к запуску PAUSED_SCHEDULE – Приостановлено. По расписанию HALTED – Остановлено навечно PAUSED_NOBODY – Приостановлено. Некому звонить на данный момент DELETING – В процессе удаления PAUSED_NO_MONEY – Закончились деньги. Приостановлено PAUSED – Приостановлено PROCESS – В процессе обзвона DONE – Обзвон завершен BLANK – Пустое задание (обзвон невозможен)
\| 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	нет	Текущий статус диалога. Возможные значения: CANCEL – Отменен ANSWERED – Успешный NOANSWER – Нет ответа BUSY – Абонент занят CONGESTION – Вызов отклонен оператором связи CHANUNAVAIL – Нет связи с телефонной линией FAILED – Ошибка SCHEDULED – Запланирован BLACKLIST – В черном списке DIAL – Набор номера INPROGRESS – В процессе FZ230 – Запрет звонка по ФЗ-230 INVALID – Ошибка формата номера UNAVAILABLE – Номер недоступен EXPIRED – Срок ожидания соединения истек
\| humanStatusName	string	нет	Текстовая расшифровка статуса диалога. Возможные значения: На русском: Отменен Успешный Нет ответа Абонент занят Вызов отклонен оператором связи Нет связи с телефонной линией Ошибка Запланирован В черном списке Набор номера В процессе Запрет звонка по ФЗ-230 Ошибка формата номера Номер недоступен Срок ожидания соединения истек На английском: Canceled Answered No answer Busy Congestion Channel unavailable Failed Scheduled Blacklisted Dialing In progress Prohibited by FZ-230 Invalid number fromat Unavailable Connection expired
\| 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 реестр)

Быстрые ссылки

Дерево страниц