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

...

URL: https://twin24.ai/cis/api/v1/telephony/incomingRules/create/batch

pycURL

Раскрыть

title	cURL (Нажмите, чтобы раскрыть)

Блок кода

language

python
theme	DJango

title

collapse

true

curl --location 'https://twin24.ai/cis/api/v1/telephony/incomingRules/create/batch' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{
    "additionalOptions": {
        "callRecord": "all",
        "comment": "Комментарий"
    },
    "incomingCallsOptions": {
        "action": "robot",
        "botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
        "cidAsName": "

num_name

default",
        "cidAsNumber": "

caller

default",
        "reserveAction": "default",
        "reserveActionData": null,
        "reserveCidAsName": "original",
        "reserveCidAsNumber": "original"
    },

 "notificationOptions": {
        "

condition

type": "

unanswer

off",
        "

emailReceivers

condition":

[]

"unanswer",
        "

smsReceivers

emailReceivers": [],
        "

type

smsReceivers":

"off"

[]
    },

"webhookUrls": [
        "https://sample.com"
    ],
    "names": [
        "Название номера 1",
        "Название номера 2"
    ],
    "numbers": [
        "71234567001",
        "71234567002"
    ],
    "connectionOptionsList": [
        {
            "authUser": "",
            "forceOutOverChannel": true,
            "fromDomain": "",
            "login": "",
            "password": "",
            "providerId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "did": "123",
            "numberAsDid": false
        },
        {
            "authUser": "",
            "forceOutOverChannel": true,
            "fromDomain": "",
            "login": "",
            "password": "",
            "providerId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "did": "456",
            "numberAsDid": true
        }
    ]
}'

Раскрыть

title	Тело запроса (Нажмите, чтобы раскрыть)

Блок кода

language	py
theme	DJango
title	Тело запроса
collapse	true

{
    "additionalOptions": {
        "callRecord": "all",
        "comment": "Комментарий"
    },
    "incomingCallsOptions": {
        "action": "robot",
        "botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
        "cidAsName": "

num_name

default",
        "cidAsNumber": "

caller

default",
        "reserveAction": "default",
        "reserveActionData": null,
        "reserveCidAsName": "original",
        "reserveCidAsNumber": "original"
    },

 "notificationOptions": {
        "

condition

type": "

unanswer

off",
        "

emailReceivers

condition":

[]

"unanswer",
        "

smsReceivers

emailReceivers": [],
        "

type

smsReceivers":

"off"

[]
    },

"webhookUrls": [
        "https://sample.com"
    ],
    "names": [
        "Название номера 1",
        "Название номера 2"
    ],
    "numbers": [
        "71234567001",
        "71234567002"
    ],
    "connectionOptionsList": [
        {
            "authUser": "",
            "forceOutOverChannel": true,
            "fromDomain": "",
            "login": "",
            "password": "",
            "providerId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "did": "123",
            "numberAsDid": false
        },
        {
            "authUser": "",
            "forceOutOverChannel": true,
            "fromDomain": "",
            "login": "",
            "password": "",
            "providerId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "did": "456",
            "numberAsDid": true
        }
    ]
}

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

Поле	Тип	Обязательно	Описание
additionalOptions	Object	Нет	Дополнительные опции
\| callRecord	String	Нет	Включить ли запись диалогов. Принимает значения: all – включить off – выключить
\| comment	String	Нет	Комментарий к добавленным номерам
incomingCallsOptions	Object	Да	Настройки правил обработки входящих звонков
\| action	String	Да	Действие при входящем звонке. Принимает значения: robot – перевести звонок на робота end – не обрабатывать входящие звонки
\| botId	String	Да, если action = robot	Идентификатор бота для перевода
\| cidAsName	String	Да, если action = robot	Имя звонящего Принимает значения: default – значение по умолчанию (рекомендуемое) num_caller – номер звонящего num_name – название номера num_called – номер назначения (текущий номер)
\| cidAsNumber	String	Да, если action = robot	Номер звонящего Принимает значения: default – значение по умолчанию (рекомендуемое) caller – номер звонящего called – номер назначения (текущий номер)
\| reserveAction	String	Да, если action = robot	Всегда принимает значение default
\| reserveActionData

String

	null	Да, если action = robot	Всегда принимает значение null
\| reserveCidAsName	String	Да, если action = robot	Всегда принимает значение original
\| reserveCidAsNumber	String	Да, если action = robot	Всегда принимает значение original
notificationOptions	Object	Да	Параметры нотификаций (на данный момент не активны, но обязательны для заполнения). В описании параметров ниже будет указано только значение, которое нужно передавать в этом поле
\| type	String	Да	off
\| condition	String	Да	unanswer
\| emailReceivers	Empty List	Да	[

String

]
\| smsReceivers	Empty List	Да	[

String

]

| type

String

webhookUrls	List[String]	Нет	Массив адресов для отправки вебхуков по входящим звонкам
names	List[String]	Да	Массив имен добавляемых номеров
numbers	List[String]	Да	Массив добавляемых номеров
connectionOptionsList	List[Object]	Да	Массив настроек добавляемых номеров
\| authUser	String	Нет	Пользователь для аутентификации
\| forceOutOverChannel	Boolean	Нет	Принудительно отправлять звонки через данное подключение. Если true – любые вызовы в мир будут отправлены через текущего провайдера и с использованием указанных учетных данных
\| fromDomain	String	Нет	Значение fromDomain
\| login	String	Нет	Логин для авторизации номера
\| password	String	Нет	Пароль для авторизации номера
\| providerId	String	Да	Идентификатор транка/оператора
\| did	String	Да, если numberAsDid false	DID (Direct Inward Dialing)
\| numberAsDid	Boolean

...

language	python
theme	DJango
title	Ответ в формате JSON
collapse	true

Да	Если true, то в качестве DID используется сам номер

При успешном выполнении метода придет ответ с кодом 200 без тела

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

...

Поле

...

Тип

...

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

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

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

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

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

Ключ