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

Ключ

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

...

Authorization: Bearer Token

 

(Метод для получения токена по логину и паролю)

URL: https://tcl.twin24.ai/api/cis/beta/tasks

...

Блок кода
languagepy
themeDJango
firstline1
titleТело запроса в формате Json
linenumberstruecollapsetrue
{

    "name": "02.02 тестирование на номер Никиты",

    "botId": "44e62ac6-6c08-4ad1-923d-5ee3299dd737",

    "dialplanId": "d71c9c44-e942-4c6c-9ccc-ea5a043efb75",

    "backgroundNoise": "/background/office.wav",




    "amd": {

        "enabled": true,

        "mode": "BACK",

        "file": null

    },




    "defaultCallerId": {

        "type": "Custom ",

        "data": "7913391204779996662211",

        "additional": null

    },

   

    "defaultRedirect": {

        "type": "hangup",

        "data": null,

        "additional": null

    },




    "scheduledAt": null,

    "intensity": 1,
    
    "webhookUrl": "https://webhook.site/12345678",




    "allowedTimeRange": {

        "from": 32500,

        "to": 79000

    },




    "phoneNormalization": "ru",

    "detectGenderByVoice": true,

    "isTest": false,

   

    "recallRules": {

        "BUSY": {

            "enabled": true,

            "tries": 3,

            "interval": 900

        },

        "NO_ANSWER": {

            "enabled": true,

            "tries": 3,

            "interval": 1800

        },

        "MACHINE": {

            "enabled": true,

            "tries": 2,

            "interval": 1800

        },

        "CONGESTION": {

            "enabled": true,

            "tries": 3,

            "interval": 900

        },

        "NOT_SUCCESSFUL": {

            "enabled": false,

            "tries": null,

            "interval": null,

            "duration": 0

        }

    }

}


Подсказка

Значения полей параметров передаются в блоке Запрос к серверу передаются как JSON-объект в следующем виде:

Тип значенияПримерЗначение параметра
Значение true

{

"isTest": true

}

1
Значение false

{

"detectGenderByVoice": false

}

0
Значение null

{

"backgroundNoise": null

}



         Image Modified

Если параметр представляет собой пару «ключ/значение» JSON-объекта, то название этого параметра нужно указывать в следующем виде: <имя объекта>.<название параметра>.

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

Поле

Тип

Обязательно

Значение по умолчанию

Описание

name

string

Да


Имя задания. Задается в любом формате, который поможет отличить одно задание от другого и понять, кому звонили, и когда был обзвон.

botId

string

Да


Идентификатор сценария, по которому бот должен вести диалог с клиентом

,

в рамках

данного

задания на обзвон

.Для каждого аккаунта уникален, и указан у каждого сценария бота в личном кабинете

.


dialplanId


string


Да


Идентификатор плана набора подключенной

к аккаунту

телефонии.

Для

Уникален для каждого аккаунта

уникален, и указан

. Указан в настройках телефонии в личном кабинете.

backgroundNoise

string

Да

Нет

null

Настройка фонового шума

,

для создания ощущения естественности

, который

. Фоновый шум воспроизводится системой

,

во время работы бота.

Название файлов можно взять в личном кабинете.

Названия файлов отображаются в списке значений параметра Фоновый шум в окне Добавление нового задания на обзвон в кабинете администратора.

Например: /background/office.wav – шум офиса.

Null - если фоновый шум не

нужен

используется.

amd

amdInfo {
}

Да
Нет


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

enabled

boolean

Нет

Да
0

Поле, отвечающее за включение/отключение

работы

модуля определения автоответчиков

у всего задания

.

  • true – модуль определения автоответчиков включен и работает
  • false – модуль определения автоответчиков отключен и не работает

mode

string

Да

Нет

null

Режим работы модуля определения автоответчиков. Существует два режима работы:

  • back – модуль определения автоответчиков работает параллельно с работой бота
,
  • в синхронном режиме
blok
  • block – модуль определения автоответчиков блокирует работу бота и не дает
общаться по сценарию
  • начать диалог, пока не примет однозначного решения, что
на той стороне есть человек.
  • боту отвечает человек

file

string

Нет

Да

null

