wxc_sdk.telephony.location.intercept module

location intercept

class wxc_sdk.telephony.location.intercept.LocationInterceptApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

API for location’s call intercept settings

read(location_id: str, org_id: str | None = None) → InterceptSetting

Get Location Intercept

Retrieve intercept location details for a customer location.

Intercept incoming or outgoing calls for persons in your organization. If this is enabled, calls are either routed to a designated number the person chooses, or to the person’s voicemail.

Retrieving intercept location details requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

• location_id (str) – Retrieve intercept details for this location.

• org_id (str) – Retrieve intercept location details for a customer location.

Returns:

user’s call intercept settings

Return type:

wxc_sdk.person_settings.call_intercept.InterceptSetting

configure(location_id: str, settings: InterceptSetting, org_id: str | None = None)

Put Location Intercept

Modifies the intercept location details for a customer location.

Intercept incoming or outgoing calls for users in your organization. If this is enabled, calls are either routed to a designated number the user chooses, or to the user’s voicemail.

Modifying the intercept location details requires a full, user administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• location_id (str) – Unique identifier for the person.

• settings (InterceptSetting) – new intercept settings

• org_id (str) – Person is in this 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 API.

base = 'telephony/config/locations'