Play Announcement
Play Announcement
The PlayAnnouncement
requests the network infrastructure to play the indicated announcement.
The PlayAnnouncement
operation has only one exit. If the caller abandons (i.e. hangs up) during the announcement, no further processing is performed and no exit is followed.
Config Parameters
The PlayAnnouncement
operation config
attributes are as follows.
Parameter | Type | Description |
---|---|---|
announcement
|
Announcement Object |
[Required] The announcement parameter is an Object using the shared announcement configuration
structure as defined in the Flow Introduction documentation.
|
Example Operation
Here is an example PlayAnnouncement
operation in JSON representation.
{
"id": 5,
"type": "PlayAnnouncement",
"base_node": 1,
"config": {
"announcement": { "set": "General Purpose Anns",
"entry": "Welcome Announcement", "repetition": 1 }
},
"exits": [ 4 ]
}
If the caller is still on the line at the conclusion of the announcement, processing will continue down exit
index 0
to operation ID 4
.
Exits
The only exit is the “Caller On-Line” exit.
Exit Index | Name | Description |
---|---|---|
0
|
Caller On‑Line | [Required] This exit is followed if the caller is still connected at the end of the announcement. |