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

...

Блок кода

language	json
title	cURL (пример)

curl --location 'https://cis.twin24.ai/cis/api/v1/telephony/autoCall?page=0&limit=1000&keyword=&status=BLANK%2CREADY%2CPROCESS%2CPAUSED&from=2025-06-01T00%3A00%3A00.000Z&to=2025-06-30T00%3A00%3A00.000Z&sort=-status' \
--header 'Authorization: Bearer TOKEN'

...

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

offset

Целое число от 0

«Отступ» от начала записей. То есть с какой записи начинать вывод.

Смещение по позиции полученной информации.
Например, в заданное временное окно было 4 050 звонков. Сделав запрос, вы получили доступный максимум в виде 1 000 записей. Тогда вам нужно повторить запрос, с указанием последней полученной позиции. После получения 1 000 записей, «1 000» и есть наша последняя позиция. Получив еще раз максимальное количество, повторяем запрос, указав смещение уже на 2 000 позиций.
Делаем смещение до тех пор, пока количество возвращенных данных не будет меньше запрошенного лимита.

Примечание
Для "перебора" информации при запросах нужно использовать ЛИБО offset, ЛИБО page, но не использовать эти параметры одновременно.

page

Целое число от 0

Номер «страницы» с записями.
Например, если у вас есть 4 050 звонков и лимит вывода на одной странице составляет 1 000 записей, то на первой странице будут записи с номерами с 0 по 1000, на второй — с 1 001 по 2000 и так далее.

Примечание
Для "перебора" информации при запросах нужно использовать ЛИБО offset, ЛИБО page, но не использовать эти параметры одновременно.

limit

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

Количество записей на одной странице. Максимум 1000 объектов.

from

url encoded дата в формате - ГГГГ-ММ-ДДTчч:мм:сс+чч:мм

Например:

Начало периода в формате decoded: 2023-06-13T00:00:00+00:00
В encoded будет выглядеть: 2023-06-13T00%3A00%3A00%2B00%3A00

Дата и время, от которой требуется провести поиск статистики. url-encoded дата в формате - ГГГГ-ММ-ДДTчч:мм:сс+чч:мм

to

url encoded дата в формате - ГГГГ-ММ-ДДTчч:мм:сс+чч:мм

Например:

Начало периода в формате decoded: 2023-06-13T00:00:00+00:00
В encoded будет выглядеть: 2023-06-13T00%3A00%3A00%2B00%3A00

В запросе требуется использовать дату и время в формате encoded.

Дата и время, до которой требуется провести поиск статистики. url-encoded дата в формате - ГГГГ-ММ-ДДTчч:мм:сс+чч:мм

status

Строка со списком статусов через запятую БЕЗ пробелов (Перечень статусов указан ниже)

Фильтр по статусам заданий. Статусы указываются через запятую БЕЗ пробела.

С доступными статусами и их описание можно ознакомиться в отдельной статье: https://confluence.twin24.ai/x/4oB2EQ

sort

name, cps, createdAt, updatedAt, status

Для сортировки результатов запроса доступны следующие поля:

name — название задания на обзвон;
cps — параметр CPS (calls per second);
createdAt — дата и время создания задания на обзвон;
updatedAt — дата и время последнего изменения в задании на обзвон;
status — текущий статус задания

Для указания желаемого порядка сортировки используются специальные префиксы:

«+» — для сортировки по возрастанию (по умолчанию);
«-» — для сортировки по убыванию.
Например, чтобы отсортировать задания в порядке убывания даты создания задания, нужно указать: -createdAt.

keyword

Строка с фразой для поиска

Фильтр по названию задания на обзвон

status

Блок кода

language

...

json

...

Аварийная остановка задания (техническая ошибка)

...

Приостановлено некому звонить в данный момент, например тайм зоны недоступны или не прошло время для повторной попытки.

...

Ошибка подготовки. (техническая ошибка)

...

приостановлено по расписанию

...

Задание остановлено навсегда. Попыток и звонков больше предприниматься не будет.

...

Приостановлено, не выбран callerId.

...

Не удалось расчитать время следующего звонка (фактически аварийное завершение, техническая ошибка)

title	Ответ в формате JSON

