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

...

1000"Отступ" Номер телефона. Используется для фильтрации. Сессии не отвечающие заданному параметру true - если входящие; false - если исходящиеИдентификатор задания на обзвон.

Поле

Принимаемые значения

Описание

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 до

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 целое число Номер телефона. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.

Смещение по позиции полученной информации.
Например, в заданное временное окно было 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.

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

callingNumber

целое число

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

isIncoming

true/false

phone

Целое число

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

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

sort createdAt, startedAt, finishedAt, billedAt, speakerFinishedAt, duration, price. По умолчанию сортировка происходит по полю startedAt. Каждое поле сортировки может иметь специальный префикс, указывающий желаемый порядок сортировки: + (по возрастанию, по умолчанию) или - (по убыванию).

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

callingNumber

Целое число

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

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

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

isIncoming

true / false

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

*

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 целое число Идентификатор кандидата. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ.

sort

createdAt , 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",
            "numberid": "70000000000db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "callingNumbertaskName": "70000000001TWIN TEST",
            "botIdtaskId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "botNamecreatedAt": "TWIN BOT2024-01-01T00:00:18.722982Z",
            "timezonestartedAt": 10800"2024-01-01T00:00:18.722136Z",
            "messagesAsStringfinishedAt": "BOT:2024-01-01T00:00:38.484110Z",
   Добрый день, как ваши дела? \nCLIENT: Привет, дела - хорошо.     "billedAt": "2024-01-01T00:00:57.902230Z",
            "resultsStringupdatedAt": "{\"nps\": \"Успех\", \"confirmation\": \"Успех\"}2024-01-01T00:00:57.908504Z",
            "speakerFinishedAt": "2024-01-01T00:00:38.484000Z",
            "variablesStringnumber": "{\"tryNumber\": 0, \"recordPath\": \"https://tcl.twin24.ai/record/70000000000",
            "callingNumber": "70000000001",
            "botId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download\", \"humanNumber\
            "botName": 0,"TWIN \"resultNumber\": 0, \"tryCandidate\": 0, \"answeredNumber\": 0, \"humanCandidate\": 0, \"resultCandidate\": 0, \"answeredCandidate\": 0}"BOT",
            "timezone": 10800,
            "dialogResultmessagesAsString": "Успех",
BOT:  Добрый день, как ваши дела? \nCLIENT: Привет, дела   "advStatus_ru": "Успешный- хорошо.",
            "resultsString": "{\"nps\": \"Успех\",
            "duration": 17,
