Music On Hold¶
Retrieve configuration¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/services/music_on_hold/
¶ Get the details about the Music On Hold of the group.
Additional information:
- Response JSON Object:
source (object) – a source object as defined as Music On Hold Source Attributes
internalSource (object) – a source object as defined as Music On Hold Source Attributes
Update configuration¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/services/music_on_hold/
¶ Update the details about the Music On Hold of the group.
Additional requierements:
- Request JSON Object:
source (object) – a source object as defined as Music On Hold Source Attributes
internalSource (object) – a source object as defined as Music On Hold Source Attributes
Music On Hold Source Attributes¶
Name |
Type |
Methods |
Description |
|
---|---|---|---|---|
GET |
PUT |
|||
audioFilePreferredCodec |
string |
A |
O |
The codec of the audio file to use. One of “None”, “G711”, “G722”, “G729”, “G726”, “AMR”, “AMR-WB” |
messageSourceSelection |
string |
A |
O |
The source to select. One of “System”, “External”, “Custom” |
audioFile |
object |
O |
O |
An audio file object as defined as Announcement File Name |