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

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

changes.mady.by.user Svetlana Zinchenko

Сохранено

по сравнению с

Новая версия 40

changes.mady.by.user Владимир Диев

Сохранено

Ключ

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

...

Поле

Тип

Обязательно

Описание

eventstringда

Тип события. Возможные значения:

  • CALL_ENDED (Вызов завершен).
type

string

да

Тип звонка. Возможные значения:

  • INCOMING (Входящий);
  • OUTGOING (Исходящий).
companyId

int

да

Идентификатор компании.

botId

string

да

Идентификатор сценария.

id

string

да

Идентификатор вызова.

externalId

string

да

Переданный в запросе на инициализацию идентификатор (callId).

taskId

string

да

Идентификатор задания на обзвон.

candidateId

string

да

Идентификатор кандидата на обзвон

status

string

да

Статус вызова. Возможные значения:

  • CANCEL (Вызов отменен);
  • ANSWERED (Вызов отвечен);
  • NOANSWER (Нет ответа);
  • BUSY (Занято);
  • CONGESTION (Оператор отклонил вызов);
  • CHANUNAVAIL (Транк не доступен);
  • FAILED (Ошибка системы при обработке вызова);
  • SCHEDULED (Вызов запланирован);
  • BLACKLIST (Телефон в черном списке);
  • DIAL (Набор номера);
  • INPROGRESS (Идет диалог);
  • FZ230 (Запрет вызова по 230-ФЗ);
  • INVALID (Номер не корректный);
  • UNAVAILABLE (Удаленная АТС не доступна);
  • EXPIRED (Соединение не установлено за таймаут).
callFrom

string

да

Вызывающий номер.

callTo

string

да

Вызываемый номер.

startedAt

string

да

Дата начала вызова.

finishedAt

string

да

Дата окончания вызова.

billedAt

string

да

Дата билинга вызова.

variables

Object

да

Произвольный словарь типа ключ-значения, который был передан перед инициализацией вызова.

Содержит исходные переменные.

|    customVariable

string

нет

Пользовательские переменные, переданные при старте звонка

|    tryNumber

int

да

Количество попыток дозвона в рамках задания на обзвон.

|    recordPath 

string

да

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

|    humanNumber

int

да

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

|    resultNumber

int

да

Количество результативных дозвонов по номеру кандидата, считается с 0.

|    tryCandidate

int

да

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

|    answeredNumber

int

да

Количество дозвонов по номеру кандидата, считается с 0.

|    humanCandidate

int

да

Количество дозвонов до кандидата, где ответивший был НЕ автоответчик, считается с 0.

|    resultCandidate

int

да

Количество результативных дозвонов до кандидата, считается с 0.

|    answeredCandidate

int

да

Количество дозвонов до кандидата, считается с 0.

result

Object

да  (может быть пустым массивом []))

Произвольный словарь типа ключ-значения.

Результаты разговора робота.

|    nps

string

нет

Информация из поля NPS в блоке Результат.
|    date

string

нет

Информация из поля Дата в блоке Результат.
|    evaluation 

string

нет

Информация из поля Оценка в блоке Результат.

|    confirmation 

string

нет

Информация из поля Подтверждение в блоке Результат.

|    markers

Array[string]

нет

Маркеры.

|    initialVariables

Object

нет

Исходные переменные.

|    |    customVariable

string

нет

Пользовательские переменные, переданные при старте звонка

|    |    phone

string

нет

Вызываемый номер.

|    |    tryNumber

int

нет

Количество попыток дозвона в рамках задания на обзвон.

|    |    recordPath 

string

нет

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

|    |    humanNumber

int

нет

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

|    |    resultNumber

int

нет

Количество результативных дозвонов по номеру кандидата, считается с 0.

|    |    tryCandidate

int

нет

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

|    |    answeredNumber

int

нет

Количество дозвонов по номеру кандидата, считается с 0.

|    |    humanCandidate

int

нет

Количество дозвонов до кандидата, где ответивший был НЕ автоответчик, считается с 0.

|    |    resultCandidate

int

нет

Количество результативных дозвонов до кандидата, считается с 0.

|    |    answeredCandidate

int

нет

Количество дозвонов до кандидата, считается с 0.

|    ключ_1

string

нет

Произвольный результат. 

Задается в блоке Результат с типом Произвольный результат.

amdstring

да

Результат работы определителя автоответчика. Возможные значения:

  • HUMN (человек);
  • MACH (автоответчик);
  • NOT_DEF (не определялось).
recordPath

string

да (может быть пустой строкой)

Путь к аудиофайлу.

Для получения ссылки нужно добавить в начале пути 

https://minio.twin24.ai/twin-cis-production/records.Ссылка на аудиофайл

flow

Array[Object]

да (может быть пустым массивом []))

Массив фрагментов разговора.

|    botId

string

да

Идентификатор сценария.

|    start

string

да

Время начала части диалога.

|    end

string

да

Время окончания части диалога.

|    messages

Array[Object]

да

Массив сообщений по диалогу.

|    |    text

string

да

Текст сообщений.

|    |    author

string

да

Кто произнес сообщение (BOT, CLIENT).

|    |    time

string

да

Время отправки сообщения.

gmtOffset

int

да

смещение в минутах от UTC часового пояса клиента.

hungUpBy

string

да (может быть null)

Кто положил трубку (BOT, HUMAN).

duration

int

да

Общая длительность разговора.

totalCost

float

да

Общая стоимость разговора.

robotCallDuration

int

да

Длительность разговора робота.

robotCallTotalCost

float

да

Стоимость разговора робота со скидкой.

mainCallCost

float

да

Стоимость разговора (транк клиента).

mainCallDiscount

float

да

Скидка за разговор (транк клиента).

mainCallDuration

int

да

Длительность разговора (транк клиента).

mainCallTotalCost

float

да

Стоимость разговора со скидкой (транк клиента).
autoCallCost

float

да

Всегда равен 0.
autoCallDiscount

float

да

Всегда равен 0.
autoCallDuration

int

да

Всегда равен 0.
autoCallTotalCost

float

да

Всегда равен 0.
robotCallCost

float

да

Стоимость разговора робота.
robotCallDiscount

float

да

Скидка за разговор робота.
transferCallCost

float

да

Стоимость перевода звонка.
transferCallDiscount

float

да

Скидка за перевод звонка.

transferCallDuration

int

да

Длительность звонка после перевода.

transferCallTotalCost

float

да

Стоимость звонка после перевода со скидкой.

clientExternalId

string

да (может быть null)

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

callbackData

Object

да (может быть пустым массивом [])

Информация о кандидате, переданная в момент добавления кандидата (см. метод добавления кандидата).

...

Блок кода
{
  "event": "EFFICIENCY_REACHED",
  "id": "4f29df1c-1026-43b7-a60f-15b6b0d441b2",
  "state": true,
  "callbackData": []
}

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

Поле

Тип

Обязательно

Описание

event
stringда

Тип события EFFICIENCY_REACHED — указывает на изменение результативности.

id

stringдаID звонка.
state
booleanдаСостояние результативности. Если true — результативный, если false — не результативный.
callbackDataArrayнет

Дополнительные данные, связанные с событием.