wxc_sdk.telephony.playlists package

class wxc_sdk.telephony.playlists.PlaylistAnnouncement(*, id: str | None = None, name: str | None = None, fileName: str | None = None, fileSize: int | None = None, mediaFileType: str | None = None, lastUpdated: datetime | None = None, level: str | None = None)[source]

Bases: ApiModel

id: str | None

Unique identifier of the announcement.

name: str | None

Name of the announcement.

file_name: str | None

File name of the uploaded binary announcement greeting.

file_size: int | None

Size of the file in kilobytes.

media_file_type: str | None

Media file type of the announcement file.

last_updated: datetime | None

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

level: str | None

The level at which this playlist exists.

class wxc_sdk.telephony.playlists.PlayListApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Features: Announcement PlayList

Features: Announcement PlayList support reading and writing of Webex Calling Announcement PlayList settings for a specific organization. The playlist has multiple announcement files which will be played where the announcement playlist is selected.

Viewing these read-only organization settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Modifying these organization settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

A partner administrator can retrieve or change settings in a customer’s organization using the optional orgId query parameter.

list(org_id: str | None = None) → list[PlayList][source]

Fetch list of announcement playlist on organization level

Fetch a list of announcement playlist at an organization.

This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

org_id (str) – Get announcements playlist in this organization.

Return type:

list[PlayList]

create(name: str, announcement_ids: List[str], org_id: str | None = None) → str[source]

Create announcement Playlist at organization level

Create announcement Playlist at an organization level. A maximum of 25 announcement files can be included in a single playlist.

This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • name (str) – Unique name for the announcement playlist.

  • announcement_ids (list[str]) – Array of announcementIds associated with the playlist.

  • org_id (str) – Create an announcement playlist in this organization.

Return type:

str

details(play_list_id: str, org_id: str | None = None) → PlayList[source]

Fetch details of announcement playlist at the organization level

Fetch details of announcement playlist by its ID at an organization level.

This API requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • play_list_id (str) – Unique identifier of an announcement playlist.

  • org_id (str) – Get an announcement playlist in this organization.

Return type:

PlayList

modify(play_list_id: str, name: str | None = None, announcement_ids: List[str] | None = None, org_id: str | None = None)[source]

Modify announcement playlist at organization level

Modify an existing announcement playlist at an organization level.

This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • play_list_id (str) – Unique identifier of an announcement playlist.

  • name (str) – Unique name for the announcement playlist.

  • announcement_ids (list[str]) – Array of announcementIds associated with the playlist.

  • org_id (str) – Modify an announcement playlist in this organization.

Return type:

None

delete(play_list_id: str, org_id: str | None = None)[source]

Delete an announcement playlist for an organization.

This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • play_list_id (str) – Unique identifier of an announcement playlist.

  • org_id (str) – Delete an announcement playlist in this organization.

Return type:

None

assigned_locations(play_list_id: str, org_id: str | None = None) → List[IdAndName][source]

Fetch list of locations which are assigned to the announcement playlist

Fetch list of locations which are assigned to the given announcement playlist

This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • play_list_id (str) – Unique identifier of playlist.

  • org_id (str) – Get location associated to a playlist in this organization.

Return type:

PlayListAssignedLocations

modify_assigned_locations(play_list_id: str, location_ids: List[str], org_id: str | None = None)[source]

Modify list of assigned locations to the announcement playlist

Modify list of assigned locations or add new locations to the announcement playlist. This will assing the playlist to the location’s music on hold.

This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • play_list_id (str) – Unique identifier of an announcement playlist.

  • location_ids (list[str]) – Array of location IDs with which the playlist is associated.

  • org_id (str) – Modify an assign location for announcement playlist for organization.

Return type:

None

base = 'telephony/config/announcements/playlists'
class wxc_sdk.telephony.playlists.PlayList(*, id: str | None = None, name: str | None = None, fileSize: int | None = None, fileCount: int | None = None, isInUse: bool | None = None, lastUpdated: datetime | None = None, level: str | None = None, locationCount: int | None = None, announcements: list[PlaylistAnnouncement] | None = None)[source]

Bases: ApiModel

id: str | None

Unique identifier of the playlist.

name: str | None

Unique name for the announcement playlist.

file_size: int | None

Size of the files in kilobytes.

file_count: int | None

Count of the announcements associated with playlist.

is_in_use: bool | None

Indicates if the playlist has been used or not.

last_updated: datetime | None

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

level: str | None

The level at which this playlist exists.

location_count: int | None

Count of the location this playlist is assigned to.

announcements: list[PlaylistAnnouncement] | None

List of announcement details associated with playlist.