Fetch list of announcement greetings on location and organization level
Fetch a list of binary announcement greetings at an organization as well as location level.
An admin can upload a file at an organization level. This file will be uploaded to the announcement repository.
This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
Get announcements in this organization.
Return the list of enterprise or Location announcement files. Without this parameter, the Enterprise level announcements are returned.
Limit the number of objects returned to this maximum count.
Start at the zero-based offset in the list of matching objects.
Sort the list according to fileName or fileSize. The default sort will be in Ascending order.
Return the list of announcements with the given fileName.
Return the list of announcement files for this fileType.
Return the list of announcement files for this mediaFileType.
Return the list of announcement files for this announcement label.
Response Properties
Array of announcements.
Unique identifier of the announcement.
Name of the announcement.
File name of the uploaded binary announcement greeting.
Size of the file in kilobytes.
Media file type of the announcement file.
LastUpdated timestamp (in UTC format) of the announcement.
The level at which this announcement exists.
The details of location at which this announcement exists.
Unique identifier of the location.
Name of 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
- Get announcements in this organization.
- Return the list of enterprise or Location announcement files. Without this parameter, the Enterprise level announcements are returned.
- Limit the number of objects returned to this maximum count.
- Start at the zero-based offset in the list of matching objects.
- Sort the list according to fileName or fileSize. The default sort will be in Ascending order.
- Return the list of announcements with the given fileName.
- Return the list of announcement files for this fileType.
- Return the list of announcement files for this mediaFileType.
- Return the list of announcement files for this announcement label.
{
"announcements": [
{
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"name": "Public_Announcement",
"fileName": "Sample_Greetings_file.wav",
"fileSize": "356",
"mediaFileType": "WAV",
"lastUpdated": "2022-02-22 22:27:54",
"level": "LOCATION",
"location": {
"id": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81ZTk3MzFlNy1iOWQ0LTRmMWQtYjYyMi05NDgwMDhhMjkzMzM",
"name": "RCDN"
}
},
{
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY",
"name": "General Announcement",
"fileName": "General_Greetings_file.wav",
"fileSize": "356",
"mediaFileType": "WAV",
"lastUpdated": "2022-02-22 22:27:54",
"level": "ORGANIZATION"
}
]
}