\"confirmation\": \"Успех\"}",
            "variablesString": "{\"tryNumber\": 0, \"externalIdrecordPath\": \"https://tcl.twin24.ai/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download\",
 \"humanNumber\": 0, \"resultNumber\": 0, \"tryCandidate\": 0, \"answeredNumber\": 0, \"humanCandidate\": 0, \"resultCandidate\": 0, \"clientExternalIdansweredCandidate\": null0}",
            "recordPathdialogResult": "https://minio.twin24.ai/twin-cis-production/records/1672/2024/1/1/0000000000000000000000000_1_1.mp3"Успех",
            "currentStatusNameadvStatus_ru": "ANSWEREDУспешный",
            "mainCallDiscountnps": "0Успех",
            "mainCallDurationduration": 17,
            "robotCallDurationexternalId": 17,
  "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "transferCallDurationclientExternalId": 0null,
            "companyIdrecordPath": 1758"https://tcl.twin24.ai/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download",
            "companyNamecurrentStatusName": "0001 | ТВИН: TESTANSWERED",
            "pricemainCallDiscount": "0.0"",
            "resellerPricemainCallDuration": "0.000000"17,
            "resellerCompanyIdrobotCallDuration": null17,
            "resellerCompanyNametransferCallDuration": null0,
            "mainCallCostcompanyId": "0.00"123,
            "mainCallTotalCostcompanyName": "0.0123 | ТВИН: TEST",
            "robotCallCostprice": "0.000",
            "robotCallTotalCostresellerPrice": "0.0000000",
            "transferCallCostresellerCompanyId": "0"null,
            "transferCallTotalCostresellerCompanyName": null,
            "isIncomingmainCallCost": false"0.00",
            "amdmainCallTotalCost": "NOT_DEF0.0",
            "autoCallCandidateIdrobotCallCost": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd"
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`	Дата и время окончания

ПолеОписаниеТип поляcountОбщее количество записей.

Integer

itemsМассив записей.Array[Object]| idИдентификатор

звонка.	String
\| `billedAt`

taskName

Дата и время расчета стоимости звонка

Имя задания на обзвон

.	String
\|

taskId

updatedAt Дата и время последнего обновления информации о звонке

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

.	String
\| `speakerFinishedAt`

createdAt

Дата

и время создания звонка

и время окончания работы бота.	String
\|

startedAt

number

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

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

Дата и время запуска звонка

.

String

|

finishedAt

callingNumber

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

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

Дата и время окончания звонка

.

String

|

billedAt

botId Идентификатор сценария бота

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

.	String
\|

updatedAt

botName Имя сценария бота

Дата и время последнего обновления информации о звонке

.	String
\| `timezone`

speakerFinishedAt

Дата и время окончания работы бота.

String| number

	Смещение временной зоны в секундах относительно UTC.	Int
\| `messagesAsString`	Транскрибация диалога. Содержит полную транскрибацию в формате строки.

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

	String
\|

callingNumber

resultsString Сохраненные в блоке Результат данные: Подтверждение; NPS; Произвольный результат

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

.	String
\| `variablesString`

botId

Идентификатор сценария бота

Стартовые переменные.	String
\| `dialogResult`

botName

Значение поля подтверждение из блока Результат

Имя сценария бота

.	String
\|

timezone

advStatus_ru

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

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

String

| nps

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

String

| duration

Смещение временной зоны в секундах относительно UTC.Integer| messagesAsStringТранскрибация диалога. Содержит полную транскрибацию в формате строки. String| resultsStringСохраненные в блоке "Результат" данные: Подтверждение; NPS; Произвольный результат.String| variablesStringСтартовые переменные.String| dialogResult

Значение поля подтверждение из блока результат.

String| advStatus_ru

Результативность звонка (из настроек задания или блока "зафиксировать эффективность")

String| npsЗначение из блока "Результат" в NPS.String| duration

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

Integer

Int

| externalId

externalId

Используется

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

тех поддержки

техподдержки.	String
\| `clientExternalId`

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`

robotCallDuration

	Продолжительность работы робота в секундах.	Integer
\|

transferCallDuration

transferCallDuration Длительность звонка после перевода в

секунадх

секундах.	Integer
\|

`companyId`	Идентификатор компании.	Integer
\| `companyName`

companyName

Идентифиактор

Идентификатор компании и имя компании.

В формате:

"ИДЕНТИФИКАТОР

«ИДЕНТИФИКАТОР КОМПАНИИ | НАЗВАНИЕ

КОМПАНИИ"

КОМПАНИИ».	String
\|

`price`	Стоимость всего разговора.	String
\|

resellerPrice

resellerPrice Стоимость

разговора

звонка для реселлера.	String
\|

resellerCompanyId Идентификатор компании реселлера.

String

Int

|

`resellerCompanyName`	Имя компании реселлера.	String
\| `mainCallCost`

mainCallCost

	Стоимость 1 минуты телефонии по тарифу.	String
\| `mainCallTotalCost`

mainCallTotalCostОбщая стоимость звонка

	Итоговая стоимость телефонии в звонке.	String
\|

robotCallCost

`robotCallCost`	Стоимость 1 минуты разговора робота.	String
\|

robotCallTotalCost

Стоимость

Итоговая стоимость разговора робота

со скидкой

.	String
\| `transferCallCost`

transferCallCost

	Стоимость 1 минуты разговора после перевода.	String
\|

transferCallTotalCost

transferCallTotalCost Итоговая стоимость

Стоимость

разговора после перевода

со скидкой

.

Boolean

String

| isIncoming

isIncoming

	Входящий/Исходящий вызов (true/false).	Boolean
\| `amd`

amd

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

HUMN

-

— человек;
MACH

-

— робот;
NOT_DEF

- определить

— определить выключен.	String
\|

autoCallCandidateId

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

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

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

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

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

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

Ключ