Поиск информации по сессиям

Метод: GET

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

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

cURL (пример)

curl -X GET "https://tcl.twin24.ai/api/analyse/v1/search/cis/sessions?id=687bec28-1b47-42df-955c-b88b40b2cb75" -H "accept: application/json"

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

Поле	Обязательно	Принимаемые значения	Описание
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 Поле	Параметр, отвечающий по каким полям будет осуществляться поиск сессий. Можно использовать больше одного поля, поля оказываются через запятую.
to	нет	url encoded дата в формате: `ГГГГ-ММ-ДДTчч:мм:сс+чч:мм` Например: decoded: `2023-06-13T00:00:00+00:00` encoded: `2023-06-13T00%3A00%3A00%2B00%3A00`	Дата и время конца поиска статистики. Поле, по которому высчитывается дата, указывается в параметре `periodBy`. По умолчанию – `startedAt`.
fields	нет	Любые значения, перечисленные через запятую без пробела: taskName,taskId,taskCreatedAt,taskUpdatedAt,taskStatus,callId,startedAt,number,callingNumber, botId,botName,regionName,timezone,messagesAsString,messages,resultsString,allResults,emotion, hungUpBy,gender,nps,isAssistantRequest,markers,duration,externalId,clientExternalId,additional, recordPath,currentStatusName,humanStatusName,mainCallDiscount,mainCallDuration,autoCallCost, autoCallDiscount,autoCallDuration,autoCallTotalCost,robotCallDiscount,robotCallDuration,transferCallDiscount, transferCallDuration,companyId,autoCallCandidateId,amd,isCallEfficiency,mainCallTotalCost,robotCallTotalCost, transferCallTotalCost,totalCost,mainCallCost,robotCallCost,transferCallCost,variables-count	Список полей, которые необходимо вывести. Если не передавать параметр, то будут выведены все поля, кроме 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	нет	Идентификатор	Фильтрация по идентификатору задания.

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

{
    "count": 1,
    "items": [
        {
            "taskName": "Имя задания на обзвон",
            "taskId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "taskCreatedAt": "2024-01-16 02:01:10+00",
            "taskUpdatedAt": "2024-01-16 02:03:18+00",
            "taskStatus": "DONE",
            "callId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "startedAt": "2024-01-16 02:01:31",
            "number": "74992868344",
            "callingNumber": "74992868344",
            "botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "botName": "Имя сценария бота",
            "regionName": "г. Москва",
            "timezone": 3,
            "messagesAsString": "BOT: Привет! Как дела, Иван?\nCLIENT: нормально\nBOT: Хорошо, пока!",
            "messages": [
                {
                    "authorType": "BOT",
                    "createdAt": "2024-01-16T02:01:37.135151+00:00",
                    "body": "Привет! Как дела, Иван?"
                },
                {
                    "authorType": "CLIENT",
                    "createdAt": "2024-01-16T02:01:43.098529+00:00",
                    "body": "нормально"
                },
                {
                    "authorType": "BOT",
                    "createdAt": "2024-01-16T02:01:43.197626+00:00",
                    "body": "Хорошо, пока!"
                }
            ],
            "resultsString": "Подтверждение: Значение поля 'подтверждение результата'",
            "allResults": {
                "nps": "Значение поля NPS",
                "custom_result": "Значение поля 'произвольный результат' с ключом custom_result",
                "confirmation": "Значение поля 'подтверждение результата'"
            },
            "emotion": null,
            "hungUpBy": "Робот",
            "gender": null,
            "nps": "Значение поля NPS",
            "isAssistantRequest": null,
            "markers": "Первый маркер;Второй маркер;Третий маркер",
            "duration": 39,
            "externalId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "clientExternalId": "123",
            "additional": null,
            "recordPath": "https:///#/record/bce7d22e-dde6-4427-b391-ebbdfda44de6/download",
            "currentStatusName": "ANSWERED",
            "humanStatusName": "Answered",
            "mainCallDiscount": "0",
            "mainCallDuration": 39,
            "autoCallCost": "0",
            "autoCallDiscount": "0",
            "autoCallDuration": "0",
            "autoCallTotalCost": "0",
            "robotCallDiscount": "0",
            "robotCallDuration": 39,
            "transferCallDiscount": "0",
            "transferCallDuration": 0,
            "companyId": 1,
            "autoCallCandidateId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "amd": "Не проверялось",
            "isCallEfficiency": "Результативный",
            "mainCallTotalCost": "0.85",
            "robotCallTotalCost": "1.30",
            "transferCallTotalCost": null,
            "totalCost": "2.145000",
            "mainCallCost": "1.30",
            "robotCallCost": "2.00",
            "transferCallCost": "0",
            "variables-name": "Иван"
        }
    ]
}

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

Поле	Тип	Обязательно	Описание
count	int	да	Общее количество записей.
items	Array[Object]	да	Массив записей.
\| taskName	string	нет	Имя задания на обзвон.
\| taskId	string	нет	Идентификатор задания на обзвон.
\| taskCreatedAt	string	нет	Дата создания задания на обзвон.
\| taskUpdatedAt	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 реестр)

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

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