wxc_sdk.meetings.chats package

class wxc_sdk.meetings.chats.Sender(*, email: str | None = None, displayName: str | None = None, personId: str | None = None, orgId: str | None = None)

Bases: ApiModel

email: str | None

Email address for sender. Possible values: john.andersen@example.com

display_name: str | None

Display name for sender. Possible values: John Andersen

person_id: str | None

A unique identifier for the sender.

org_id: str | None

The ID of the organization to which the sender belongs.

class wxc_sdk.meetings.chats.ChatObject(*, id: str | None = None, chatTime: str | None = None, text: str | None = None, meetingId: str | None = None, type: str | None = None, sender: Sender | None = None, receivers: list[Sender] | None = None)

Bases: ApiModel

id: str | None

A unique identifier for the chat snippet.

chat_time: str | None

Chat time for the chat snippet in ISO 8601 compliant format.

text: str | None

The text of the chat snippet.

meeting_id: str | None

A unique identifier for the meeting instance to which the chat belongs.

type: str | None

1 chat. Public chat is for the message which is sent to all the people in the meeting. Group chat is for the message which is sent to a small group of people, like a message to “host and presenter”.

Type:

Whether the type of the chat is private, public or group. Private chat is for the 1

sender: Sender | None

Information of the sender of the chat snippet.

receivers: list[Sender] | None

Information of the receivers of the chat snippet.

class wxc_sdk.meetings.chats.MeetingChatsApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

Chats are content captured in a meeting when chat messages are sent between the participants within a meeting. This feature allows a Compliance Officer to access the in-meeting chat content.

The Compliance Officer can use the Meeting Chats API to retrieve the chats of a meeting and to delete all chats associated with a meeting. private chats are text messages between two people. group chats are for larger breakout spaces. Meeting chats are different from room messages in that there is no catch-up propagation. For example, if a user joins a meeting late only, chat messages that are created from then on, will be propagated to this user. To understand which user saw which message if they joined late, you have to query the meetingParticipants REST resource for the joined/left times and compare to the meetingsChat chatTime field.

The Webex meetings chat functionality and API endpoint described here is “upon-request” and not enabled by default. If you need it enabled for your org, or if you need help, please contact the Webex Developer Support team at devsupport@webex.com.

list(meeting_id: str, offset: int | None = None, **params) → Generator[ChatObject, None, None]

Lists the meeting chats of a finished meeting instance specified by meetingId. You can set a maximum number of chats to return.

Use this operation to list the chats of a finished meeting instance when they are ready. Please note that only meeting instances in state ended are supported for meetingId. Meeting series, scheduled meetings and in-progress meeting instances are not supported.

Parameters:

• meeting_id (str) – A unique identifier for the meeting instance to which the chats belong. The meeting ID of a scheduled personal room meeting is not supported.

• offset (int) – Offset from the first result that you want to fetch.

delete(meeting_id: str)

Deletes the meeting chats of a finished meeting instance specified by meetingId.

Use this operation to delete the chats of a finished meeting instance when they are ready. Please note that only meeting instances in state ended are supported for meetingId. Meeting series, scheduled meetings and in-progress meeting instances are not supported.

Parameters:

meeting_id (str) – A unique identifier for the meeting instance to which the chats belong. Meeting IDs of a scheduled personal room meeting are not supported.

base = 'meetings/postMeetingChats'