{
    "count": 1,
    "items": [
        {
            "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "name": "Метод на получение списка созданных заданий на обзвон",
            "defaultExec": "robot",
            "defaultExecData": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "secondExec": "ch",

Блок кода

language	json
title	Ответ в формате JSON

{
    "count": 4,
    "items": [
        {
            "id": "bce7d22e"secondExecData": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "namecidType": "Тестовое задание на обзвонgornum",
            "defaultExeccidData": "robot",
            "defaultExecData": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "secondExeccps": "end1",
            "secondExecDatataskComment": null,
"Тестовое задание для статьи \"Метод на получение списка созданных заданий на  "cidType": "gornum"обзвон\"",
            "cidDatastartType": "bce7d22e-dde6-4427-b391-ebbdfda44de6time",
            "cpsstartMoment": "12025-06-11 04:00",
            "taskCommentphoneNormalization": "RU",
            "startTypenormalizationErrorAction": "manualSET_NORMALIZATION_ERROR_FLAG",
            "startMomentcallStrategy": "PARALLEL",
            "phoneNormalizationcheckPhone": nulltrue,
            "normalizationErrorActionexternalId": null123456,
            "callStrategysyncFail": "STEP_2_STEP"false,
            "checkPhonesyncError": truenull,
            "externalIdstatus": 123456"BLANK",
            "syncFailcreatedAt": false"2025-06-11T03:46:35.000000Z",
            "syncErrorupdatedAt": null"2025-06-11T03:48:58.000000Z",
            "statusemergencyStopped": "PROCESS",false,
            "createdAtexternalEmergencyStopId": "2025-06-03T05:34:42.000000Z"null,
            "updatedAtsendReportAfterFinish": "2025-06-03T05:34:44.000000Z"true,
            "emergencyStoppedadditionalOptions": false,{
                "externalEmergencyStopIdfullListMethod": null"external",
                "sendReportAfterFinishfullListTime": false5,
            "additionalOptions    "useTr": {true,
                "fullListMethodallowCallTimeFrom": "external"34800,
                "fullListTimeallowCallTimeTo": 075636,
                "useTrrecordCall": falsetrue,
                "allowCallTimeFromrecTrimLeft": 359760,
                "allowCallTimeTodetectRobot": 75636true,
                "recordCalldetectRobotMode": true"block",
                "recTrimLeftdetectRobotGreeting": 0"bce7d22e-dde6-4427-b391-ebbdfda44de6",
                "detectRobotproviderId": falsenull,
                "detectRobotModefz230": null,false
             },
            "detectRobotGreetingredialStrategyOptions": null,{
                "providerIdredialStrategyEn": nulltrue,
                "fz230busy": false{
            },
        "redial": true,
   "redialStrategyOptions": {
                "redialStrategyEntime": false14,
                    "busycount": null,4
                "noAnswer": null},
                "answerMashnoAnswer": null,
{
                    "congestionredial": nulltrue,
                    "answerNoListtime": null12,
                    "candidateLimitcount": null,2
                "numberLimit": null},
            },
    "answerMash": {
       "webhookUrls": [],
            "isPendingredial": falsetrue,
            "addCandidateBlockedReason        "time": []15,
                    "pauseReasoncount": null,
5
                },
                "scheduleIdcongestion": null{
           }
    ]
}

Описание полей ответа:

         "redial": true,
                    "time": 11,
                    "count": 1
                },
                "answerNoList": {
                    "redial": true,
                    "time": 13,
                    "count": 3
                },
                "candidateLimit": {
                    "redial": true,
                    "time": null,
                    "count": 10
                },
                "numberLimit": {
                    "redial": true,
                    "time": null,
                    "count": 3
                }
            },
            "webhookUrls": [
                "https://example.com"
            ],
            "isPending": false,
            "addCandidateBlockedReason": [],
            "pauseReason": null,
            "scheduleId": "bce7d22e-dde6-4427-b391-ebbdfda44de6"
        }
    ]
}

Описание полей ответа:

