POST: https://twin24.ai/cis/api/v1/telephony/autoCall
Этот метод позволяет создать новое задание на автоматический обзвон. После успешного выполнения запроса будет возвращен идентификатор созданного задания.
Время запуска задания зависит от параметра
startType.
curl --location 'https://twin24.ai/cis/api/v1/telephony/autoCall' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
"additionalOptions": {
"allowCallTimeFrom": 35976,
"allowCallTimeTo": 75636,
"detectRobot": false,
"detectRobotMode": null,
"detectRobotGreeting": null,
"fullListMethod": "reject",
"fullListTime": 0,
"providerId": null,
"recordCall": true,
"recTrimLeft": 0,
"useTr": false,
"fz230": false
},
"callStrategy": "STEP_2_STEP",
"lifetime":600,
"cidData": "8a5932f6-fbc0-4667-b91c-2ddd1b46aed0",
"cidType": "gornum",
"cps": 1,
"defaultExec": "robot",
"defaultExecData": "c5bea15e-2c00-4e06-a4df-204c67009944",
"name": "autoCallName",
"redialStrategyOptions": {
"answerMash": {
"count": 0,
"redial": false,
"time": 0
},
"answerNoList": {
"count": 0,
"redial": false,
"time": 0
},
"busy": {
"count": 0,
"redial": false,
"time": 0
},
"congestion": {
"count": 0,
"redial": false,
"time": 0
},
"noAnswer": {
"count": 0,
"redial": false,
"time": 0
},
"candidateLimit": {
"count": 0,
"redial": false
},
"numberLimit": {
"count": 0,
"redial": false
},
"redialStrategyEn": false
},
"secondExec": "end",
"secondExecData": "",
"startMoment": "",
"startType": "manual",
"taskComment": "",
"webhookUrls": [],
"checkPhone": true,
"phoneNormalization": null,
"normalizationErrorAction": null,
"sendReportAfterFinish": false,
"scheduleId": null
}
{
"name": "test_autocall",
"defaultExec": "robot",
"defaultExecData": "228cc4fa-92f2-4709-94e3-7344a96a5903",
"secondExec": "ch",
"secondExecData": "48a77bd7-8762-4e0f-a277-4ef77e36c41b",
"cidType": "gornum",
"cidData": "9a67dee5-398e-4570-9426-fbb3f067b270",
"startType": "time",
"startMoment": "2023-06-02 10:00",
"cps": 1.03,
"lifetime": 600,
"taskComment": "Тестовое задание для демонстрации работы API",
"webhookUrls": [
"https://webhook.site/6f44...2aa287f",
"https://typedwebhook.tools/webhook/4c6d9...8720ab39"
],
"additionalOptions": {
"fullListMethod": "reject",
"fullListTime": 0,
"useTr": false,
"allowCallTimeFrom": 0,
"allowCallTimeTo": 86399,
"recordCall": true,
"recTrimLeft": 0,
"detectRobot": true,
"detectRobotMode": "back",
"providerId": null
},
"redialStrategyOptions": {
"redialStrategyEn": false,
"candidateLimit": {
"redial": false,
"count": 0
},
"numberLimit": {
"redial": false,
"count": 0
},
"busy": {
"redial": false,
"time": 1,
"count": 1
},
"noAnswer": {
"redial": false,
"time": 1,
"count": 1
},
"answerMash": {
"redial": false,
"time": 1,
"count": 1
},
"congestion": {
"redial": false,
"time": 1,
"count": 1
},
"answerNoList": {
"redial": false,
"time": 1,
"count": 1
}
}
}
| Название | Тип | Обязательное | Описание |
|---|---|---|---|
name |
string | Да | Имя задания. |
defaultExec |
string | Да | Всегда принимает значение robot. |
defaultExecData |
string | Да | UUID сценария для обзвона. |
secondExec |
string | Да | Действие при переадресации (end (Завершить), ignore (Ничего не делать), ch (Передать вызов на канал)). |
secondExecData |
string | Да, если secondExec = ch |
UUID канала для перевода. |
cidType |
string | Да | Определяемый номер (default (По умолчанию для транка), gornum (Один номер), pool (Группа номеров)). |
cidData |
string | Да, если cidType = gornum или pool |
ID сущности в cidType. |
startType |
string | Да | Режим запуска (manual (Вручную), time (В указанное время)). |
startMoment |
string | Да, если startType = time |
Дата и время начала обзвона (ГГГГ-ММ-ДД ЧЧ:ММ). |
cps |
float | Да | Интенсивность обзвона. Рассчитывается как 1 + N / 100 для N звонков в секунду (пример: N = 3, тогда CPS = 1.03), или как 1 - N / 100 для 1 звонка в N секунд (пример: N = 60, тогда CPS = 0.4). |
lifetime |
integer | Нет | Срок действия задания в секундах. По истечении этого времени задание переводится в статус HALTED. Если поле не заполнено, задание может выполняться бессрочно. |
{
"id": {
"identity": "bce7d22e-dde6-4427-b391-ebbdfda44de6"
}
}
Описание полей ответа:
| Название | Тип | Обязательное | Описание |
|---|---|---|---|
id |
object | Да | Идентификатор задания. |
identity |
string | Да | Уникальный ID обзвона. |
{
"timestamp": 1544098870,
"type": "MyNamespace\\MyClass",
"error": "string",
"details": {}
}
Описание полей ответа:
| Название | Тип | Обязательное | Описание |
|---|---|---|---|
timestamp |
integer | Да | Текущее время. |
type |
string | Да | Класс исключения. |
error |
string | Да | Сообщение об ошибке. |
details |
object | null | Нет | Дополнительная информация об ошибке. |
{
"timestamp": 1544098870,
"type": "MyNamespace\\MyClass",
"error": "string",
"details": {}
}
Описание полей ответа:
| Название | Тип | Обязательное | Описание |
|---|---|---|---|
timestamp |
integer | Да | Текущее время. |
type |
string | Да | Класс исключения. |
error |
string | Да | Сообщение об ошибке. |
details |
object | null | Нет | Дополнительная информация об ошибке. |