История страницы

...

Описание параметров метода:

Поле

Обязательно

Принимаемые значения	Описание
`fields`

да

	`id` `taskName` `taskId` `createdAt` `startedAt` `finishedAt` `billedAt` `updatedAt` `speakerFinishedAt` `number` `callingNumber` `botId` `botName` `timezone` `messagesAsString` `resultsString` `variablesString` `clientExternalId` `dialogResult` `advStatus_ru` `nps` `duration` `externalId` `recordPath` `currentStatusName` `mainCallDiscount` `mainCallDuration` `robotCallDuration` `transferCallDuration` `companyId` `companyName` `price` `resellerPrice` `resellerCompanyId` `resellerCompanyName` `mainCallCost` `mainCallTotalCost` `robotCallCost` `robotCallTotalCost` `transferCallCost` `transferCallTotalCost` `isIncoming` `amd` `autoCallCandidateId`	Параметр, отвечающий за то, какие поля будут отображены в ответе. Поля указываются через запятую.
`limit`

нет

Целое число от 1 до

1000

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

Дата и время начала поиска статистики.

toнет

url encoded дата в формате:

ГГГГ-ММ-ДДTчч:мм:сс+чч:мм

Например:

decoded: 2023-06-13T00:00:00+00:00

encoded: 2023-06-13T00%3A00%3A00%2B00%3A00

Дата и время конца поиска статистики.

companyIdнетцелое числоИдентификатор компании в TWIN. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. phoneнетцелое числоНомер телефона. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. isIncomingнетtrue/falsetrue - если входящие; false - если исходящие. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. sortнетcreatedAt, startedAt, finishedAt, billedAt, speakerFinishedAt, duration, price. По умолчанию сортировка происходит по полю startedAt.Каждое поле сортировки может иметь специальный префикс, указывающий желаемый порядок сортировки: + (по возрастанию, по умолчанию) или - (по убыванию).

Смещение по позиции полученной информации. Например, в заданное временное окно было 4 050 звонков. Сделав запрос, вы получили доступный максимум в виде 1 000 записей. Тогда вам нужно повторить запрос, с указанием последней полученной позиции. После получения 1 000 записей, «1 000» и есть наша последняя позиция. Получив еще раз максимальное количество, повторяем запрос, указав смещение уже на 2 000 позиций. Делаем смещение до тех пор, пока количество возвращенных данных не будет меньше запрошенного лимита.
`page`	Целое число от 0	Номер «страницы» с записями. Например, если у вас есть 4 050 звонков и лимит вывода на одной странице составляет 1 000 записей, то на первой странице будут записи с номерами с 0 по 1000, на второй — с 1 001 по 2000 и так далее.
`from`	url encoded дата в формате - `ГГГГ-ММ-ДДTчч:мм:сс+чч:мм` Например: Начало периода в формате decoded: `2023-06-13T00:00:00+00:00` В encoded будет выглядеть: `2023-06-13T00%3A00%3A00%2B00%3A00`	Дата и время, от которой требуется провести поиск статистики в формате encoded.
`to`	url encoded дата в формате - `ГГГГ-ММ-ДДTчч:мм:сс+чч:мм` Например: Начало периода в формате decoded: `2023-06-13T00:00:00+00:00` В encoded будет выглядеть: 2023-06-13T00%3A00%3A00%2B00%3A00 В запросе требуется использовать дату и время в формате encoded.	Дата и время, до которой требуется провести поиск статистики в формате encoded.
`companyId`	Целое число	Идентификатор компании в TWIN. *Используется для фильтрации. Сессии, не отвечающие заданному параметру,

taskIdнетцелое числоИдентификатор задания на обзвон. Используется для фильтрации. Сессии не отвечающие заданному параметру

не будут добавлены в ответ.

idнетцелое число

phone

Целое число

Номер телефона, на который идет звонок.

*

Идентификатор звонка.

Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.

statusнетCANCEL, ANSWERED, NOANSWER, BUSY, CONGESTION, CHANUNAVAIL, FAILED, BLACKLIST, DIAL, INPROGRESS, FZ230, INVALID, UNAVAILABLE, EMPTY_AON

Примечание
Для входящих звонков — номер телефона, к которому подключён бот.

callingNumber

Целое число