Поле	Тип	Описание
count	string	Общее количество найденных заданий на обзвон
items	Array[Object]	Массив найденных заданий на обзвон
\| id	string	Идентификатор задания на обзвон
\| name	string	Имя обзвона
\| defaultExec	string	Тип звонящего. Всегда принимает значение robot
\| defaultExecData	string	uuid сценария, который используется в обзвоне ботом
\| secondExec	string	Действие, если робот запросил переадресацию. Принимает значения: end (Завершить) ignore (Ничего не делать) ch (Передать вызов на канал)
\| secondExecData	string	uuid канала для перевода. Параметр нужен, если предыдущий параметр в значении ch
\| cidType	string	Определяемый номер. Принимает значения: default (По умолчанию для транка) gornum (Один номер) pool (Группа номеров)
\| cidData	string	id сущности, выбранной в cidType. Актуально для gornum и pool
\| cps	float	Интенсивность обзвона. Может обозначаться как N звонков в секунду или как 1 звонок в N секунд. Для N звонков в 1 секунду вычисляется как 1+N/100, где N – желаемое число наборов номера в секунду (CPS). Например: CPS = 3, тогда значение поля 1.03 (при N=3 вычисляется 1+3/100=1.03) ——————————— Для 1 звонка в N секунд вычисляется как 1-N/100, где N - 1 звонок в N секунд. Например: Интенсивность 1 звонок в 60 секунд, тогда значение поля 0.4 (при N=60 вычисляется 1-60/100=0.4)
\| taskComment	string	Комментарий к заданию
\| startType	string	Режим запуска задания. Принимает значения: manual (Вручную) time (В указанное время)
\| startMoment	string	Дата и время начала обзвона. Принимает значения: ГГГГ-ММ-ДД чч:мм *Используется часовой пояс компании
\| phoneNormalization	string	Определяет, активирован ли процесс нормализации. Если null, отключено, если RU — нормализация в российский формат.
\| normalizationErrorAction	string	Указывает действие при возникновении ошибки нормализации. Для этого параметра необходимо активировать нормализацию. Доступны следующие варианты: `IGNORE_NORMALIZATION_ERROR —` пропустить номер, вызвавший ошибку. `SET_NORMALIZATION_ERROR_FLAG —` добавить номер, отметив его как невозможный к нормализации.
\| callStrategy	string	Cтратегия перезвонов. Доступны следующие варианты: STEP_2_STEP – последовательный PARALLEL – параллельный
\| checkPhone	boolean	Включена ли проверка номеров
\| externalId	int	Внутренний идентификатор. Используется для нужд технической поддержки.
\| syncFail	boolean	Произошла ли ошибка синхронизации задания
\| syncError	string	Подробное описание ошибки синхронизации
\| status	string	Статус задания С доступными статусами и их описание можно ознакомиться в отдельной статье: https://confluence.twin24.ai/x/4oB2EQ
\| createdAt	string	Дата создания задания
\| updatedAt	string	Дата последнего обновления задания
\| emergencyStopped	boolean	Были ли экстренная остановка задания
\| externalEmergencyStopId	string	Внутренний идентификатор. Используется для нужд технической поддержки.
\| sendReportAfterFinish	boolean	Отправлять ли отчет после завершения задания на почту
\| additionalOptions	Object	Дополнительные параметры вызовов
\| \| fullListMethod	string	Считать ли звонок результативным. Всегда принимает значение reject
\| \| fullListTime	int	Через сколько секунд считать звонок результативным
\| \| useTr	boolean	Учитывать ли время получателя
\| \| allowCallTimeFrom	int	Начало интервала доступного для дозвона. Задается в секундах
\| \| allowCallTimeTo	int	Конец интервала доступного для дозвона. Задается в секундах
\| \| recordCall	boolean	Записывать ли звонки
\| \| recTrimLeft	int	На сколько обрезать начало записи. Задается в секундах
\| \| detectRobot	boolean	Включать ли систему определения человек/робот
\| \| detectRobotMode	string	Режим системы определителя. Принимает значения: back (Фоновая) block (С блокировкой)
\| \| detectRobotGreeting	string	Идентификатор файла "приветствия", который проигрывается при режиме "С блокировкой" системы определния человек/робот
\| \| providerId	string	uuid транка. Актуально только при использовании собственного транка, если тех поддержка сообщила о необходимости использования данного параметра.
\| \| fz230	boolean	Включен ли режим соблюдения ФЗ-230
\| redialStrategyOptions	Object	Настройки правил перезвона
\| \| redialStrategyEn	boolean	Использовать ли правила перезвона
\| \| candidateLimit	Object	Максимальное количество вызовов кандидату
\| \| numberLimit	Object	Максимальное количество вызовов по номеру
\| \| \| redial	boolean	Активировать ли лимит по максимальному количеству вызовов
\| \| \| count	int	Максимальное количество вызовов
\| \| busy	Object	Занято
\| \| noAnswer	Object	Нет ответа
\| \| answerMash	Object	Ответил автоответчик
\| \| congestion	Object	Ошибка вызова
\| \| answerNoList	Object	Вызов нерезультативен
\| \| \| redial	boolean	Активировать ли сценарий перезвона

Поле

Тип

Описание

count

stringОбщее количество найденных заданий на обзвон

items

Array[Object]Массив найденных заданий на обзвон| idstringИдентификатор задания на обзвон| namestringИмя обзвона| defaultExecstring

