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 до 10000. Примечание |
---|
Рекомендуемый лимит - 1000 |
| Количество записей на одной странице. Максимум 10000. |
offset | Целое число от 0 | "Отступ" от начала записей. То есть с какой записи начинать вывод. Смещение по позиции полученной информации. Например, в заданное временное окно было 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. *Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. |
phone | целое число | Номер телефона на который идет звонок. *Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. Примечание |
---|
Для входящих звонков - номер телефона к которому подключён бот. |
|
callingNumber | целое число | Номер телефона с которого идет звонок. *Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. Примечание |
---|
Для исходящих звонков - номер телефона к которому подключён бот. |
|
isIncoming | true / false | true - если входящие; false - если исходящие.
*Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. |
sort | createdAt , startedAt , finishedAt , billedAt , speakerFinishedAt , duration , price .
По умолчанию сортировка происходит по полю startedAt . | Для сортировки результатов запроса доступны следующие поля: sortcreatedAt 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 | Идентификатор кандидата. Используется для фильтрации. Сессии не отвечающие заданному параметру не будут добавлены в ответ. |