wxc_sdk.me.callblock package

class wxc_sdk.me.callblock.MeCallBlockApi(*, session: RestSession, base: str | None = None)[source]

Get My Call Block Settings

Get details of call block settings associated with the authenticated user.

Call block settings allow you to get the User Call Block Number List.

This API requires a user auth token with a scope of spark:telephony_config_read.

add_number(phone_number: str) → str[source]

Add a phone number to user’s Call Block List

Add a phone number to the call block list for the authenticated user.

Call block settings allow you to get the User Call Block Number List.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:: phone_number (str) – Phone number which is blocked by user.
Return type:: str

delete_number(phone_number_id: str)[source]

Delete User Call Block Number

Delete call block number settings associated with the authenticated user.

Call block settings allow you to delete a number from the User Call Block Number List.

This API requires a user auth token with a scope of spark-admin:people_write.

Parameters:: phone_number_id (str) – Unique identifier of the phone number.
Return type:: None

state_for_number(phone_number_id: str) → bool[source]

Get My Call Block State For Specific Number

Get call block state details for a specific number associated with the authenticated user.

Call block settings allow you to get the User Call Block Number List.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:: phone_number_id (str) – Unique identifier of the phone number.
Return type:: bool

class wxc_sdk.me.callblock.CallBlockNumber(*, id: str | None = None, phoneNumber: str | None = None, **extra_data: Any)[source]