Features: Announcement Repository - Fetch details of a binary announcement greeting at the organization level

Fetch details of a binary announcement greeting at the organization level

Fetch details of a binary announcement greeting by its ID at an organization 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 auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/announcements/{announcementId}

URI Parameters

announcementId

stringrequired

Unique identifier of an announcement.

Query Parameters

orgId

string

Get an announcement in this organization.

Response Properties

string

Unique identifier of the announcement.

name

string

Name of the announcement.

fileName

string

File name of the uploaded binary announcement greeting.

fileSize

string

Size of the file in kilobytes.

mediaFileType

string

Media file type of the announcement file.

lastUpdated

string

Last updated timestamp (in UTC format) of the announcement.

featureReferenceCount

number

Reference count of the call features this announcement is assigned to.

featureReferences

array[FeatureReferenceObject]

Call features referenced by this announcement.

string

Unique identifier of the call feature referenced. The call Feature can be Auto Attendant, Call Queue or Music On hold.

name

string

Name of the call feature referenced.

type

string

Resource Type of the call feature.

locationId

string

Unique identifier of the location.

locationName

string

Location name of the announcement file.

playlists

array[PlaylistObject]

List of playlist available for selection.

string

A unique identifier for the playlist.

name

string

Unique name for the playlist.

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.

GET

/v1/telephony/config/announcements/{?orgId}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
Get an announcement in this organization.

https://webexapis.com/v1/telephony/config/announcements/Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
    "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
    "name": "Public_Announcement",
    "fileName": "Sample_Greetings_file.wav",
    "fileSize": "356",
    "mediaFileType": "WAV",
    "lastUpdated": "2022-02-22 22:27:54Z",
    "featureReferenceCount": 1,
    "featureReferences": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
            "name": "AUTO_ATTENDANT",
            "type": "WAV",
            "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
            "locationName": "RCDN"
        }
    ],
    "playlists": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9iYzZjOTYwYi01ZDJjLTRiM2QtYjRlZC0wNWY1ZmFhMTJjZjA",
            "name": "testingAnnouncementPlaylist"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC80MzA1ZTYyZS1hMmIxLTRlNzktODQxMy1lYWQwZDVlYjcwNjM",
            "name": "testingAnnouncementPlaylistDuplicateFiles"
        }
    ]
}