Указывается

Содержит путь к аудиофайлу приветствия

, при режиме

для режима работы модуля определения автоответчиков BLOCK.

Для режима BACK

укажите

используйте значение null.

defaultCallerId

defaultCallerIdInfo{

}

Да

Нет


Настройка параметров номера телефона (АОН), который

увидит

отображается на

своем телефоне клиент, получив звонок

телефоне клиента во время звонка от бота.

type


Нет

Да
default
 

Тип

АОНа

АОН:

  • Default – использовать номер телефона, указанный в настройках канала связи
  • Custom – использовать номер телефона, указанный в поле data
номер телефона
  • groupAON – использовать настроенную в личном кабинете группу
АОНов
  • АОН

data

Да


Нет

null

Первичный параметр настройки для

типов 

типов:

  • Custom –
указываем
  • определяет номер телефона, который
хотим использовать
  • используется в качестве
АОНа
  • АОН, в формате 7хххххххххх
  • groupAON –
указываем
  • определяет ID группы
АОНов
  • АОН,
настроенную
  • настроенной в
личном
  • кабинете администратора

Для Default - null

additional


Нет

null

Дополнительная информация

additional

Да

Доп ифнормация

.

Всегда null.

defaultRedirect

defaultRedirectInfo{

}

Нет


Настройка параметров переадресации звонка по умолчанию.

Будет использоваться

Используется, если сценарий требует перевода, и в

самом

сценарии

указано использование параметров

заданы параметры переадресации из настроек задания.

type

string

Да

Нет

hangup

Тип переадресации по умолчанию:

  • Hangup – завершить диалог
  • Dialplan – план набора
  • Transfer – направление перевода
  • Custom – произвольный перевод
  • Twin – другой сценарий

data

string

Да

Нет

null

Первичный параметр настройки для

типов 

типов:

  • Dialplan – план набора
  • Transfer – направление перевода
  • Custom – произвольный перевод
  • Twin – другой сценарий

Для Hangup - null.

additional

string

Да

Нет

null

Вторичный параметр настройки для

типов 

типов:

  • Dialplan – план набора
  • Custom – произвольный перевод

Для остальных - null.

scheduledAt

Date

Да

Нет

null

Режим запуска задания.

Если задание должно запуститься автоматически в

определенное

определенную дату и время, их необходимо указать в формате

дд.мм.гггг чч:мм

ГГГГ-ММ-ДДTчч:мм:сс+чч:мм

(год-месяц-деньTчасы:минуты:секунды+часовой пояс)

Например: 2022-10-13T09:00:00+00:00.

Если задание должно запуститься

Если задание будет запущено сразу

при загрузке реестра номеров, укажите null.


intensity

Int

Да

1

Интенсивность обзвона. Указывает

для системы обзвона, сколько нужно совершать одновременных наборов номеров

, какое количество вызовов система будет совершать в секунду.

При

Например, при значении 1

, например,

система будет набирать один номер

,

каждую секунду

.

, 60

вызовов за

номеров в минуту и

3 600

3 600 номеров за час работы задания.

Задается

целым числом

в виде целого числа в диапазоне от 1 до 5.

webhookUrl

string

Нет

 

URL webhook'а, на который присылать вебхук по результату диалога.

Пример вебхука

Протестировать работу вебхука можно через сервис https://webhook.site

allowedTimeRange

allowedTimeRangeInfo{
}

Да

Нет


Указание самого раннего и самого позднего времени, в которое можно позвонить клиенту

,

в рамках

данного

задания.
Время указывается без учета часового пояса клиента. Сам часовой пояс система

определит

определяет самостоятельно по номеру телефона.

from

Int

Нет
Да
0

Самое ранее время, в которое можно позвонить клиенту.

Указывается в секундах

,

с отсчетом от 00:00.

to

Int

Да

Нет

86399

Самое позднее время, в которое можно позвонить клиенту.

Указывается в секундах

,

с отсчетом от 00:00.

phoneNormalization

string

Нет


Модификатор

номеров телефона,

для приведения загруженных в задание

,

номеров телефонов к формату, который

нужен

требуется для системы обзвона

.

:

  • ru – номера
