wxc_sdk.telephony.voice_messaging.members package

class wxc_sdk.telephony.voice_messaging.members.MessageSummary(*, newMessages: int | None = None, oldMessages: int | None = None, newUrgentMessages: int | None = None, oldUrgentMessages: int | None = None, **extra_data: Any)[source]

Bases: ApiModel

new_messages: int | None: The number of new (unread) voicemail messages.

old_messages: int | None: The number of old (read) voicemail messages.

new_urgent_messages: int | None: The number of new (unread) urgent voicemail messages.

old_urgent_messages: int | None: The number of old (read) urgent voicemail messages.

Bases: ApiModel

id: str | None: Unique identifier for the membership.

type: str | None: Type of the membership. One of CALL_QUEUE, HUNT_GROUP, or AUTO_ATTENDANT.

name: str | None: Display name of the call queue, hunt group, or auto attendant.

phone_number: str | None: Phone number in E.164 format. Omitted when the service has no phone number.

extension: str | None: Extension number. Omitted when the service has no extension.

routing_prefix: str | None: Location dialing code (routing prefix). Omitted when not set.

esn: str | None: Enterprise Significant Number, the concatenation of routingPrefix and extension. Omitted when not set.

class wxc_sdk.telephony.voice_messaging.members.UserVoiceMessagingMembersApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

User Call Settings Members

Voice Messages APIs for members (person, workspace, virtual line, hunt group, call queue, or auto attendant) in support of Webex Calling. All GET commands require the spark-admin:calls_read scope while all other commands require the spark-admin:calls_write scope.

mark_as_read(member_id: str, message_id: str = None, org_id: str = None) → None[source]

Mark As Read by Member ID

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:

member_id (str) – Unique identifier for the member. Member ID can be one of the following: person, workspace, virtual line, hunt group, call queue, or auto attendant
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.
org_id (str) – Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App’s organization.

Return type:

None

mark_as_unread(member_id: str, message_id: str = None, org_id: str = None) → None[source]

Mark As Unread by Member ID

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:

member_id (str) – Unique identifier for the member. Member ID can be one of the following: person, workspace, virtual line, hunt group, call queue, or auto attendant
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.
org_id (str) – Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App’s organization.

Return type:

None

memberships(member_id: str, org_id: str = None) → list[VoiceMessageMembership][source]

List Voice Message Memberships

Retrieves the list of shared voicemail memberships for the specified member. Each membership represents a group calling feature (Call Queue, Hunt Group, or Auto Attendant) whose shared voicemail box the member 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.

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

Parameters:

member_id (str) – Unique identifier for the member. Member ID can be one of the following: person, workspace, virtual line, hunt group, call queue, or auto attendant
org_id (str) – Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App’s organization.

Return type:

list[VoiceMessageMembership]

summary(member_id: str, org_id: str = None) → MessageSummary[source]

Get Message Summary by Member ID

Get a summary of the voicemail messages for the user.

Parameters:

member_id (str) – Unique identifier for the member. Member ID can be one of the following: person, workspace, virtual line, hunt group, call queue, or auto attendant
org_id (str) – Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App’s organization.

Return type:

MessageSummary

list(member_id: str, org_id: str = None) → list[VoiceMessageDetails][source]

List Messages by Member ID

Get the list of all voicemail messages for the user.

Parameters:

member_id (str) – Unique identifier for the member. Member ID can be one of the following: person, workspace, virtual line, hunt group, call queue, or auto attendant
org_id (str) – Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App’s organization.

Return type:

list[VoiceMessageDetails]

delete(member_id: str, message_id: str, org_id: str = None) → None[source]

Delete Message by Member ID

Delete a specfic voicemail message for the user.

Parameters:

member_id (str) – Unique identifier for the member. Member ID can be one of the following: person, workspace, virtual line, hunt group, call queue, or auto attendant
message_id (str) – The message identifer of the voicemail message to delete
org_id (str) – Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App’s organization.

Return type:

None

base = 'telephony/voiceMessages/members'

Bases: ApiModel

name: str | None: The party’s name. Only present when the name is available and privacy is not enabled.

number: str | None: The party’s number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: 1234, 2223334444, +12223334444, *73, and user@company.domain.

person_id: str | None: The party’s person ID. Only present when the person ID is available and privacy is not enabled.

place_id: str | None: The party’s place ID. Only present when the place ID is available and privacy is not enabled.

privacy_enabled: bool | None: if true, denotes privacy is enabled for the name, number and personId/placeId.

Bases: ApiModel

id: str | None: The message identifier of the voicemail message.

duration: int | None: The duration (in seconds) of the voicemail message. Duration is not present for a FAX message.

calling_party: VoiceMailPartyInformation | None: The calling party’s details. For example, if user A calls user B and leaves a voicemail message, then A is the calling party.

urgent: bool | None: true if the voicemail message is urgent.

confidential: bool | None: true if the voicemail message is confidential.

read: bool | None: true if the voicemail message has been read.

fax_page_count: int | None: Number of pages for the FAX. Only set for a FAX.

created: datetime | None: The date and time the voicemail message was created.