wxc_sdk.telephony.guest_calling package

class wxc_sdk.telephony.guest_calling.GuestCallingApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Guest Calling Settings with Click-to-call

Calling Service Settings supports reading and writing of Webex Calling service settings for a specific organization.

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.

read(org_id: str = None) → GuestCallingSettings[source]

Read the Click-to-call Settings

Retrieve the organization’s click-to-call calling settings.

Click-to-call settings determine whether click-to-call is enabled and whether privacy mode is enabled.

Retrieving click-to-call settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

org_id (str) – ID of the organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API.

Return type:

GuestCallingSettings

update(enabled: bool, privacy_enabled: bool, destination_members: list[str], org_id: str = None)[source]

Update the Click-to-call Settings

Update the organization’s click-to-call settings.

Click-to-call settings determine whether click-to-call is enabled and whether privacy mode is enabled.

Updating an organization’s click-to-call settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • enabled (bool) – Set to true to allow click-to-call calling.

  • privacy_enabled (bool) – Set to true to enable privacy mode.

  • destination_members (list[str]) – List of destination member IDs. Supported destination types are Auto Attendant, Call Queue, Hunt Group, and Virtual Line.

  • org_id (str) – ID of the organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API.

Return type:

None

members(member_name: str = None, phone_number: str = None, extension: str = None, org_id: str = None, **params) → Generator[DestinationMember, None, None][source]

Read the Click-to-call Members

Retrieve the organization’s click-to-call members.

Click-to-call members are the destination members that click-to-call callers can call.

Retrieving click-to-call members requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • member_name (str) – Search (Contains) numbers based on member name.

  • phone_number (str) – Search (Contains) based on number.

  • extension (str) – Search (Contains) based on extension.

  • org_id (str) – ID of the organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API.

Returns:

Generator yielding DestinationMember instances

available_members(member_name: str = None, phone_number: str = None, extension: str = None, org_id: str = None, **params) → Generator[DestinationMember, None, None][source]

Read the Click-to-call Available Members

Retrieve the organization’s click-to-call available members.

Click-to-call available members are the members that can be added as destination members for click-to-call callers.

Retrieving click-to-call available members requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • member_name (str) – Search (Contains) numbers based on member name.

  • phone_number (str) – Search (Contains) based on number.

  • extension (str) – Search (Contains) based on extension.

  • org_id (str) – ID of the organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API.

Returns:

Generator yielding DestinationMember instances

base = 'telephony/config/guestCalling'
class wxc_sdk.telephony.guest_calling.DestinationMember(*, id: str | None = None, firstName: str | None = None, lastName: str | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, type: OwnerType | None = None, location: IdAndName | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

ID of the destination member.

first_name: str | None

First name of the destination member.

last_name: str | None

Last name of the destination member.

phone_number: str | None

Phone number of the destination member.

extension: str | None

Extension of the destination member.

routing_prefix: str | None

Routing prefix of the destination member.

esn: str | None

ESN of the destination member.

type: OwnerType | None

Type of the destination member.

location: IdAndName | None

Location of the destination member.

class wxc_sdk.telephony.guest_calling.GuestCallingSettings(*, enabled: bool | None = None, privacyEnabled: bool | None = None, videoEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

When enabled, click-to-call calling is allowed.

privacy_enabled: bool | None

When enabled, privacy mode is enabled.

video_enabled: bool | None