...
Поле | Обязательно | Принимаемые значения | Описание | ||
|---|---|---|---|---|---|
| fields | да |
| Параметр, отвечающий по каким полям будет осуществляться поиск сессий. | ||
| limitto | нет | Целое число от 1 до 1000 | Количество записей на одной странице. Максимум 1000. | ||
| offset | нет | Целое число от 0 | "Отступ" от начала записей. То есть с какой записи начинать вывод. | ||
page | нет | Целое число от 0 | Номер "страницы" с записями. | ||
from | нет | url encoded дата в формате:
Например: decoded: url encoded дата в формате:
Например: decoded: encoded:
| Дата и время конца начала поиска статистики. Поле, по которому высчитывается дата, указывается в параметре | ||
| fields | нет | Любые значения, перечисленные через запятую без пробела: taskName,taskId,taskCreatedAt,taskUpdatedAt,taskStatus,callId,startedAt,number,callingNumber, | Список полей, которые необходимо вывести.
| ||
| 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 | нет | Идентификатор | Фильтрация по идентификатору задания. | ||
| |||||
| to | нет | url encoded дата в формате:
Например: decoded: encoded: | Дата и время конца поиска статистики. | ||
| 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 | нет | целое число | Идентификатор кандидата |
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"count": 1,
"items": [
| ||||||||
| Блок кода | ||||||||
| ||||||||
{ "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": "нормально" { }, "id": "687bec28-1b47-42df-955c-b88b40b2cb75", { "taskName": "999", "authorTypetaskId": "BOTc8e64c09-8d3e-4c5f-9403-5f57b085de5b", "createdAt": "20242023-0107-16T0231T22:0100:43.197626+00:0031.666566Z", "bodystartedAt": "Хорошо, пока!" } 2023-07-31T22:00:31.665221Z", ]"finishedAt": "2023-07-31T22:00:44.483259Z", "resultsStringbilledAt": "Подтверждение: Значение поля 'подтверждение результата'2023-07-31T22:01:01.795661Z", "allResults": { updatedAt": "2023-07-31T22:01:01.804529Z", "npsspeakerFinishedAt": "Значение поля NPS2023-07-31T22:00:44.483000Z", "custom_result"number": "Значение поля 'произвольный результат' с ключом custom_result70000000000", "confirmationcallingNumber": "Значение поля 'подтверждение результата'"70000000001", } "botId": "687bec28-1b47-42df-955c-b88b40b2cb73", "emotionbotName": null"тест", "hungUpBytimezone": "Робот"10800, "gendermessagesAsString": "BOT: Добрый nullдень, меня зовут Ирина, я сотрудник компании TWIN. Как я могу "nps": "Значение поля NPSк вам обращаться? !", "isAssistantRequestresultsString": null"{}", "markersvariablesString": "Первый маркер;Второй маркер;Третий маркер", "duration": 39, "externalId": "bce7d22e-dde6-4427-b391-ebbdfda44de6{\"m_0\": null, \"m_1\": \"1\", \"recordPath\": \"https://tcl.twin24.ai/#/record/687bec28-1b47-42df-955c-b88b40b2cb73/download\"}", "clientExternalIddialogResult": "123"null, "additionaladvStatus_ru": null"Успешный", "recordPathnps": "https:///#/record/bce7d22e-dde6-4427-b391-ebbdfda44de6/download"null, "currentStatusNameduration": "ANSWERED"5, "humanStatusNameexternalId": "Answered687bec28-1b47-42df-955c-b2cb73", "mainCallDiscountclientExternalId": "0103532154", "mainCallDurationrecordPath": 39"https://minio.twin24.ai/twin-cis-production/records/1672/2023/8/1/111111111.2867994_79881043184_1672.mp3", "autoCallCostcurrentStatusName": "0ANSWERED", "autoCallDiscountmainCallDiscount": "0", "autoCallDurationmainCallDuration": "0"5, "autoCallTotalCostrobotCallDuration": "0"5, "robotCallDiscounttransferCallDuration": "0", "robotCallDurationcompanyId": 3900001, "transferCallDiscountcompanyName": "000001 | ТВИН", "transferCallDurationprice": "0.270000", "companyIdresellerPrice": 1"0.000000", "autoCallCandidateIdresellerCompanyId": "bce7d22e-dde6-4427-b391-ebbdfda44de6"null, "amdresellerCompanyName": "Не проверялось"null, "isCallEfficiencymainCallCost": "Результативный1.30", "mainCallTotalCost": "0.8511", "robotCallTotalCostrobotCallCost": "12.3000", "transferCallTotalCostrobotCallTotalCost": null"0.17", "totalCosttransferCallCost": "2.1450000", "mainCallCosttransferCallTotalCost": "1.30"null, "robotCallCostisIncoming": "2.00"false, "transferCallCostamd": "0"null, "variables-nameautoCallCandidateId": "Иван687bec28-1b47-42df-955c-b88b40b2cb73" } ] } |
Описание полей ответа:
...