wxc_sdk.me.dnd package

class wxc_sdk.me.dnd.MeDNDApi(*, session: RestSession, base: str = None)

Bases: ApiChild

settings() → DND

Get Do Not Disturb Settings for User

Get Do Not Disturb settings for the authenticated user.

Do Not Disturb (DND) enables users to block or silence incoming calls on their phone. When activated, the phone either stops ringing or rejects calls depending on the configured option, but users can still see call information and answer calls if desired.

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

Return type:

DND

configure(dnd_settings: DND)

Update Do Not Disturb Settings for User

Update Do Not Disturb settings for the authenticated user.

Do Not Disturb (DND) enables users to block or silence incoming calls on their phone. When activated, the phone either stops ringing or rejects calls depending on the configured option, but users can still see call information and answer calls if desired.

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

Parameters:

dnd_settings (DND) – new setting to be applied

Return type:

None

base = 'telephony/config/people/me'