wxc_sdk.telephony.voice_messaging.members_me package

class wxc_sdk.telephony.voice_messaging.members_me.UserVoiceMessagingMembersMeApi(*, session: RestSession, base: str = None)

Bases: ApiChild

User Call Settings Members Me

Voice Messages APIs for the authenticated user in support of Webex Calling. All commands require the spark:calls_read or spark:calls_write scope.

These APIs support the optional lineOwnerId parameter, which allows users to access voicemail for shared lines on their devices or for hunt groups, call queues, and auto attendants explicitly shared with them.

mark_as_read(message_id: str = None, line_owner_id: str = None) → None

Mark As Read

Update the voicemail message(s) as read for the user.

If the messageId is provided, then only mark that message as read. Otherwise, all messages for the user are marked as read.

Parameters:

• message_id (str) – The voicemail message identifier of the message to mark as read. If the messageId is not provided, then all voicemail messages for the user are marked as read.

• line_owner_id (str) – The ID of a user, workspace, virtual line, auto attendant, hunt group, or call queue for which there is a secondary line on a device owned by the authenticated user, or that was shared with the authenticated user.

Return type:

None

mark_as_unread(message_id: str = None, line_owner_id: str = None) → None

Mark As Unread

Update the voicemail message(s) as unread for the user.

If the messageId is provided, then only mark that message as unread. Otherwise, all messages for the user are marked as unread.

Parameters:

• message_id (str) – The voicemail message identifier of the message to mark as unread. If the messageId is not provided, then all voicemail messages for the user are marked as unread.

• line_owner_id (str) – The ID of a user, workspace, virtual line, auto attendant, hunt group, or call queue for which there is a secondary line on a device owned by the authenticated user, or that was shared with the authenticated user.

Return type:

None

list_voice_message_memberships() → list[VoiceMessageMembership]

List Voice Message Memberships

Retrieves the list of shared voicemail memberships for the authenticated user. Each membership represents a group calling feature (Call Queue, Hunt Group, or Auto Attendant) whose shared voicemail box the user has access to.

A service may have a phoneNumber, an extension, both, or neither, so any of these optional fields may be absent from a given entry. These can be used as values for the lineOwnerId parameter in other voicemail APIs.

This API requires the spark:calls_read or spark:calls_write scope.

Return type:

list[VoiceMessageMembership]

get_message_summary(line_owner_id: str = None) → MessageSummary

Get Message Summary

Get a summary of the voicemail messages for the user.

Parameters:

line_owner_id (str) – The ID of a user, workspace, virtual line, auto attendant, hunt group, or call queue for which there is a secondary line on a device owned by the authenticated user, or that was shared with the authenticated user.

Return type:

MessageSummary

list_messages(line_owner_id: str = None) → list[VoiceMessageDetails]

List Messages

Get the list of all voicemail messages for the user.

Parameters:

line_owner_id (str) – The ID of a user, workspace, virtual line, auto attendant, hunt group, or call queue for which there is a secondary line on a device owned by the authenticated user, or that was shared with the authenticated user.

Return type:

list[VoiceMessageDetails]

delete_message(message_id: str, line_owner_id: str = None) → None

Delete Message

Delete a specfic voicemail message for the user.

Parameters:

• message_id (str) – The message identifer of the voicemail message to delete

• line_owner_id (str) – The ID of a user, workspace, virtual line, auto attendant, hunt group, or call queue for which there is a secondary line on a device owned by the authenticated user, or that was shared with the authenticated user.

Return type:

None

base = 'telephony/voiceMessages/members/me'