Номер телефона, с которого идет звонок.

*Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.

Примечание
Для исходящих звонков — номер телефона, к которому подключён бот.

isIncoming

true / false

true — если входящие; false — если исходящие.

*

Текущий статус звонка. нет

Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.

FilterPeriodBy

sort

createdAt

, updatedAt, startedAt. По умолчанию используется поле startedAt. Дата в формате ISO8601

Фильтрации по начальной и конечной датам.

autoCallCandidateIdнетцелое числоИдентификатор кандидата. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.

, `startedAt` , `finishedAt` , `billedAt` , `speakerFinishedAt` , `duration` , `price` По умолчанию сортировка происходит по полю `startedAt`.	Для сортировки результатов запроса доступны следующие поля: `createdAt —` дата и время создания звонка; `startedAt —` дата и время начала звонка; `finishedAt —` дата и время завершения звонка; `billedAt —` дата и время расчёта стоимости звонка; `speakerFinishedAt —` дата и время окончания работы робота; `duration —` продолжительность звонка; `price —` стоимость звонка. По умолчанию сортировка происходит по полю `startedAt`. Для указания желаемого порядка сортировки используются специальные префиксы: `«+»` — для сортировки по возрастанию (по умолчанию); `«-»` — для сортировки по убыванию. Например, чтобы отсортировать звонки в порядке убывания, ориентируясь на дату и время завершенного звонка, нужно указать: `-finishedAt`.
`taskId`	Значение string	Идентификатор задания на обзвон. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.
`id`	Значение string	Идентификатор звонка. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.
`status`	Возможные значения: CANCEL — Отменен; ANSWERED — Успешный; NOANSWER — Нет ответа; BUSY — Абонент занят; CONGESTION — Вызов отклонен оператором связи; CHANUNAVAIL — Нет связи с телефонной линией; FAILED — Ошибка; SCHEDULED — Запланирован; BLACKLIST — В черном списке; DIAL — Набор номера; INPROGRESS — В процессе; FZ230 — Запрет звонка по ФЗ-230; INVALID — Ошибка формата номера; UNAVAILABLE — Номер недоступен; EXPIRED — Срок ожидания соединения истек.	Текущий статус звонка. *Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.
`FilterPeriodBy`	`createdAt` , `updatedAt` , `startedAt` По умолчанию используется поле `startedAt` .	Выбор поля, к которому будет применяться фильтрация по датам из полей `from` и `to` .
`autoCallCandidateId`	Значение string	Идентификатор кандидата. Используется для фильтрации. Сессии, не отвечающие заданному параметру, не будут добавлены в ответ.

Блок кода

language	py
theme	DJango
title	Ответ в формате JSON

