...
Описание параметров метода:
Поле |
---|
Обязательно
Принимаемые значения | Описание |
---|---|
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", BOT: Добрый день, как ваши дела? \nCLIENT: Привет, дела - "clientExternalId": nullхорошо.", "recordPathresultsString": "https://minio.twin24.ai/twin-cis-production/records/1672/2024/1/1/0000000000000000000000000_1_1.mp3{\"nps\": \"Успех\", \"confirmation\": \"Успех\"}", "currentStatusNamevariablesString": "ANSWERED", "mainCallDiscount{\"tryNumber\": "0", "mainCallDuration": 17, "robotCallDuration": 17, "transferCallDuration \"recordPath\": \"https://tcl.twin24.ai/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download\", \"humanNumber\": 0, \"resultNumber\": 0, \"tryCandidate\": 0, "companyId": 1758 \"answeredNumber\": 0, \"humanCandidate\": 0, \"resultCandidate\": 0, \"answeredCandidate\": 0}", "companyNamedialogResult": "0001 | ТВИН: TESTУспех", "priceadvStatus_ru": "0.0Успешный", "resellerPricenps": "0.000000Успех", "resellerCompanyIdduration": null17, "resellerCompanyNameexternalId": null"db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd", "mainCallCostclientExternalId": "0.00"null, "mainCallTotalCostrecordPath": "0.0https://tcl.twin24.ai/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download", "robotCallCostcurrentStatusName": "0.00ANSWERED", "robotCallTotalCostmainCallDiscount": "0.0", "transferCallCostmainCallDuration": "0"17, "transferCallTotalCostrobotCallDuration": null17, "isIncomingtransferCallDuration": false0, "amdcompanyId": "NOT_DEF"123, "autoCallCandidateIdcompanyName": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd"123 | ТВИН: 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 | Общее количество найденных записей. | 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 (система определения автоответчиков).
Возможные значения:
- Человек
- Автоответчик
- Не проверялось
Результативность вызова.
Возможные значения:
- Результативный
- Нерезультативный
- Не определено