...
Блок кода | ||||
---|---|---|---|---|
| ||||
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 | «Отступ» от начала записей. То есть с какой записи начинать вывод. Смещение по позиции полученной информации.
| ||
| Целое число от 0 | Номер «страницы» с записями.
| ||
limit | Целое число от 1 до 1 000 | Количество записей на одной странице. Максимум 1000 объектов. | ||
| url encoded дата в формате - Например: Начало периода в формате decoded: | Дата и время, от которой требуется провести поиск статистики. url-encoded дата в формате - | ||
to | url encoded дата в формате - Например: Начало периода в формате decoded: В запросе требуется использовать дату и время в формате encoded. | Дата и время, до которой требуется провести поиск статистики. url-encoded дата в формате - | ||
status | Строка со списком статусов через запятую БЕЗ пробелов (Перечень статусов указан ниже) | Фильтр по статусам заданий. Статусы указываются через запятую БЕЗ пробела. С доступными статусами и их описание можно ознакомиться в отдельной статье: https://confluence.twin24.ai/x/4oB2EQ | ||
sort | name, cps, createdAt, updatedAt, status | Для сортировки результатов запроса доступны следующие поля:
Для указания желаемого порядка сортировки используются специальные префиксы: «+» — для сортировки по возрастанию (по умолчанию); | ||
keyword | Строка с фразой для поиска | Фильтр по названию задания на обзвон |
Блок кода |
---|
...
|
...
|
...
Аварийная остановка задания (техническая ошибка)
...
Приостановлено некому звонить в данный момент, например тайм зоны недоступны или не прошло время для повторной попытки.
...
Ошибка подготовки. (техническая ошибка)
...
приостановлено по расписанию
...
Задание остановлено навсегда. Попыток и звонков больше предприниматься не будет.
...
Приостановлено, не выбран callerId.
...
Не удалось расчитать время следующего звонка (фактически аварийное завершение, техническая ошибка)
| ||||
{
| ||||
Блок кода | ||||
---|---|---|---|---|
| ||||
{
"count": 1,
"items": [
{
"id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"name": "Метод на получение списка созданных заданий на обзвон",
"defaultExec": "robot",
"defaultExecData": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"secondExec": "ch",
"secondExecData": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"cidType": "gornum",
"cidData": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"cps": "1",
"taskComment": "Тестовое задание для статьи \"Метод на получение списка созданных заданий на обзвон\"",
"startType": "time",
"startMoment": "2025-06-11 04:00",
"phoneNormalization": "RU",
"normalizationErrorAction": "SET_NORMALIZATION_ERROR_FLAG",
"callStrategy": "PARALLEL",
"checkPhone": true,
"externalId": 123456,
"syncFail": false,
"syncError": null,
"status": "BLANK",
"createdAt": "2025-06-11T03:46:35.000000Z",
"updatedAt": "2025-06-11T03:48:58.000000Z",
"emergencyStopped": false,
"externalEmergencyStopId": null,
"sendReportAfterFinish": true,
"additionalOptions": {
"fullListMethod": "external",
"fullListTime": 5,
"useTr": true,
"allowCallTimeFrom": 34800,
"allowCallTimeTo": 75636,
"recordCall": true,
"recTrimLeft": 0,
"detectRobot": true,
"detectRobotMode": "block",
"detectRobotGreeting": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"providerId": null,
"fz230": false
},
"redialStrategyOptions": {
"redialStrategyEn": true,
"busy": {
"redial": true,
"time": 14,
"count": 4
},
"noAnswer": {
"redial": true,
"time": 12,
"count": 2
},
"answerMash": {
"redial": true,
"time": 15,
"count": 5
},
"congestion": {
"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 | Действие, если робот запросил переадресацию. Принимает значения:
| ||
| secondExecData | string | uuid канала для перевода. Параметр нужен, если предыдущий параметр в значении ch | ||
| cidType | string | Определяемый номер. Принимает значения:
| ||
| cidData | string | id сущности, выбранной в cidType. Актуально для gornum и pool | ||
| cps | float | Интенсивность обзвона. Для N звонков в 1 секунду вычисляется как 1+N/100, где N – желаемое число наборов номера в секунду (CPS). Например: CPS = 3, тогда значение поля 1.03 (при N=3 вычисляется 1+3/100=1.03) Для 1 звонка в N секунд вычисляется как Например: Интенсивность 1 звонок в 60 секунд, тогда значение поля 0.4 (при N=60 вычисляется 1-60/100=0.4) | ||
| taskComment | string | Комментарий к заданию | ||
| startType | string | Режим запуска задания. Принимает значения:
| ||
| startMoment | string | Дата и время начала обзвона. Принимает значения: ГГГГ-ММ-ДД чч:мм *Используется часовой пояс компании | ||
| phoneNormalization | string | Определяет, активирован ли процесс нормализации. Если null, отключено, если RU — нормализация в российский формат. | ||
| normalizationErrorAction | string | Указывает действие при возникновении ошибки нормализации. Для этого параметра необходимо активировать нормализацию. Доступны следующие варианты:
| ||
| callStrategy | string | Cтратегия перезвонов. Доступны следующие варианты:
| ||
| checkPhone | boolean | Включена ли проверка номеров | ||
| externalId | int | Внутренний идентификатор. Используется для нужд технической поддержки. | ||
| syncFail | boolean | Произошла ли ошибка синхронизации задания | ||
| syncError | string | Подробное описание ошибки синхронизации | ||
| status | 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 | Режим системы определителя. Принимает значения:
| ||
| | 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 | Активировать ли сценарий перезвона | ||
| | | time | int | Промежуток перезвона. Задается в секундах | ||
| | | count | int | Количество перезвонов | ||
| webhookUrls | Array[string] | URL адреса, на которые будет отправлен webhook | ||
| isPending | boolean | Ожидается ли смена статуса задания | ||
| addCandidateBlockedReason | Array[string] | Причина почему нельзя добавлять кандидатов в задание. Принимает значения:
| ||
| pauseReason | string | Причина остановки задания. Принимает значения:
| ||
| scheduleId | string | Идентификатор используемого расписания обзвона |
...