{
    "count": 1,
    "items": [
        {

Блок кода

language	py
theme	DJango
title	Ответ в формате JSON

{
    "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",
            "resultsStringstartedAt": "{\"nps\": \"Успех\", \"confirmation\": \"Успех\"}2024-01-01T00:00:18.722136Z",
            "finishedAt": "2024-01-01T00:00:38.484110Z",
            "variablesStringbilledAt": "{\"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.902230Z",
            "updatedAt": "2024-01-01T00:00:57.908504Z",
            "speakerFinishedAt": "2024-01-01T00:00:38.484000Z",
            "dialogResultnumber": "Успех70000000000",
            "advStatus_rucallingNumber": "Успешный70000000001",
            "npsbotId": "Успехdb5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "durationbotName": "TWIN 17BOT",
            "externalIdtimezone": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd"10800,
            "clientExternalIdmessagesAsString": null,
"BOT:  Добрый день, как ваши дела? \nCLIENT: Привет, дела   "recordPath": "https://minio.twin24.ai/twin-cis-production/records/1672/2024/1/1/0000000000000000000000000_1_1.mp3- хорошо.",
            "currentStatusNameresultsString": "ANSWERED",
            "mainCallDiscount{\"nps\": \"Успех\", \"confirmation\": \"0Успех\"}",
            "mainCallDurationvariablesString": 17,
            "robotCallDuration"{\"tryNumber\": 170,
            "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": 17,
            "0robotCallDuration": 17,
            "transferCallTotalCosttransferCallDuration": null0,
            "isIncomingcompanyId": false123,
            "amdcompanyName": "NOT_DEF123 | ТВИН: TEST",
            "autoCallCandidateIdprice": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd"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

Результативность звонка (из настроек задания или блока «Зафиксировать эффективность)».
Возможные значения:

Отменён;
Успешный;
Нет ответа;
Абонент занят;
Вызов отклонен оператором связи;
Нет связи с телефонной линией;
Ошибка;
Запланирован;
В черном списке;
Набор номера;
В процессе;
Запрет звонка по 230-ФЗ;
Ошибка формата номера;
Номер не доступен;
Срок ожидания соединения истек.

String

| nps

Значение поля NPS из зафиксированного результата.

String

| duration Продолжительность звонка в секундах. Int

| externalId

Внутренний идентификатор, используется только для нужд техподдержки.

String

| clientExternalId

Идентификатор, который добавлен самостоятельно при добавлении кандидата.

String

| recordPath

Ссылка на запись разговора.

String

| currentStatusName

Текущий статус звонка.

Возможные значения:

CANCEL — Отменен;
ANSWERED — Успешный;
NOANSWER — Нет ответа;
BUSY — Абонент занят;
CONGESTION — Вызов отклонен оператором связи;
CHANUNAVAIL — Нет связи с телефонной линией;
FAILED — Ошибка;
SCHEDULED — Запланирован;
BLACKLIST — В черном списке;
DIAL — Набор номера;
INPROGRESS — В процессе;
FZ230 — Запрет звонка по ФЗ-230;
INVALID — Ошибка формата номера;
UNAVAILABLE — Номер недоступен;
EXPIRED — Срок ожидания соединения истек.

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

Режим работы определителя человека или робота.
Может принимать значения:

HUMN — человек;
MACH — робот;
NOT_DEF — определить выключен.

String

| autoCallCandidateId Идентификатор кандидата. String

Поле

Тип

Обязательно

Описание

countintдаОбщее количество записей.itemsArray[Object]даМассив записей.| idstringнетИдентификтор звонка.| taskNamestringнетИмя задания на обзвон.| taskIdstringнетИдентификатор задания на обзвон. | createdAtstringнетДата и время создания задания на обзвон. | startedAtstringнетДата и время запуска задания на обзвон.| finishedAtstringнетДата и время окончания выполнения задания на обзвон.

| billedAt

stringнетДата и время расчёта стоимости выполнения задания на обзвон.| updatedAtstringнетДата и время последнего обновления задания на обзвон.| speakerFinishedAtstringнетДата и время окончания разговора. | numberstringнетНомер с которого звонили клиенту. | callingNumberstringнетНомер на который звонили клиенту.| dialogResultstringнетЗаписывается значение из блока "Результат" в котором выбрано "Зафиксировать результативность". Может принимать значения: "Успех"; "null".| advStatus_rustringнет| botIdstringнетID сценария бота, который использовался в задании на обзвон.| npsstringнет | durationstringнет | botNamestringнетИмя сценария бота.| timezon
stringнетCмещение временной зоны в секундах относительно координированного всемирного времени (UTC)

| messagesAsString

stringнетТранскрибация диалога.

| resultsString

stringнетСодержит сохраненные в блоке "Результат": Подтверждение; NPS.| variablesStringstringнетСодержит сохраненные переменные. | taskStatusstringнет

Статус задания на обзвон.

Возможные значения:

ERROR_PREPARING – Ошибка подготовки
PREPARING – Подготавливается к запуску
MAX_CPS – Превышен лимит CPS для аккаунта. Приостановлено
TIMEOUT – Таймаут обзвона. Аварийное завершение
PAUSED_NO_ROUTE – Приостановлено. Нет маршрутов для вызовов
READY – Готово к запуску
PAUSED_SCHEDULE – Приостановлено. По расписанию
HALTED – Остановлено навечно
PAUSED_NOBODY – Приостановлено. Некому звонить на данный момент
DELETING – В процессе удаления
PAUSED_NO_MONEY – Закончились деньги. Приостановлено
PAUSED – Приостановлено
PROCESS – В процессе обзвона
DONE – Обзвон завершен
BLANK – Пустое задание (обзвон невозможен)

| callIdstringнетИдентификатор звонка.| startedAtstringнетДата и время начала звонка.| numberstringнетНомер телефона, на который был вызов.| callingNumberstringнетНомер телефона, с которого был вызов.| botIdstringнетИдентификатор бота.| botNamestringнетИмя бота.| regionNamestringнетРегион вызываемого абонента.| timezoneintнетТаймзона вызываемого абонента.| messagesAsStringstringнетСообщения диалога строкой.| messagesArray[Object]нетМассив сообщений.| | authorTypestringнетТип автора сообщения (BOT, CLIENT).| | createdAtstringнетДата создания сообщения.| | bodystringнетТекс сообщения.| resultsStringstringнетЗначение из поля "Подтверждение результата".| allResultsObjectнет

Объект с результатами разговора.

Обязательно включает поля "nps" и "confirmation".

Опционально (при наличии) включает поля со значением произвольных реультатов.

| emotionstringнетОпределенная эмоция.| hungUpBystringнет

Кто "повесил трубку".

Возможные значения:

Робот
Человек

| genderstringнетОпределенный гендер.| npsstringнетЗначение из поля "nps".| isAssistantRequeststringнетЗапросил ли бот помощь.| markersstringнетМаркеры.| durationintнетДлительность разговора.| externalIdstringнетВнутренний системный идентификатор. | clientExternalIdstringнетВнешний идентификатор клиента, заданный при добавлении кандидата (как через апи метод, так и через интерфейс или excell реестр).| additionalstringнетДополнительные данные о диалоге.| recordPathstringнетСсылка на аудиозапись диалога.| currentStatusNamestringнет

Текущий статус диалога.

Возможные значения:

CANCEL – Отменен
ANSWERED – Успешный
NOANSWER – Нет ответа
BUSY – Абонент занят
CONGESTION – Вызов отклонен оператором связи
CHANUNAVAIL – Нет связи с телефонной линией
FAILED – Ошибка
SCHEDULED – Запланирован
BLACKLIST – В черном списке
DIAL – Набор номера
INPROGRESS – В процессе
FZ230 – Запрет звонка по ФЗ-230
INVALID – Ошибка формата номера
UNAVAILABLE – Номер недоступен
EXPIRED – Срок ожидания соединения истек

| humanStatusNamestringнет

Текстовая расшифровка статуса диалога.

Возможные значения:

На русском:

Отменен
Успешный
Нет ответа
Абонент занят
Вызов отклонен оператором связи
Нет связи с телефонной линией
Ошибка
Запланирован
В черном списке
Набор номера
В процессе
Запрет звонка по ФЗ-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

| mainCallDiscountstringнетСкидка за разговор (транк клиента).| mainCallDurationintнетДлительность разговора (транк клиента).| autoCallCoststringнетВсегда равен 0.| autoCallDiscountstringнетВсегда равен 0.| autoCallDurationintнетВсегда равен 0.| autoCallTotalCoststringнетВсегда равен 0.| robotCallDiscountstringнетСкидка за разговор робота.| robotCallDurationintнетДлительность разговора робота.| transferCallDiscountstringнетСкидка за перевод звонка.| transferCallDurationintнетДлительность звонка после перевода.| companyIdintнетИдентификатор компании.| autoCallCandidateIdstringнетИдентификатор кандидата.| amdstringнет

Результат работы amd (система определения автоответчиков).

Возможные значения:

Человек
Автоответчик
Не проверялось

| isCallEfficiencystringнет

Результативность вызова.

Возможные значения:

Результативный
Нерезультативный
Не определено

| totalCoststringнетСтоимость диалога.| mainCallCoststringнетСтоимость разговора (транк клиента).| mainCallTotalCoststringнетСтоимость разговора робота со скидкой.| robotCallCoststringнетСтоимость разговора робота.| robotCallTotalCoststringнетСтоимость разговора робота со скидкой.| transferCallCoststringнетСтоимость разговора после перевода.| transferCallTotalCoststringнетСтоимость разговора после перевода со скидкой.| variables-namestringнетvariables-var_name - поле, содержащее значение стартовой переменной с именем var_name, переданной при добавлении кандидата (как через апи метод, так и через интерфейс или excell реестр)

Быстрые ссылки

Дерево страниц

Сравнение версий

Старая версия 5

Новая версия Текущий

Ключ