Тип звонящего.

Всегда принимает значение robot

| defaultExecDatastringuuid сценария, который используется в обзвоне ботом| secondExecstring

Действие, если робот запросил переадресацию.

Принимает значения:

end (Завершить)
ignore (Ничего не делать)
ch (Передать вызов на канал)

| secondExecDatastring

uuid канала для перевода.

Параметр нужен, если предыдущий параметр в значении ch

| cidTypestring

Определяемый номер.

Принимает значения:

default (По умолчанию для транка)
gornum (Один номер)
pool (Группа номеров)

| cidDatastring

id сущности, выбранной в cidType.

Актуально для gornum и pool

| cpsfloat

Интенсивность обзвона.
Может обозначаться как N звонков в секунду или как 1 звонок в N секунд.

Для N звонков в 1 секунду вычисляется как 1+N/100, где N – желаемое число наборов номера в секунду (CPS).

Например:

CPS = 3, тогда значение поля 1.03 (при N=3 вычисляется 1+3/100=1.03)
———————————

Для 1 звонка в N секунд вычисляется как
1-N/100, где N - 1 звонок в N секунд.

Например:

Интенсивность 1 звонок в 60 секунд, тогда значение поля 0.4 (при N=60 вычисляется 1-60/100=0.4)

| taskCommentstringКомментарий к заданию| startTypestring

Режим запуска задания.

Принимает значения:

manual (Вручную)
time (В указанное время)

| startMomentstring

Дата и время начала обзвона.

Принимает значения:

ГГГГ-ММ-ДД чч:мм

*Используется часовой пояс компании

| phoneNormalizationstringОпределяет, активирован ли процесс нормализации. Если null, отключено, если RU — нормализация в российский формат.| normalizationErrorActionstringУказывает действие при возникновении ошибки нормализации. Для этого параметра необходимо активировать нормализацию. Доступны следующие варианты:

IGNORE_NORMALIZATION_ERROR — пропустить номер, вызвавший ошибку.
SET_NORMALIZATION_ERROR_FLAG — добавить номер, отметив его как невозможный к нормализации.

| webhookUrlsArray[string]URL адреса, на которые будет отправлен webhook| additionalOptionsObjectДополнительные параметры вызовов| | fullListMethodstring

Считать ли звонок результативным.

Всегда принимает значение reject

| | fullListTimeintЧерез сколько секунд считать звонок результативным| | useTrbooleanУчитывать ли время получателя| | allowCallTimeFromintНачало интервала доступного для дозвона. Задается в секундах| | allowCallTimeTointКонец интервала доступного для дозвона. Задается в секундах| | recordCallbooleanЗаписывать ли звонки | | recTrimLeftintНа сколько обрезать начало записи. Задается в секундах| | detectRobotbooleanВключать ли систему определения человек/робот | | detectRobotModestring

Режим системы определителя.

Принимает значения:

back (Фоновая)
block (С блокировкой)

| | providerIdstring

uuid транка.

Актуально только при использовании собственного транка.

| redialStrategyOptionsObjectНастройки правил перезвона| | redialStrategyEnbooleanИспользовать ли правила перезвона| | candidateLimitObjectМаксимальное количество вызовов кандидату| | numberLimitObjectМаксимальное количество вызовов по номеру| | | redialbooleanАктивировать ли лимит по максимальному количеству вызовов

| | |

count

time

int

Максимальное количество вызовов

Промежуток перезвона. Задается в секундах

| | |

busy

count

Object

int

Занято

Количество перезвонов

|

| noAnswerObject

webhookUrls

Array[string]

URL адреса, на которые будет отправлен webhook

Нет ответа

|

| answerMashObject

isPending

boolean

Ожидается ли смена статуса задания

Ответил автоответчик

|

| congestionObjectОшибка вызова

addCandidateBlockedReason

Array[string]

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

Принимает значения:

OUTDATED – задание старше месяца
GATEWAY – задание создано через нативную интеграцию (Битрикс24, AmoCRM и т.д.)
BILLING – отрицательный баланс у компании

| pauseReason

string

Причина остановки задания.

Принимает значения:

USER - остановлено пользователем
INCOMING_RULE_DELETED - удален callerId
CALLER_POOL_DELETED - удален callerPool
BOT_SETTINGS_DELETED - удален бот
CALLER_POOL_SYNC_ERROR - ошибка при сохранении callerPool
SMS_SENDING_ERROR - ошибка отправки СМС

| scheduleId

string

Идентификатор используемого расписания обзвона

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

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

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

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

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

Ключ