...
Поле | Принимаемые значения | Описание |
|---|---|---|
| fields |
| Параметр, отвечающий поля будут отображены в ответе. Поля указываются через запятую. |
| limit | Целое число от 1 до 1000 | Количество записей на одной странице. Максимум 1000. |
| offset | Целое число от 0 | "Отступ" от начала записей. То есть с какой записи начинать вывод. |
page | Целое число от 0 | Номер "страницы" с записями. |
from | url encoded дата в формате:
Например: decoded: encoded:
| Дата и время начала поиска статистики.
|
| to | url encoded дата в формате:
Например: decoded: encoded: | Дата и время конца поиска статистики. |
| companyId | целое число | Идентификатор компании в TWIN. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. |
| phone | целое число | Номер телефона. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. |
| callingNumber | целое число | Номер телефона. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. |
| 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 | целое число | Идентификатор кандидата. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. |
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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 | Значение поля подтверждение из блока результат. | String |
| | advStatus_ru | Результативность звонка (из настроек задания или блока "зафиксировать эффективность") | String |
| | nps | Значение из блока "Результат" в NPS. | String |
| | duration | Продолжительность звонка в секундах. | Integer |
| | 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 | Идентификатор компании реселлера. | String |
| | resellerCompanyName | Имя компании реселлера. | String |
| | mainCallCost | Стоимость телефонии. | String |
| | mainCallTotalCost | Общая стоимость звонка. | String |
| | robotCallCost | Стоимость разговора робота. | String |
| | robotCallTotalCost | Стоимость разговора робота со скидкой. | String |
| | transferCallCost | Стоимость разговора после перевода. | String |
| | transferCallTotalCost | Стоимость разговора после перевода со скидкой. | Boolean |
| | isIncoming | Входящий/Исходящий вызов (true/false). | Boolean |
| | amd | Режим работы определителя человека или робота. Может принимать значения:
| String |
| | autoCallCandidateId | Идентификатор кандидата. | String |