wxc_sdk.me.secondary_line.callerid package
- class wxc_sdk.me.secondary_line.callerid.MeSecondaryLineCallerIdApi(*, session: RestSession, base: str = None)[source]
Bases:
ApiChild- available_caller_id_list(lineowner_id: str) list[MeSelectedCallerId][source]
Get My Secondary Line Owner’s Available Caller ID List
Get details of available caller IDs for a secondary line of the authenticated user.
Note that an authenticated user can only retrieve information for their configured secondary lines.
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.
- Parameters:
lineowner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).
- Return type:
- settings(lineowner_id: str) MeCallerIdSettings[source]
Get My Secondary Line Owner Caller ID Settings
Get Caller ID Settings for the secondary line owner of the authenticated user.
Note that the secondary line information is only available 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.
- Parameters:
lineowner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).
- Return type:
CallerIdSettingsGet
- update(lineowner_id: str, settings: MeCallerIdSettings)[source]
Modify My Secondary Line Owner Caller ID Settings
Update Caller ID Settings for the secondary line owner of the authenticated user.
Note that the secondary line information is only available 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:
lineowner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).
settings (
MeCallerIdSettings) – new settings
- get_selected_caller_id_settings(lineowner_id: str) MeSelectedCallerId[source]
Get My Secondary Line Owner’s Selected Caller ID Settings
Get details of selected caller ID settings associated with a secondary line of the authenticated user.
Note that an authenticated user can only retrieve information for their configured secondary lines.
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.
- Parameters:
lineowner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).
- Return type:
- modify_selected_caller_id_settings(lineowner_id: str, settings: MeSelectedCallerId)[source]
Modify My Secondary Line Owner’s Selected Caller ID Settings
Update selected caller ID settings associated with a secondary line owner of the authenticated user.
Note that an authenticated user can only modify information for their configured secondary lines.
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:
lineowner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).
settings (
MeSelectedCallerId) – new settings
- base = 'telephony/config/people/me'