...
Поле | Принимаемые значения | Описание | ||
---|---|---|---|---|
fields |
| Параметр, отвечающий поля будут отображены в ответе. Поля указываются через запятую. | ||
limit | Целое число от 1 до 10000.
| Количество записей на одной странице. Максимум 10000. | ||
offset | Целое число от 0 | "Отступ" от начала записей. То есть с какой записи начинать вывод. Смещение по позиции полученной информации. | ||
| Целое число от 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 | Общее количество найденных записей. | 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 | Идентификатор компании реселлера. | String | ||
| 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 |
...