wxc_sdk.events package

class wxc_sdk.events.EventData(*, title: str | None = None, type: str | None = None, isRoomHidden: bool | None = None, files: list[str] | None = None, personOrgId: str | None = None, personDisplayName: str | None = None, isModerator: bool | None = None, isMonitor: bool | None = None, updated: datetime | None = None, markdown: str | None = None, html: str | None = None, mentionedPeople: list[str] | None = None, fileContentUrl: str | None = None, fileId: str | None = None, pageNumber: int | None = None, titleEncryptionKeyUrl: str | None = None, isLocked: bool | None = None, isPublic: bool | None = None, madePublic: datetime | None = None, isAnnouncementOnly: bool | None = None, id: str | None = None, roomId: str | None = None, roomType: str | None = None, orgId: str | None = None, text: str | None = None, attachments: list[Any] | None = None, personId: str | None = None, personEmail: str | None = None, meetingId: str | None = None, creatorId: str | None = None, host: Any | None = None, attendees: list[str] | None = None, transcriptionEnabled: str | None = None, recordingEnabled: str | None = None, hasPostMeetingsChat: str | None = None, correlationId: str | None = None, callType: str | None = None, userId: str | None = None, userType: str | None = None, callDirection: str | None = None, isCallAnswered: bool | None = None, callDurationSeconds: datetime | None = None, callStartTime: datetime | None = None, callAnswerTime: datetime | None = None, callTransferTime: datetime | None = None, callingNumber: str | None = None, callingLineId: str | None = None, calledNumber: str | None = None, calledLineId: str | None = None, dialedDigits: str | None = None, callRedirectingNumber: str | None = None, callRedirectedReason: str | None = None, created: datetime | None = None, breakoutSessionId: str | None = None, recipients: list[Recipient] | None = None, contentUrl: str | None = None, **extra_data: Any)

Bases: ApiModel

title: str | None

is_room_hidden: bool | None

files: list[str] | None

person_org_id: str | None

person_display_name: str | None

is_moderator: bool | None

is_monitor: bool | None

updated: datetime | None

markdown: str | None

html: str | None

mentioned_people: list[str] | None

file_content_url: str | None

file_id: str | None

page_number: int | None

title_encryption_key_url: str | None

is_locked: bool | None

is_public: bool | None

made_public: datetime | None

is_announcement_only: bool | None

id: str | None

room_id: str | None

room_type: str | None

org_id: str | None

text: str | None

this project is Mike C. and the Engineering Manager is Jane W.

attachments: list[Any] | None

person_id: str | None

person_email: str | None

meeting_id: str | None

creator_id: str | None

host: Any | None

The meeting’s host data

attendees: list[str] | None

Common Identity (CI) authenticated meeting attendees

transcription_enabled: str | None

indicates whether or not the Voice Assistant was enabled during the meeting. If true a transcript should be available a couple minutes after the meeting ended at the meetingTranscripts resource

recording_enabled: str | None

indicates if recording was enabled for all or parts of the meeting. If true a recording should be available shortly after the meeting ended at the recordings resource

has_post_meetings_chat: str | None

indicates if chat messages were exchanged during the meeting in the meetings client (not the unified client). If true these messages can be accessed by a compliance officer at the postMeetingsChat resource. Meetings chat collection must be custom enabled.

correlation_id: str | None

Telephony; corelation id

call_type: str | None

Telephony; call types (examples VIDEO_DIALIN,`VIDEO_DIALOUT`,`CASCADE`,`HYBRID_CASCADE`,`PSTN_SIP`,`PSTN_DIALIN`,`PSTN_DIALOUT`, PSTN_ONLY_DIALIN,`PSTN_ONLY_DIALOUT`,`H323`,`H323_IP`,`SIP_ENTERPRISE`,`SIP_MOBILE`,`SIP_NATIONAL`, SIP_INTERNATIONAL,`SIP_EMERGENCY`,`SIP_OPERATOR`,`SIP_SHORTCODE`,`SIP_TOLLFREE`,`SIP_PREMIUM`,`SIP_URI`, SIP_INBOUND,`UNKNOWN`,`ZTM`,`SIP_MEETING`)

user_id: str | None

Telephony; user id of the CDR owner

user_type: str | None

Telephony; type of user (User,`Anchor`,`AutomatedAttendantBasic`,`AutomatedAttendantStandard`,`AutomatedAttendantVideo`, BroadworksAnywhere,`CallCenterBasic`,`CallCenterPremium`,`CallCenterStandard`,`CollaborateBridge`, ContactCenterAdaptor,`FindMeFollowMe`,`FlexibleSeatingHost`,`GroupCall`,`GroupPaging`,`HuntGroup`, LocalGateway,`MeetMeConference`,`Place`,`RoutePoint`,`SystemVoicePortal`,`VoiceMailGroup`, VoiceMailRetrieval,`VoiceXML`,`VirtualLine`,`Unknown`)

