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

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Блок кода
languagejson
titleОтвет в формате 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]Массив найденных заданий на обзвон
|    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 — добавить номер, отметив его как невозможный к нормализации.

|   
webhookUrls
callStrategy  
|    checkPhone  
|    externalId  
|    syncFail  
|    syncError  
|    status  
|    createdAt  
|    updatedAt  
|    emergencyStopped  
|    externalEmergencyStopId  
|    sendReportAfterFinish  
Array[string]URL адреса, на которые будет отправлен webhook
|    additionalOptionsObjectДополнительные параметры вызовов
|    |    fullListMethodstring

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

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

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

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

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

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

 

|    |    providerIdstring

uuid транка. 

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

|    |    fz230 

 

|    redialStrategyOptionsObjectНастройки правил перезвона
|    |    redialStrategyEnbooleanИспользовать ли правила перезвона
|    |    candidateLimitObjectМаксимальное количество вызовов кандидату
|    |    numberLimitObjectМаксимальное количество вызовов по номеру
|    |    |    redialbooleanАктивировать ли лимит по максимальному количеству вызовов
|    |    |    countintМаксимальное количество вызовов
|    |    busyObjectЗанято
|    |    noAnswerObjectНет ответа
|    |    answerMashObjectОтветил автоответчик
|    |    congestionObjectОшибка вызова 
|    |    answerNoListObjectВызов нерезультативен
|    |    |    redialbooleanАктивировать ли сценарий перезвона
|    |    |    timeintПромежуток перезвона. Задается в секундах
|    |    |    countintКоличество перезвонов 
|    webhookUrlsArray[string]URL адреса, на которые будет отправлен webhook
isPending  
addCandidateBlockedReason  
pauseReason  
scheduleId