Notification (alertcall)

Description

Delayed notification of a set of address book subscribers.
Initiates dialing and auto attendance in an IVR scenario. Within the scenario, the success of the notification is determined. The result of the scenario determines whether the subscriber needs to redial.

Limitations

  • The collection is not available in the master domain.

  • Can only be changed until the dialer starts dialing.

  • Contains the current aggregated statistics on the results of the alert in the data.

Fields

Entity structure
{
  "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
  }
}

Description of the specification’s characteristics

Table 1. Fields
Specification Description

Field: id
Mode: inout
Type: uuid
Default: generated

Identifier. Can be specified at creation, otherwise generated by the system.

Field: code
Mode: in
Type: str
Default: required

Code. Used to associate with other entities.

Field: name
Mode: in
Type: str
Default: required

Title

Field: dtstart
Mode: in
Type: date | str_empty
Default: str_empty

Automatic activation time in UTC.
Format RFC3339.
The time must be set to the past to activate the alert.

Field: dtstop
Mode: in
Type: date | str_empty
Default: str_empty

Automatic deactivation time in UTC.
Format RFC3339.
The set time must not be in the past to activate the alert.

Field: ivrscriptcode
Mode: in
Type: str
Default: required

Notification scenario code.
Actually implements the type of notification, e.g.
- "with confirmation" - the notification confirmation component of the scenario is set after the readout DTMF,- "call back if less than …​" - notification confirmation component in the script is set after timeout during background playback,- "do not call again if the script has started and has started playing" - notification confirmation component is set at the very beginning of the script.

Field: mediafile
Mode: in
Type: str
Default: empty

Sound file name to play to subscribers.
It is substituted by the alert provisioning script and is used to easily customize the alert without editing scripts.
The file must be previously placed in the alert file directory (either directly or via the API).

Field: groups
Mode: in
Type: array<str>
Default: empty

List of addressbook contact groups codes (code field) for notification. Mandatory field if not specified abonents.

Field: abonents
Mode: in
Type: array<int>
Default: empty

List of numeric identifiers addressbook contacts (autokey field) to notify. Mandatory field if not specified groups.

Field: opts
Mode: in
Type: object
Composite field

Field: opts.comment
Mode: in
Type: str
Default: empty

Arbitrary comment

Field: opts.site
Mode: in
Type: str
Default: empty

Service Site

Field: opts.trunkcount
Mode: in
Type: int
Default: 1

Maximum number of trunks to notify

Field: opts.attemptcount
Mode: in
Type: int
Default: 1

Maximum number of attempts per subscriber

Field: opts.attempttimeoutsec
Mode: in
Type: int
Default: 10

Pause after unsuccessful call to subscriber in seconds

Field: opts.callerid
Mode: in
Type: str
Default: "100"

Initiator number/username when calling subscribers (SIP)

Field: opts.callername
Mode: in
Type: str
Default: "AlertMachine"

Displayed initiator name when calling subscribers (SIP)

Field: opts.calltimeout
Mode: in
Type: int
Default: 30

Caller Call Timeout

Field: opts.status
Mode: out
Type: str
Default: "planned"

Alert status

Field: opts.statresults
Mode: out
Type: object
Default: — 

Alert Results.

Example:
{
  "answered":1,
  "approved":1,
  "finished":2,
  "incall":0,
  "indelay":1,
  "new":0,
  "prepared":0,
  "total":3
}

  • answered – the number of subscribers who responded.

  • approved – number of confirmed subscribers.

  • finished – number of completed subscribers.

  • incall – number of subscribers in service.

  • indelay – number of subscribers waiting for a second call.

  • new – number of subscribers waiting for the first call.

  • prepared – the number of subscribers ready to call.

  • total – number of total subscribers in the notification list.

Field: opts.dtstarted
Mode: out
Type: str
Default: — 

Report on the start time of notification

Field: opts.dtstopped
Mode: out
Type: str
Default: — 

Report on the time of notification completion

Field: ext
Mode: inout
Type: object
Compound field

Allows you to extend the compound with arbitrary keys and values

Field: ext.ct
Mode: out
Type: date
Default: generated

Object creation time

Field: ext.lwt
Mode: out
Type: date
Default: generated

Time of last modification of the object

See also

API

Logical roles

  • mware manages the alerts.

  • Personalization
  • Increase font size
  • Decrease font size