call_direction: str | None

Telephony; ORIGINATING or TERMINATING

is_call_answered: bool | None

Telephony; indicates if the call was answered

call_duration_seconds: datetime | None

Telephony; duration of call in seconds

call_start_time: datetime | None

Telephony; ISO 8601

call_answer_time: datetime | None

Telephony; ISO 8601

call_transfer_time: datetime | None

Telephony; ISO 8601

calling_number: str | None

Telephony; originating number

calling_line_id: str | None

Telephony

called_number: str | None

Telephony; destination number

called_line_id: str | None

Telephony

dialed_digits: str | None

Telephony

call_redirecting_number: str | None

Telephony

call_redirected_reason: str | None

Telephony

created: datetime | None

type: str | None

Message type direct or group message.

breakout_session_id: str | None

The breakout session Id in cases where the action happened in a meeting’s brakout session, for example a meetingMessage.

recipients: list[Recipient] | None

the recipients list for directed meetingMessages.

content_url: str | None

class wxc_sdk.events.ComplianceEvent(*, id: str | None = None, resource: EventResource | None = None, type: EventType | None = None, appId: str | None = None, actorId: str | None = None, orgId: str | None = None, created: datetime | None = None, data: EventData | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

The unique identifier for the event.

resource: EventResource | None

The type of resource in the event.

type: EventType | None

The action which took place in the event.

app_id: str | None

The ID of the application for the event.

actor_id: str | None

The ID of the person who performed the action.

org_id: str | None

The ID of the organization for the event.

created: datetime | None

The date and time of the event.

data: EventData | None

The event’s data representation. This object will contain the event’s resource, such as memberships, messages, meetings, tabs, rooms or attachmentActions at the time the event took place.

class wxc_sdk.events.EventResource(*values)

Bases: str, SafeEnum

An enumeration.

messages = 'messages'

State changed on a messages resource

memberships = 'memberships'

State changed on a memberships resource

meetings = 'meetings'

State change on a meeting ( here combined with type = ‘ended’ )

meeting_transcripts = 'meetingTranscripts'

State change on a automatic transcript resource for Webex Assistant

meeting_messages = 'meetingMessages'

State changed on a meeting message, i.e. message exchanged as part of a meeting

tabs = 'tabs'

State changed on a room tabs in a space

rooms = 'rooms'

State changed on a space classification

attachment_actions = 'attachmentActions'

State changed on a card attachment

files = 'files'

State changed on a file download

file_transcodings = 'file_transcodings'

State change on a file preview

business_texts = 'businessTexts'

A user sent or received a SMS message

call_records = 'call_records'

A Webex call was made to/from a user

class wxc_sdk.events.EventType(*values)

Bases: str, SafeEnum

An enumeration.

created = 'created'

The resource has been created

updated = 'updated'

A property on the resource has been updated

deleted = 'deleted'

The resource has been deleted

ended = 'ended'

The meeting has ended

read = 'read'

all = 'all'

class wxc_sdk.events.Recipient(*, personId: str | None = None, personEmail: str | None = None, guestDisplayName: str | None = None, guestEmail: str | None = None, **extra_data: Any)

Bases: ApiModel

person_id: str | None

The personId of the recipient example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ

person_email: str | None

The personEmail example: johndoe@simplistic.com

guest_display_name: str | None

Guests, who are unauthenticated users, have a guestDisplayName example: John Wayne

guest_email: str | None

Guests, who are unauthenticated users, have a guestEmail example: jwayne@mailinator.com

class wxc_sdk.events.EventsApi(*, session: RestSession, base: str = None)

Bases: ApiChild

Events are generated when actions take place within Webex, such as when someone creates or deletes a message. The Events API can only be used by a Compliance Officer with an API access token that contains the spark-compliance:events_read scope. See the Compliance Guide for more information.

list(resource: EventResource = None, type_: EventType = None, actor_id: str = None, from_: str | datetime = None, to_: str | datetime = None, **params) → Generator[ComplianceEvent, None, None]

List events in your organization. Several query parameters are available to filter the response.

Long result sets will be split into pages.

Parameters:

• resource (EventResource) – List events with a specific resource type.

• type (EventType) – List events with a specific event type.

• actor_id (str) – List events performed by this person, by person ID.

• from (str) – List events which occurred after a specific date and time.

• to (str) – List events that occurred before a specific date and time. If not specified, events up to the present time will be listed. Cannot be set to a future date relative to the current time.

base = 'events'

details(event_id: str) → ComplianceEvent

Shows details for an event, by event ID. Specify the event ID in the eventId parameter in the URI.

Parameters:

event_id (str) – The unique identifier for the event.