Configure Music On Hold Settings for a Virtual Line
Configure a virtual line's music on hold settings.
Music on hold is played when a caller is put on hold, or the call is parked.
To configure music on hold settings for a virtual line, music on hold setting must be enabled for this location.
Updating the music on hold settings for a virtual line requires a full or user administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Retrieve settings for a virtual line with the matching ID.
Query Parameters
ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Body Parameters
Music on hold is enabled or disabled for the virtual line.
Greeting type for the virtual line.
Play music configured at the location level.
Play custom music when a call is placed on hold or parked. An audio file must already have been successfully uploaded to specify this option.
Announcement Audio File details when greeting is set to CUSTOM.
A unique identifier for the announcement. name, mediaFileType, and level are mandatory if id is not provided for uploading an announcement. If all four fields are provided, file with given id is used, and other fields are ignored.
Audio announcement file name.
Audio announcement file type.
WAV File Extension.
Audio announcement file type location.
Specifies that this audio file is configured across the organization.
Specifies that this audio file is configured across the location.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Body
- Music on hold is enabled or disabled for the virtual line.
- Greeting type for the virtual line.
- Announcement Audio File details when greeting is set to CUSTOM.
{
"mohEnabled": true,
"greeting": "CUSTOM",
"audioAnnouncementFile": {
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
"fileName": "AUDIO_FILE.wav",
"mediaFileType": "WAV",
"level": "ORGANIZATION"
}
}