...
Описание параметров метода:
Поле | Принимаемые значения | Описание |
---|---|---|
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 дата в формате:
ГГГГ-ММ-ДДTчч:мм:сс+чч:мм
Например:
decoded: 2023-06-13T00:00:00+00:00
encoded: 2023-06-13T00%3A00%3A00%2B00%3A00
Дата и время конца поиска статистики.
Смещение по позиции полученной информации. | ||
| Целое число от 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": "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", "botIdid": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "botNametaskName": "TWIN BOTTEST", "timezonetaskId": 10800"db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "messagesAsStringcreatedAt": "BOT: Добрый день, как ваши дела? \nCLIENT: Привет, дела - хорошо.2024-01-01T00:00:18.722982Z", "startedAt": "2024-01-01T00:00:18.722136Z", "resultsStringfinishedAt": "{\"nps\": \"Успех\", \"confirmation\": \"Успех\"}2024-01-01T00:00:38.484110Z", "billedAt": "2024-01-01T00:00:57.902230Z", "variablesStringupdatedAt": "{\"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}"2024-01-01T00:00:57.908504Z", "speakerFinishedAt": "2024-01-01T00:00:38.484000Z", "number": "70000000000", "dialogResultcallingNumber": "Успех70000000001", "advStatus_rubotId": "Успешныйdb5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "npsbotName": "УспехTWIN BOT", "durationtimezone": 1710800, "externalIdmessagesAsString": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "clientExternalId": nullBOT: Добрый день, как ваши дела? \nCLIENT: Привет, дела - хорошо.", "resultsString": "{\"nps\": \"Успех\", \"confirmation\": \"Успех\"}", "recordPathvariablesString": "{\"tryNumber\"https://minio: 0, \"recordPath\": \"https://tcl.twin24.ai/twin-cis-production/records/1672/2024/1/1/0000000000000000000000000_1_1.mp3", "currentStatusName": "ANSWERED"/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download\", \"humanNumber\": 0, \"resultNumber\": 0, \"tryCandidate\": 0, \"answeredNumber\": 0, \"humanCandidate\": 0, \"resultCandidate\": 0, \"answeredCandidate\": 0}", "mainCallDiscountdialogResult": "0Успех", "mainCallDurationadvStatus_ru": 17"Успешный", "robotCallDurationnps": 17"Успех", "transferCallDurationduration": 017, "companyIdexternalId": 1758"db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "companyNameclientExternalId": "0001 | ТВИН: TEST"null, "pricerecordPath": "0.0",https://tcl.twin24.ai/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download", "resellerPricecurrentStatusName": "0.000000ANSWERED", "resellerCompanyIdmainCallDiscount": null"0", "resellerCompanyNamemainCallDuration": null17, "mainCallCostrobotCallDuration": "0.00"17, "mainCallTotalCosttransferCallDuration": "0.0", "robotCallCostcompanyId": "0.00"123, "robotCallTotalCostcompanyName": "0.0123 | ТВИН: TEST", "transferCallCostprice": "0.0", "transferCallTotalCostresellerPrice": null"0.000000", "isIncomingresellerCompanyId": falsenull, "amdresellerCompanyName": "NOT_DEF"null, "autoCallCandidateIdmainCallCost": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd" 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 | Дата и время окончания |
Integer
звонка. | 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 |