...
Блок кода | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
curl --Xlocation GET "'https://tcl.twin24.ai/api/analyse/v1/search/cis/sessions?id=687bec28-1b47-42df-955c-b88b40b2cb75" -H "accept: application/json"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 |
| Параметр, отвечающий |
Можно использовать больше одного поля, поля оказываются через запятую. Значение каждого поля можно посмотреть в примере ответа.
за то, какие поля будут отображены в ответе. Поля указываются через запятую. |
limit |
Целое число от 1 до |
1 000 | Количество записей на одной странице. Максимум 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
Дата и время начала поиска статистики.
url encoded дата в формате:
Смещение по позиции полученной информации. | ||
| Целое число от 0 | Номер «страницы» с записями. |
| url encoded дата в формате - |
Например: Начало периода в формате decoded: |
Дата и время |
фильтрации по начальной и конечной датам.
, от которой требуется провести поиск статистики в формате encoded. | ||||
to | url encoded дата в формате - Например: Начало периода в формате decoded: В запросе требуется использовать дату и время в формате encoded. | Дата и время, до которой требуется провести поиск статистики в формате encoded. | ||
companyId | Целое число | Идентификатор компании в TWIN. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ. | ||
phone | Целое число | Номер телефона, на который идет звонок. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.
| ||
callingNumber | Целое число | Номер телефона, с которого идет звонок. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.
| ||
isIncoming | true / false |
*Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ. | ||
sort |
По умолчанию сортировка происходит по полю | Для сортировки результатов запроса доступны следующие поля:
По умолчанию сортировка происходит по полю Для указания желаемого порядка сортировки используются специальные префиксы:
Например, чтобы отсортировать звонки в порядке убывания, ориентируясь на дату и время завершенного звонка, нужно указать: | ||
taskId | Значение string | Идентификатор задания на обзвон. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ. | ||
id | Значение string | Идентификатор звонка. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ. | ||
status | Возможные значения:
| Текущий статус звонка. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ. | ||
FilterPeriodBy | createdAt , updatedAt , startedAt По умолчанию используется поле startedAt . | Выбор поля, к которому будет применяться фильтрация по датам из полей | ||
autoCallCandidateId | Значение string | Идентификатор кандидата. Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ. |
Блок кода | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"count": 1,
"items": [
{ | ||||||||
Блок кода | ||||||||
| ||||||||
{ "count": 1, "items": [ { "id": "687bec28-1b47-42df-955c-b88b40b2cb75", "taskName": "999", "taskId": "c8e64c09-8d3e-4c5f-9403-5f57b085de5b", "createdAt": "2023-07-31T22:00:31.666566Z", "startedAt": "2023-07-31T22:00:31.665221Z", "finishedAt": "2023-07-31T22:00:44.483259Z", "billedAtid": "2023-07-31T22:01:01.795661Zdb5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "updatedAttaskName": "2023-07-31T22:01:01.804529ZTWIN TEST", "speakerFinishedAttaskId": "2023-07-31T22:00:44.483000Zdb5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "numbercreatedAt": "700000000002024-01-01T00:00:18.722982Z", "callingNumberstartedAt": "70000000001", 2024-01-01T00:00:18.722136Z", "botIdfinishedAt": "687bec282024-1b47-42df-955c-b88b40b2cb7301-01T00:00:38.484110Z", "botNamebilledAt": "тест2024-01-01T00:00:57.902230Z", "timezoneupdatedAt": 10800"2024-01-01T00:00:57.908504Z", "messagesAsStringspeakerFinishedAt": "BOT: Добрый день, меня зовут Ирина, я сотрудник компании TWIN. Как я могу к вам обращаться? !2024-01-01T00:00:38.484000Z", "number": "70000000000", "resultsStringcallingNumber": "{}70000000001", "variablesStringbotId": "{\"m_0\": null, \"m_1\": \"1\", \"recordPath\": \"https://tcl.twin24.ai/#/record/687bec28-1b47-42df-955c-b88b40b2cb73/download\"}", db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "botName": "TWIN BOT", "timezone": 10800, "dialogResultmessagesAsString": null, "BOT: Добрый день, как ваши дела? \nCLIENT: Привет, дела - "advStatus_ru": "Успешный", хорошо.", "resultsString": "{\"nps\": null\"Успех\", "duration \"confirmation\": 5\"Успех\"}", "externalIdvariablesString": "687bec28-1b47-42df-955c-b2cb73", "clientExternalId": "103532154", "recordPath": "{\"tryNumber\": 0, \"recordPath\": \"https://miniotcl.twin24.ai/twin-cis-production/records/1672/2023/8/1/111111111.2867994_79881043184_1672.mp3", "currentStatusName": "ANSWERED", "mainCallDiscount": "0record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download\", \"humanNumber\": 0, \"resultNumber\": 0, \"tryCandidate\": 0, \"answeredNumber\": 0, \"humanCandidate\": 0, \"resultCandidate\": 0, \"answeredCandidate\": 0}", "mainCallDurationdialogResult": 5"Успех", "robotCallDurationadvStatus_ru": 5"Успешный", "transferCallDurationnps": 0"Успех", "companyIdduration": 0000117, "companyNameexternalId": "00001 | ТВИНdb5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "priceclientExternalId": "0.270000"null, "resellerPricerecordPath": "0.000000https://tcl.twin24.ai/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download", "resellerCompanyIdcurrentStatusName": null"ANSWERED", "resellerCompanyNamemainCallDiscount": null"0", "mainCallCostmainCallDuration": "1.30"17, "mainCallTotalCostrobotCallDuration": "0.11"17, "robotCallCosttransferCallDuration": "2.00"0, "robotCallTotalCostcompanyId": "0.17"123, "transferCallCostcompanyName": "0123 | ТВИН: TEST", "transferCallTotalCostprice": null"0.0", "isIncomingresellerPrice": "0.000000", "resellerCompanyId": falsenull, "amdresellerCompanyName": null, "autoCallCandidateIdmainCallCost": "687bec28-1b47-42df-955c-b88b40b2cb73"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 | Общее количество найденных записей. | 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 | ||
| botId | Идентификатор сценария бота. | String | ||
| botName | Имя сценария бота. | String | ||
| timezone | Смещение временной зоны в секундах относительно UTC. | Int | ||
| messagesAsString | Транскрибация диалога. Содержит полную транскрибацию в формате строки. | String | ||
| resultsString | Сохраненные в блоке Результат данные: Подтверждение; NPS; Произвольный результат. | String | ||
| variablesString | Стартовые переменные. | String | ||
| dialogResult | Значение поля подтверждение из блока Результат. | String | ||
| advStatus_ru | Результативность звонка (из настроек задания или блока «Зафиксировать эффективность)».
| String | ||
| nps | Значение поля NPS из зафиксированного результата. | String | ||
| duration | Продолжительность звонка в секундах. | Int | ||
| externalId | Внутренний идентификатор, используется только для нужд техподдержки. | String | ||
| clientExternalId | Идентификатор, который добавлен самостоятельно при добавлении кандидата. | String | ||
| recordPath | Ссылка на запись разговора. | String | ||
| currentStatusName | Текущий статус звонка. Возможные значения:
| String | ||
| mainCallDiscount | Скидка за разговор. | String | ||
| mainCallDuration | Длительность разговора в секундах. | Integer | ||
| robotCallDuration | Продолжительность работы робота в секундах. | Integer | ||
| transferCallDuration | Длительность звонка после перевода в секундах. | Integer | ||
| companyId | Идентификатор компании. | Integer | ||
| companyName | Идентификатор компании и имя компании. В формате: «ИДЕНТИФИКАТОР КОМПАНИИ | НАЗВАНИЕ КОМПАНИИ». | String | ||
| price | Стоимость всего разговора. | String | ||
| resellerPrice | Стоимость звонка для реселлера. | String | ||
| resellerCompanyId | Идентификатор компании реселлера. | Int | ||
| resellerCompanyName | Имя компании реселлера. | String | ||
| mainCallCost | Стоимость 1 минуты телефонии по тарифу. | String | ||
| mainCallTotalCost | Итоговая стоимость телефонии в звонке. | String | ||
| robotCallCost | Стоимость 1 минуты разговора робота. | String | ||
| robotCallTotalCost | Итоговая стоимость разговора робота. | String | ||
| transferCallCost | Стоимость 1 минуты разговора после перевода. | String | ||
| transferCallTotalCost | Итоговая стоимость разговора после перевода. | String | ||
| isIncoming | Входящий/Исходящий вызов (true/false). | Boolean | ||
| amd | Режим работы определителя человека или робота. Может принимать значения:
| String | ||
| autoCallCandidateId | Идентификатор кандидата. | 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 – Пустое задание (обзвон невозможен)
Объект с результатами разговора.
Обязательно включает поля "nps" и "confirmation".
Опционально (при наличии) включает поля со значением произвольных реультатов.
Кто "повесил трубку".
Возможные значения:
- Робот
- Человек
Текущий статус диалога.
Возможные значения:
- CANCEL – Отменен
- ANSWERED – Успешный
- NOANSWER – Нет ответа
- BUSY – Абонент занят
- CONGESTION – Вызов отклонен оператором связи
- CHANUNAVAIL – Нет связи с телефонной линией
- FAILED – Ошибка
- SCHEDULED – Запланирован
- BLACKLIST – В черном списке
- DIAL – Набор номера
- INPROGRESS – В процессе
- FZ230 – Запрет звонка по ФЗ-230
- INVALID – Ошибка формата номера
- UNAVAILABLE – Номер недоступен
- EXPIRED – Срок ожидания соединения истек
Текстовая расшифровка статуса диалога.
Возможные значения:
На русском:
- Отменен
- Успешный
- Нет ответа
- Абонент занят
- Вызов отклонен оператором связи
- Нет связи с телефонной линией
- Ошибка
- Запланирован
- В черном списке
- Набор номера
- В процессе
- Запрет звонка по ФЗ-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
Результат работы amd (система определения автоответчиков).
Возможные значения:
- Человек
- Автоответчик
- Не проверялось
Результативность вызова.
Возможные значения:
- Результативный
- Нерезультативный
- Не определено