Alert (alertcall)
Description
Deferred alert to a set of address book subscribers.
Initiates dialing numbers and auto-servicing in an IVR script. The script determines whether the alert succeeded. The script result determines whether the subscriber needs to be called again.
Limitations
-
The collection is unavailable in the master domain.
-
Can be changed only before dialing starts.
-
Contains current aggregated statistics on alert results in its data.
Fields
{
"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
}
}
| Specification | Description |
|---|---|
Field: |
Identifier. Can be specified at creation, otherwise generated by the system. |
Field: |
Code. Used to associate with other entities. |
Field: |
Name |
Field: |
Automatic activation time in UTC. |
Field: |
Automatic deactivation time in UTC. |
Field: |
Alert script code. |
Field: |
Name of the audio file to play to subscribers. |
Field: |
List of codes of address book contact groups (the code field) to alert. Required if abonents is not specified. |
Field: |
List of numeric identifiers of address book contacts (the autokey field) to alert. Required if groups is not specified. |
Field: |
|
Field: |
Arbitrary comment |
Field: |
Service site |
Field: |
Maximum number of trunks for the alert |
Field: |
Maximum number of attempts per subscriber |
Field: |
Pause after a failed subscriber call, in seconds |
Field: |
Number/username of the initiator when calling subscribers (SIP) |
Field: |
Display name of the initiator when calling subscribers (SIP) |
Field: |
Subscriber call timeout |
Field: |
Alert state |
Field: |
Alert results. Example:
{
"answered":1,
"approved":1,
"finished":2,
"incall":0,
"indelay":1,
"new":0,
"prepared":0,
"total":3
}
|
Field: |
Report on the alert start time |
Field: |
Report on the alert completion time |
Field: |
Allows extending the compound with arbitrary keys and values |
Field: |
Object creation time |
Field: |
Time of last modification of the object |
See also
Logical roles
-
mware manages alerts.