wxc_sdk.telephony.callqueue.announcement module

Call queue announcement files API

class wxc_sdk.telephony.callqueue.announcement.AnnouncementApi(*, session: RestSession)[source]

Bases: object

API for call queue Announcements

__init__(*, session: RestSession)[source]
list(location_id: str, queue_id: str, org_id: str | None = None) → Generator[Announcement][source]

Read the List of Call Queue Announcement Files

List file info for all Call Queue announcement files associated with this Call Queue.

Call Queue announcement files contain messages and music that callers hear while waiting in the queue. A call queue can be configured to play whatever subset of these announcement files is desired.

Retrieving this list of files requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Note that uploading of announcement files via API is not currently supported, but is available via Webex Control Hub.

Parameters:

  • location_id (str) – Location in which this call queue exists.

  • queue_id (str) – Retrieve announcement files for the call queue with this identifier.

  • org_id (str) – Retrieve announcement files for a call queue from this organization.

delete_announcement(location_id: str, queue_id: str, file_name: str, org_id: str | None = None)[source]

Delete a Call Queue Announcement File

Delete an announcement file for the designated Call Queue.

Call Queue announcement files contain messages and music that callers hear while waiting in the queue. A call queue can be configured to play whatever subset of these announcement files is desired.

Deleting an announcement file for a call queue requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Delete an announcement for a call queue in this location.

  • queue_id (str) – Delete an announcement for the call queue with this identifier.

  • org_id (str) – Delete call queue announcement from this organization.

Return type:

None

class wxc_sdk.telephony.callqueue.announcement.Announcement(*, fileName: str, fileSize: int, **extra_data: Any)[source]

Bases: ApiModel

Announcement file information

name: str
size: int