wxc_sdk.telephony.location.receptionist_contacts module

Location Receptionist Directories

class wxc_sdk.telephony.location.receptionist_contacts.ReceptionistContactsDirectoryApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Webex Calling Location Receptionist Contacts supports creation of directories and assigning custom groups of users to directories for a location within an organization.

Receptionist Contact Directories are named custom groups of users.

Viewing these read-only directories requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read, as the current set of APIs is designed to provide supplemental information for administrators utilizing People Webex Calling APIs.

Modifying these directories 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.

create(location_id: str, name: str, contacts: list[str], org_id: str | None = None) → str[source]

Creates a new Receptionist Contact Directory for a location.

Receptionist Contact Directories can be used to create named directories of users.

Adding a directory requires a full or write-only administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Add a Receptionist Contact Directory to this location.

  • name (str) – Receptionist Contact Directory name.

  • contacts (list[str]) – Array of user or workspace ids assigned to this Receptionist Contact Directory

  • org_id (str) – Add a Receptionist Contact Directory to this organization.

Returns:

Receptionist Contact Directory ID.

list(location_id: str, org_id: str | None = None) → Generator[IdAndName, None, None][source]

List all Receptionist Contact Directories for a location.

Receptionist Contact Directories can be used to create named directories of users.

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

Parameters:

  • location_id (str) – List Receptionist Contact Directories for this location.

  • org_id (str) – List Receptionist Contact Directories for this organization.

Returns:

Yields IdAndName instances

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

Delete a Receptionist Contact Directory from a location.

Receptionist Contact Directories can be used to create named directories of users.

Deleting a directory requires a full or write-only administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id – Delete a Receptionist Contact Directory from this location.

  • directory_id – ID of directory to delete.

  • org_id – Delete a Receptionist Contact Directory from this organization.

base = 'telephony/config/locations'