Оповещение (alertcall)

Описание

Отложенное оповещение совокупности абонентов адресной книги.
Инициирует набор номеров и автообслуживание в сценарии IVR. Внутри сценария определяется успешность оповещения. Результат сценария определяет необходимость повторного набора абоненту.

Ограничения

  • Коллекция недоступна в мастер-домене.

  • Может быть изменена только до момента старта дозвона.

  • Содержит в данных текущую агрегированную статистику по результатам оповещения.

Поля

Структура сущности
{
  "id": uuid,
  "code": str,
  "name": str,
  "dtstart": date,
  "dtstop": date,
  "ivrscriptcode": str,
  "mediafile": str,
  "groups": array<str>,
  "abonents": array<int>,
  "opts": {
    "comment": str,
    "site": str,
    "trunkcount": int,
    "attemptcount": int,
    "attempttimeoutsec": int,
    "callerid": str,
    "callername": str,
    "calltimeout": int,
    "status": str,
    "statresults": object,
    "dtstarted": str,
    "dtstopped": str
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}

Описание характеристик спецификации

Table 1. Поля
Спецификация Описание

Поле: id
Режим: inout
Тип: uuid
По умолчанию: generated

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

Поле: code
Режим: in
Тип: str
По умолчанию: required

Код. Используется для ассоциирования с другими сущностями.

Поле: name
Режим: in
Тип: str
По умолчанию: required

Название

Поле: dtstart
Режим: in
Тип: date | str_empty
По умолчанию: str_empty

Время автоматической активации в UTC.
Формат RFC3339.
Для активации оповещения следует установить время в прошлое.

Поле: dtstop
Режим: in
Тип: date | str_empty
По умолчанию: str_empty

Время автоматической деактивации в UTC.
Формат RFC3339.
Для активации оповещения установленное время не должно быть в прошлом.

Поле: ivrscriptcode
Режим: in
Тип: str
По умолчанию: required

Код сценария оповещения.
Фактически реализует тип оповещения, например
- "с подтверждением" – компонент подтверждения оповещения в сценарии установлен после считывания DTMF, - "перезвонить, если прослушано менее …​" – компонент подтверждения оповещения в сценарии установлен после таймаута во время фонового воспроизведения, - "не звонить повторно, если сценарий запустился и начал воспроизведение" – компонент подтверждения оповещения установлен в самом начале сценария.

Поле: mediafile
Режим: in
Тип: str
По умолчанию: empty

Имя звукового файла для воспроизведения абонентам.
Подставляется сценарием обеспечения оповещения, служит для простоты настройки оповещения без редактирования сценариев.
Файл должен быть предварительно размещен в каталог файлов оповещений (напрямую или через API).

Поле: groups
Режим: in
Тип: array<str>
По умолчанию: empty

Список кодов групп контактов адресной книги (поле code) для оповещения. Обязательное поле, если не указано abonents.

Поле: abonents
Режим: in
Тип: array<int>
По умолчанию: empty

Список числовых идентификаторов контактов адресной книги (поле autokey) для оповещения. Обязательное поле, если не указано groups.

Поле: opts
Режим: in
Тип: object
Составное поле

Поле: opts.comment
Режим: in
Тип: str
По умолчанию: empty

Произвольный комментарий

Поле: opts.site
Режим: in
Тип: str
По умолчанию: empty

Сайт обслуживания

Поле: opts.trunkcount
Режим: in
Тип: int
По умолчанию: 1

Максимальное количество транков для оповещения

Поле: opts.attemptcount
Режим: in
Тип: int
По умолчанию: 1

Максимальное количество попыток на одного абонента

Поле: opts.attempttimeoutsec
Режим: in
Тип: int
По умолчанию: 10

Пауза после неудачого вызова абонента в секундах

Поле: opts.callerid
Режим: in
Тип: str
По умолчанию: "100"

Номер/username инициатора при вызове абонентов (SIP)

Поле: opts.callername
Режим: in
Тип: str
По умолчанию: "AlertMachine"

Отображаемое имя инициатора при вызове абонентов (SIP)

Поле: opts.calltimeout
Режим: in
Тип: int
По умолчанию: 30

Таймаут вызова абонента

Поле: opts.status
Режим: out
Тип: str
По умолчанию: "planned"

Состояние оповещения

Поле: opts.statresults
Режим: out
Тип: object
По умолчанию: — 

Результаты оповещения.

Пример:
{
  "answered":1,
  "approved":1,
  "finished":2,
  "incall":0,
  "indelay":1,
  "new":0,
  "prepared":0,
  "total":3
}

  • answered – количество ответивших абонентов.

  • approved – количество подтвердивших абонентов.

  • finished – количество завершенных абонентов.

  • incall – количество абонентов в обслуживании.

  • indelay – количество абонентов в ожидании повторного вызова.

  • new – количество абонентов, ожидающих первого вызова.

  • prepared – количество абонентов, готовых к звонку.

  • total – количество абонентов всего в списке оповещения.

Поле: opts.dtstarted
Режим: out
Тип: str
По умолчанию: — 

Отчет о времени начала оповещения

Поле: opts.dtstopped
Режим: out
Тип: str
По умолчанию: — 

Отчет о времени завершения оповещения

Поле: ext
Режим: inout
Тип: object
Составное поле

Позволяет расширять состав произвольными ключами и значениями

Поле: ext.ct
Режим: out
Тип: date
По умолчанию: generated

Время создания объекта

Поле: ext.lwt
Режим: out
Тип: date
По умолчанию: generated

Время последней модификации объекта

См. также

API

Логические роли

  • mware производит управление оповещениями.

  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт