Метод на получение списка созданных заданий на обзвон

Метод: GET

Authorization: Bearer Token

URL: https://twin24.ai/cis/api/v1/telephony/autoCall

cURL (пример)

curl --location 'https://cis.twin24.ai/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	Строка со списком статусов через запятую БЕЗ пробелов (Перечень статусов указан ниже)	Фильтр по статусам заданий. Статусы указываются через запятую БЕЗ пробела
sort	name, cps, createdAt, updatedAt, status	Для сортировки результатов запроса доступны следующие поля: name — название задания на обзвон; cps — параметр CPS (calls per second); createdAt — дата и время создания задания на обзвон; updatedAt — дата и время последнего изменения в задании на обзвон; status — текущий статус задания Для указания желаемого порядка сортировки используются специальные префиксы: «+» — для сортировки по возрастанию (по умолчанию); «-» — для сортировки по убыванию. Например, чтобы отсортировать задания в порядке убывания даты создания задания, нужно указать: -createdAt.
keyword	Строка с фразой для поиска	Фильтр по названию задания на обзвон

status	Описание
BLANK	Задание создано, но кандидаты на обзвон в него не загружались. Задание пустое. Звонить некому.
READY	Создано, кандидаты загружены. Готово к обзону.
PROCESS	Прямо сейчас находится в процессе обзвона.
PAUSED	Задание находится на паузе. Было остановлено.
DONE	Обработка задания полностью завершена.
PAUSED_NO_MONEY	Задание было остановлено из-за отрицательного баланса.
TIMEOUT	Аварийная остановка задания (техническая ошибка)
PAUSED_NOBODY	Приостановлено некому звонить в данный момент, например тайм зоны недоступны или не прошло время для повторной попытки.
ERROR_PREPARING	Ошибка подготовки. (техническая ошибка)
DELETING	Задание находится в очереди на удаление, ждет отработки процедуры.
PAUSED_SCHEDULE	приостановлено по расписанию
HALTED	Задание остановлено навсегда. Попыток и звонков больше предприниматься не будет.
PAUSED_NO_CID	Приостановлено, не выбран callerId.
NO_NEXT_CALL	Не удалось расчитать время следующего звонка (фактически аварийное завершение, техническая ошибка)

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

{
    "count": 4,
    "items": [
        {
            "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "name": "Тестовое задание на обзвон",
            "defaultExec": "robot",
            "defaultExecData": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "secondExec": "end",
            "secondExecData": null,
            "cidType": "gornum",
            "cidData": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "cps": "1",
            "taskComment": "",
            "startType": "manual",
            "startMoment": "",
            "phoneNormalization": null,
            "normalizationErrorAction": null,
            "callStrategy": "STEP_2_STEP",
            "checkPhone": true,
            "externalId": 123456,
            "syncFail": false,
            "syncError": null,
            "status": "PROCESS",
            "createdAt": "2025-06-03T05:34:42.000000Z",
            "updatedAt": "2025-06-03T05:34:44.000000Z",
            "emergencyStopped": false,
            "externalEmergencyStopId": null,
            "sendReportAfterFinish": false,
            "additionalOptions": {
                "fullListMethod": "external",
                "fullListTime": 0,
                "useTr": false,
                "allowCallTimeFrom": 35976,
                "allowCallTimeTo": 75636,
                "recordCall": true,
                "recTrimLeft": 0,
                "detectRobot": false,
                "detectRobotMode": null,
                "detectRobotGreeting": null,
                "providerId": null,
                "fz230": false
            },
            "redialStrategyOptions": {
                "redialStrategyEn": false,
                "busy": null,
                "noAnswer": null,
                "answerMash": null,
                "congestion": null,
                "answerNoList": null,
                "candidateLimit": null,
                "numberLimit": null
            },
            "webhookUrls": [],
            "isPending": false,
            "addCandidateBlockedReason": [],
            "pauseReason": null,
            "scheduleId": null
        }
    ]
}

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

Поле	Тип	Описание
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
\| checkPhone
\| externalId
\| syncFail
\| syncError
\| status
\| createdAt
\| updatedAt
\| emergencyStopped
\| externalEmergencyStopId
\| sendReportAfterFinish
\| additionalOptions	Object	Дополнительные параметры вызовов
\| \| fullListMethod	string	Считать ли звонок результативным. Всегда принимает значение reject
\| \| fullListTime	int	Через сколько секунд считать звонок результативным
\| \| useTr	boolean	Учитывать ли время получателя
\| \| allowCallTimeFrom	int	Начало интервала доступного для дозвона. Задается в секундах
\| \| allowCallTimeTo	int	Конец интервала доступного для дозвона. Задается в секундах
\| \| recordCall	boolean	Записывать ли звонки
\| \| recTrimLeft	int	На сколько обрезать начало записи. Задается в секундах
\| \| detectRobot	boolean	Включать ли систему определения человек/робот
\| \| detectRobotMode	string	Режим системы определителя. Принимает значения: back (Фоновая) block (С блокировкой)
\| \| detectRobotGreeting
\| \| providerId	string	uuid транка. Актуально только при использовании собственного транка.
\| \| fz230
\| redialStrategyOptions	Object	Настройки правил перезвона
\| \| redialStrategyEn	boolean	Использовать ли правила перезвона
\| \| candidateLimit	Object	Максимальное количество вызовов кандидату
\| \| numberLimit	Object	Максимальное количество вызовов по номеру
\| \| \| redial	boolean	Активировать ли лимит по максимальному количеству вызовов
\| \| \| count	int	Максимальное количество вызовов
\| \| busy	Object	Занято
\| \| noAnswer	Object	Нет ответа
\| \| answerMash	Object	Ответил автоответчик
\| \| congestion	Object	Ошибка вызова
\| \| answerNoList	Object	Вызов нерезультативен
\| \| \| redial	boolean	Активировать ли сценарий перезвона
\| \| \| time	int	Промежуток перезвона. Задается в секундах
\| \| \| count	int	Количество перезвонов
\| webhookUrls	Array[string]	URL адреса, на которые будет отправлен webhook
isPending
addCandidateBlockedReason
pauseReason
scheduleId

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

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