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

Ключ

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

Метод: POSTDELETE

Authorization: Bearer Token

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

Вместо {AON} в методе ниже нужно указать идентификатор задания на обзвон

Раскрыть
titlecURL (Нажмите, чтобы раскрыть)
Блок кода
languagepython
themeDJango
curl --location --globoff --request DELETE 'https://twin24.ai/cis/api/v1/telephony/incomingRules/create/batch{AON}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{
    "additionalOptions": {
        "callRecord": "all",
        "comment": "Комментарий"
    },
    "incomingCallsOptions": {
        "action": "robot",
        "botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
        "cidAsName": "default",
        "cidAsNumber": "default",
        "reserveAction": "default",
        "reserveActionData": null,
        "reserveCidAsName": "original",
        "reserveCidAsNumber": "original"
    },
    "notificationOptions": {
        "type": "off",
        "condition": "unanswer",
        "emailReceivers": [],
        "smsReceivers": []
    },
    "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Тело запроса (Нажмите, чтобы раскрыть)
Блок кода
languagepy
themeDJango
titleТело запроса
collapsetrue
{
    "additionalOptions": {
        "callRecord": "all",
        "comment": "Комментарий"
    },
    "incomingCallsOptions": {
        "action": "robot",
        "botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
        "cidAsName": "default",
        "cidAsNumber": "default",
        "reserveAction": "default",
        "reserveActionData": null,
        "reserveCidAsName": "original",
        "reserveCidAsNumber": "original"
    },
    "notificationOptions": {
        "type": "off",
        "condition": "unanswer",
        "emailReceivers": [],
        "smsReceivers": []
    },
    "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

...

|    callRecord

...

Включить ли запись диалогов. 

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

  • all – включить
  • off – выключить

...

|    comment

...

incomingCallsOptions

...

|    action

...

Действие при входящем звонке. 

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

  • robot – перевести звонок на робота
  • end – не обрабатывать входящие звонки

...

|    botId

...

|    cidAsName

...

Имя звонящего

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

  • default – значение по умолчанию (рекомендуемое)
  • num_caller – номер звонящего
  • num_name – название номера
  • num_called – номер назначения (текущий номер)

...

|    cidAsNumber

...

Номер звонящего

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

  • default – значение по умолчанию (рекомендуемое)
  • caller – номер звонящего
  • called – номер назначения (текущий номер)

...

|    reserveAction

...

|    reserveActionData

...

|    reserveCidAsName

...

|    reserveCidAsNumber

...

notificationOptions

...

Параметры нотификаций (на данный момент не активны, но обязательны для заполнения). 

В описании параметров ниже будет указано только значение, которое нужно передавать в этом поле

...

|    type

...

|    condition

...

|    emailReceivers

...

|    smsReceivers

...

webhookUrls

...

names

...

numbers

...

connectionOptionsList

...

|    authUser

...

|    forceOutOverChannel

...

Принудительно отправлять звонки через данное подключение. 

Если true – любые вызовы в мир будут отправлены через текущего провайдера и с использованием указанных учетных данных

...

|    fromDomain

...

|    login

...

|    password

...

|    providerId

...

|    did

...

|    numberAsDid

...

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