wxc_sdk.me.callerid package
- class wxc_sdk.me.callerid.MeCallerIdApi(*, session: RestSession, base: str | None = None)[source]
Bases:
ApiChild- settings() MeCallerIdSettings[source]
Get My Caller ID Settings
Get Caller ID Settings for the authenticated user.
Calling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call. Connected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.
This API requires a user auth token with a scope of spark:telephony_config_read.
- Return type:
- update(settings: MeCallerIdSettings)[source]
Modify My Caller ID Settings
Update Caller ID Settings for the authenticated user.
Calling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call. Connected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.
This API requires a user auth token with a scope of spark:telephony_config_write.
- Parameters:
settings (
MeCallerIdSettings) – new settings
- available_caller_id_list() list[MeSelectedCallerId][source]
Get My Available Caller ID List
Get details of available caller IDs of the authenticated user.
Caller ID settings control how a person’s information is displayed when making outgoing calls. The available caller ID list shows the caller IDs that the user can choose from.
This API requires a user auth token with a scope of spark:telephony_config_read.
- Return type:
list[MeSelectedCallerId]
- get_selected_caller_id_settings() MeSelectedCallerId[source]
Read My Selected Caller ID Settings
Read selected caller ID settings associated with the authenticated user.
Caller ID settings control how a person’s information is displayed when making outgoing calls. Selected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.
This API requires a user auth token with a scope of spark:telephony_config_read.
- Return type:
- modify_selected_caller_id_settings(settings: MeSelectedCallerId)[source]
Configure My Selected Caller ID Settings
Update selected caller ID settings associated with the authenticated user.
Caller ID settings control how a person’s information is displayed when making outgoing calls. Selected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.
This API requires a user auth token with a scope of spark:telephony_config_write.
- Parameters:
settings (
MeSelectedCallerId) – new settings
- base = 'telephony/config/people/me'
- class wxc_sdk.me.callerid.MeCallerIdSettings(*, callingLineIdDeliveryBlockingEnabled: bool | None = None, connectedLineIdentificationRestrictionEnabled: bool | None = None, **extra_data: Any)[source]
Bases:
ApiModel- calling_line_id_delivery_blocking_enabled: bool | None
If true, the user’s name and phone number are not shown to people they call.
- connected_line_identification_restriction_enabled: bool | None
If true, the user’s name and phone number are not shown when receiving a call.
- class wxc_sdk.me.callerid.MeSelectedCallerId(*, type: CallerIdType | None = None, id: str | None = None, name: str | None = None, directNumber: str | None = None, extension: str | None = None, **extra_data: Any)[source]
Bases:
ApiModel- type: CallerIdType | None
- id: str | None
Unique identifier of the selected caller ID config. Set for CALL_QUEUE & HUNT_GROUP caller IDs.
- name: str | None
Name of the selected caller ID.
- direct_number: str | None
Direct number of the selected caller ID.
- extension: str | None
Extension of the selected caller ID.