будут приводиться в формат номера для звона по России
  • приводятся к российскому формату
  • null –
переданные
  • номера
будут передаваться в работу в том виде, в котором их передали
  • передаются в неизменном виде

detectGenderByVoice

boolean

Нет

Да
false

Поле, отвечающее за включение/отключение работы модуля определения половой принадлежности клиента по его голосу

.

:

  • true – модуль определения гендера включен и работает
  • false – модуль определения гендера отключен и не работает

isTest

boolean

Нет
Да
false

Признак для отключения у задания механизмов ограничений ФЗ-230 и отключение любых сдерживающих механизмов платформы

.

:

  • true – задание считается тестовым, и для него отключаются механизмы соблюдения ФЗ и прочее.
  • false – для задания работают ограничения и механизмы безопасности

recallRules

recallRulesInfo {
}

Да
Нет


Перечень настроек стратегии перезвонов. Перезвон на каждый статус попытки дозвона настраивается отдельно.

BUSY

busyInfo {
}

Да

Нет


Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Занято».

enabled

boolean

Да

Нет

false

Поле,

отвечающие

отвечающее за необходимость перезвона на статус:

  • true – нужно перезванивать
  • false –
перезванивать
  • не нужно перезванивать

tries

Int

Нет

Да

null

Количество попыток дозвона на статус.

interval

Int

Нет

Да

null

Длительность паузы между попытками перезвона в секундах.

NO_ANSWER

no_answerInfo {
}

Да
Нет


Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Нет ответа».

enabled

boolean

Да

Нет

false

Поле,

отвечающие

отвечающее за необходимость перезвона на статус:

  • true – нужно перезванивать
  • false –
перезванивать
  • не нужно перезванивать

tries

Int

Да

Нет

null

Количество попыток дозвона на статус.

interval

Int

Нет

Да

null

Длительность паузы в секундах между попытками перезвона

в секундах

.

MACHINE

machineInfo {
}

Да

Нет


Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от модуля определения автоответчиков

,

(при условии его работы

,

) статус «Атоответчик».

enabled

boolean

Да

Нет

false

Поле,

отвечающие

отвечающее за необходимость перезвона на статус:

  • true – нужно перезванивать
  • false –
перезванивать
  • не нужно перезванивать

tries

Int

Да

Нет

null

Количество попыток дозвона на статус.

interval

Int

Да

Нет

null

Длительность паузы в секундах между попытками перезвона

в секундах

.

CONGESTION

congestionInfo {
}

Да

Нет

 

Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Ошибка дозвона».

enabled

boolean

Нет

Да
false

Поле,

отвечающие

отвечающее за необходимость перезвона на статус:

  • true – нужно перезванивать
  • false –
перезванивать
  • не нужно перезванивать

tries

Int

Да

Нет

null

Количество попыток дозвона на статус.

interval

Int

Да

Нет

null

Длительность паузы между попытками перезвона в секундах.

NOT_SUCCESSFUL

not_SuccessFulInfo {
}

Да

Нет


Настройки стратегии перезвонов на номера,

у

для которых время диалога бота было

ниже

меньше или

равным указанного

равно указанному в настройках

данной опции

этого параметра

enabled

boolean

Нет

Да

false

Поле,

отвечающие

отвечающее за необходимость перезвона на статус:

  • true – нужно перезванивать
  • false –
перезванивать
  • не нужно перезванивать

tries

Int

Нет
Да

null

Количество попыток дозвона на статус.

interval

Int

Да

Нет

null

Длительность паузы в секундах между попытками перезвона

в секундах

.

duration

Int

Да

Нет

null

Длительность звонка,

ниже или равной

при которой диалог считается

не результативным

нерезультативным и

потребует

требует перезвона на

данный

номер клиента.


Блок кода
languagepy
themeDJango
firstline1
titleОтвет в формате Json
linenumberstruecollapsetrue
{

    "id": "ce68bf14-2d76-4bf3-b718-3df2d36b7698"

}

 

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

Поле

Тип

Обязательно

Описание

id

string

Да

Уникальный идентификатор созданного задания на обзвон. По этому идентификатору задание можно наполнятьредактировать, управлять его параметрами , и получать по нему статистику с результатами обработки.