Skip to content

WebexClient

Attributes

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'MembershipsUpdated': {'operation_id': 'MembershipsUpdated', 'path': '/{connectionId}/v1/webhooks/1', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MembershipsUpdatedResponse'}, 'MembershipsDeleted': {'operation_id': 'MembershipsDeleted', 'path': '/{connectionId}/v1/webhooks/2', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MembershipsDeletedResponse'}, 'MembershipsCreated': {'operation_id': 'MembershipsCreated', 'path': '/{connectionId}/v1/webhooks/3', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MembershipsCreatedResponse'}, 'MessagesCreated': {'operation_id': 'MessagesCreated', 'path': '/{connectionId}/v1/webhooks/4', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MessagesCreatedResponse'}, 'MessagesDeleted': {'operation_id': 'MessagesDeleted', 'path': '/{connectionId}/v1/webhooks/5', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MessagesDeletedResponse'}, 'SpaceCreated': {'operation_id': 'SpaceCreated', 'path': '/{connectionId}/v1/webhooks/6', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'SpaceCreatedResponse'}, 'SpaceUpdated': {'operation_id': 'SpaceUpdated', 'path': '/{connectionId}/v1/webhooks/7', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'SpaceUpdatedResponse'}}

Classes

CreateSpaceMemberInput dataclass 

CreateSpaceMemberInput(is_moderator: bool, room_id: str, *, person_email: Optional[str] = None, person_id: Optional[str] = None)

Add Member to Space

Attributes

is_moderator class-attribute instance-attribute 
is_moderator: bool = dataclass_field(metadata={'wire_name': 'isModerator'})

Is moderator?

person_email class-attribute instance-attribute 
person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personEmail'})

Email address

person_id class-attribute instance-attribute 
person_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personId'})

Person ID of the new member

room_id class-attribute instance-attribute 
room_id: str = dataclass_field(metadata={'wire_name': 'roomId'})

Select a space

CreateSpaceMemberResponse dataclass 

CreateSpaceMemberResponse(*, created: Optional[str] = None, id: Optional[str] = None, is_moderator: Optional[bool] = None, is_monitor: Optional[bool] = None, person_display_name: Optional[str] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, person_org_id: Optional[str] = None, room_id: Optional[str] = None)

Response for Add Member to Space

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

is_moderator class-attribute instance-attribute 
is_moderator: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isModerator'})

isModerator

is_monitor class-attribute instance-attribute 
is_monitor: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isMonitor'})

isMonitor

person_display_name class-attribute instance-attribute 
person_display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personDisplayName'})

personDisplayName

person_email class-attribute instance-attribute 
person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personEmail'})

personEmail

person_id class-attribute instance-attribute 
person_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personId'})

personId

person_org_id class-attribute instance-attribute 
person_org_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personOrgId'})

personOrgId

room_id class-attribute instance-attribute 
room_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'roomId'})

roomId

GetMessagesResponse dataclass 

GetMessagesResponse(*, items: Optional[List[Dict[str, Any]]] = None)

Response for Get Messages

Attributes

items class-attribute instance-attribute 
items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

items

SendMessageInput dataclass 

SendMessageInput(*, files: Optional[List[str]] = None, markdown: Optional[str] = None, room_id: Optional[str] = None, text: Optional[str] = None, to_person_email: Optional[str] = None, to_person_id: Optional[str] = None)

Send a Message

Attributes

files class-attribute instance-attribute 
files: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

files

markdown class-attribute instance-attribute 
markdown: Optional[str] = dataclass_field(default=None, kw_only=True)

Message, in markdown format

room_id class-attribute instance-attribute 
room_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'roomId'})

Select a recipient space

text class-attribute instance-attribute 
text: Optional[str] = dataclass_field(default=None, kw_only=True)

Message Text, in plain text, used for clients that do not support markdown

to_person_email class-attribute instance-attribute 
to_person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'toPersonEmail'})

The email address of the recipient when sending a private 1:1 message

to_person_id class-attribute instance-attribute 
to_person_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'toPersonId'})

The ID of the recipient when sending a 1:1 message

SendMessageResponse dataclass 

SendMessageResponse(*, created: Optional[str] = None, id: Optional[str] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, room_id: Optional[str] = None, room_type: Optional[str] = None, text: Optional[str] = None, to_person_email: Optional[str] = None)

Response for Send a Message

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

person_email class-attribute instance-attribute 
person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personEmail'})

personEmail

person_id class-attribute instance-attribute 
person_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personId'})

personId

room_id class-attribute instance-attribute 
room_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'roomId'})

roomId

room_type class-attribute instance-attribute 
room_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'roomType'})

roomType

text class-attribute instance-attribute 
text: Optional[str] = dataclass_field(default=None, kw_only=True)

text

to_person_email class-attribute instance-attribute 
to_person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'toPersonEmail'})

toPersonEmail

GetMessageDetailsResponse dataclass 

GetMessageDetailsResponse(*, created: Optional[str] = None, files: Optional[List[str]] = None, id: Optional[str] = None, markdown: Optional[str] = None, mentioned_groups: Optional[List[str]] = None, mentioned_people: Optional[List[str]] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, room_id: Optional[str] = None, room_type: Optional[str] = None, text: Optional[str] = None, to_person_email: Optional[str] = None, to_person_id: Optional[str] = None)

Response for Get Message Details

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

files class-attribute instance-attribute 
files: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

files

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

markdown class-attribute instance-attribute 
markdown: Optional[str] = dataclass_field(default=None, kw_only=True)

markdown

mentioned_groups class-attribute instance-attribute 
mentioned_groups: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mentionedGroups'})

mentionedGroups

mentioned_people class-attribute instance-attribute 
mentioned_people: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mentionedPeople'})

mentionedPeople

person_email class-attribute instance-attribute 
person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personEmail'})

personEmail

person_id class-attribute instance-attribute 
person_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personId'})

personId

room_id class-attribute instance-attribute 
room_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'roomId'})

roomId

room_type class-attribute instance-attribute 
room_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'roomType'})

roomType

text class-attribute instance-attribute 
text: Optional[str] = dataclass_field(default=None, kw_only=True)

text

to_person_email class-attribute instance-attribute 
to_person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'toPersonEmail'})

toPersonEmail

to_person_id class-attribute instance-attribute 
to_person_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'toPersonId'})

toPersonId

GetPeopleResponse dataclass 

GetPeopleResponse(*, items: Optional[List[Dict[str, Any]]] = None, not_found_ids: Optional[List[str]] = None)

Response for Get People

Attributes

items class-attribute instance-attribute 
items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

items

not_found_ids class-attribute instance-attribute 
not_found_ids: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'notFoundIds'})

notFoundIds

GetMyOwnDetailsResponse dataclass 

GetMyOwnDetailsResponse(*, avatar: Optional[str] = None, created: Optional[str] = None, display_name: Optional[str] = None, emails: Optional[List[str]] = None, first_name: Optional[str] = None, id: Optional[str] = None, last_activity: Optional[str] = None, last_name: Optional[str] = None, nick_name: Optional[str] = None, org_id: Optional[str] = None, phone_numbers: Optional[List[Dict[str, Any]]] = None, status: Optional[str] = None, type_: Optional[str] = None)

Response for Get My Own Details

Attributes

avatar class-attribute instance-attribute 
avatar: Optional[str] = dataclass_field(default=None, kw_only=True)

avatar

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

display_name class-attribute instance-attribute 
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

displayName

emails class-attribute instance-attribute 
emails: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

emails

first_name class-attribute instance-attribute 
first_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'firstName'})

firstName

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

last_activity class-attribute instance-attribute 
last_activity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastActivity'})

lastActivity

last_name class-attribute instance-attribute 
last_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastName'})

lastName

nick_name class-attribute instance-attribute 
nick_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nickName'})

nickName

org_id class-attribute instance-attribute 
org_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'orgId'})

orgId

phone_numbers class-attribute instance-attribute 
phone_numbers: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'phoneNumbers'})

phoneNumbers

status class-attribute instance-attribute 
status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

type_ class-attribute instance-attribute 
type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

type

GetSpacesResponse dataclass 

GetSpacesResponse(*, items: Optional[List[Dict[str, Any]]] = None)

Response for Get Spaces List

Attributes

items class-attribute instance-attribute 
items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

items

CreateSpaceInput dataclass 

CreateSpaceInput(title: str, *, team_id: Optional[str] = None)

Create Space

Attributes

team_id class-attribute instance-attribute 
team_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'teamId'})

Optionally select a team

title instance-attribute 
title: str

Space Title

CreateSpaceResponse dataclass 

CreateSpaceResponse(*, created: Optional[str] = None, creator_id: Optional[str] = None, id: Optional[str] = None, is_locked: Optional[bool] = None, last_activity: Optional[str] = None, title: Optional[str] = None, type_: Optional[str] = None)

Response for Create Space

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

creator_id class-attribute instance-attribute 
creator_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creatorId'})

creatorId

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

is_locked class-attribute instance-attribute 
is_locked: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isLocked'})

isLocked

last_activity class-attribute instance-attribute 
last_activity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastActivity'})

lastActivity

title class-attribute instance-attribute 
title: Optional[str] = dataclass_field(default=None, kw_only=True)

title

type_ class-attribute instance-attribute 
type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

type

GetSpaceDetailResponse dataclass 

GetSpaceDetailResponse(*, created: Optional[str] = None, creator_id: Optional[str] = None, id: Optional[str] = None, is_locked: Optional[bool] = None, last_activity: Optional[str] = None, title: Optional[str] = None, type_: Optional[str] = None)

Response for Get Space Details

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

creator_id class-attribute instance-attribute 
creator_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creatorId'})

creatorId

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

is_locked class-attribute instance-attribute 
is_locked: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isLocked'})

isLocked

last_activity class-attribute instance-attribute 
last_activity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastActivity'})

lastActivity

title class-attribute instance-attribute 
title: Optional[str] = dataclass_field(default=None, kw_only=True)

title

type_ class-attribute instance-attribute 
type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

type

CreateTeamMemberInput dataclass 

CreateTeamMemberInput(is_moderator: bool, team_id: str, *, person_email: Optional[str] = None, person_id: Optional[str] = None)

Add Member to Team

Attributes

is_moderator class-attribute instance-attribute 
is_moderator: bool = dataclass_field(metadata={'wire_name': 'isModerator'})

Is Moderator?

person_email class-attribute instance-attribute 
person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personEmail'})

Email address

person_id class-attribute instance-attribute 
person_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personId'})

Person ID of the new member

team_id class-attribute instance-attribute 
team_id: str = dataclass_field(metadata={'wire_name': 'teamId'})

Select a team

CreateTeamMemberResponse dataclass 

CreateTeamMemberResponse(*, created: Optional[str] = None, id: Optional[str] = None, is_moderator: Optional[bool] = None, person_display_name: Optional[str] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, person_org_id: Optional[str] = None, team_id: Optional[str] = None)

Response for Add Member to Team

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

is_moderator class-attribute instance-attribute 
is_moderator: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isModerator'})

isModerator

person_display_name class-attribute instance-attribute 
person_display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personDisplayName'})

personDisplayName

person_email class-attribute instance-attribute 
person_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personEmail'})

personEmail

person_id class-attribute instance-attribute 
person_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personId'})

personId

person_org_id class-attribute instance-attribute 
person_org_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personOrgId'})

personOrgId

team_id class-attribute instance-attribute 
team_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'teamId'})

teamId

MembershipsUpdatedInput dataclass 

MembershipsUpdatedInput(event: str, name: str, resource: str, target_url: str)

When a membership is updated

Attributes

event instance-attribute 
event: str

event

name instance-attribute 
name: str

name

resource instance-attribute 
resource: str

resource

target_url class-attribute instance-attribute 
target_url: str = dataclass_field(metadata={'wire_name': 'targetUrl'})

targetUrl

MembershipsUpdatedResponse dataclass 

MembershipsUpdatedResponse(*, created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a membership is updated

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

name class-attribute instance-attribute 
name: Optional[str] = dataclass_field(default=None, kw_only=True)

name

target_url class-attribute instance-attribute 
target_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute 
resource: Optional[str] = dataclass_field(default=None, kw_only=True)

resource

event class-attribute instance-attribute 
event: Optional[str] = dataclass_field(default=None, kw_only=True)

event

filter class-attribute instance-attribute 
filter: Optional[str] = dataclass_field(default=None, kw_only=True)

filter

secret class-attribute instance-attribute 
secret: Optional[str] = dataclass_field(default=None, kw_only=True)

secret

status class-attribute instance-attribute 
status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

MembershipsDeletedInput dataclass 

MembershipsDeletedInput(event: str, name: str, resource: str, target_url: str)

When a membership is deleted

Attributes

event instance-attribute 
event: str

event

name instance-attribute 
name: str

name

resource instance-attribute 
resource: str

resource

target_url class-attribute instance-attribute 
target_url: str = dataclass_field(metadata={'wire_name': 'targetUrl'})

targetUrl

MembershipsDeletedResponse dataclass 

MembershipsDeletedResponse(*, created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a membership is deleted

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

name class-attribute instance-attribute 
name: Optional[str] = dataclass_field(default=None, kw_only=True)

name

target_url class-attribute instance-attribute 
target_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute 
resource: Optional[str] = dataclass_field(default=None, kw_only=True)

resource

event class-attribute instance-attribute 
event: Optional[str] = dataclass_field(default=None, kw_only=True)

event

filter class-attribute instance-attribute 
filter: Optional[str] = dataclass_field(default=None, kw_only=True)

filter

secret class-attribute instance-attribute 
secret: Optional[str] = dataclass_field(default=None, kw_only=True)

secret

status class-attribute instance-attribute 
status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

MembershipsCreatedInput dataclass 

MembershipsCreatedInput(event: str, name: str, resource: str, target_url: str)

When a membership is created

Attributes

event instance-attribute 
event: str

event

name instance-attribute 
name: str

name

resource instance-attribute 
resource: str

resource

target_url class-attribute instance-attribute 
target_url: str = dataclass_field(metadata={'wire_name': 'targetUrl'})

targetUrl

MembershipsCreatedResponse dataclass 

MembershipsCreatedResponse(*, created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a membership is created

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

name class-attribute instance-attribute 
name: Optional[str] = dataclass_field(default=None, kw_only=True)

name

target_url class-attribute instance-attribute 
target_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute 
resource: Optional[str] = dataclass_field(default=None, kw_only=True)

resource

event class-attribute instance-attribute 
event: Optional[str] = dataclass_field(default=None, kw_only=True)

event

filter class-attribute instance-attribute 
filter: Optional[str] = dataclass_field(default=None, kw_only=True)

filter

secret class-attribute instance-attribute 
secret: Optional[str] = dataclass_field(default=None, kw_only=True)

secret

status class-attribute instance-attribute 
status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

MessagesCreatedInput dataclass 

MessagesCreatedInput(event: str, name: str, resource: str, target_url: str)

When a message is created

Attributes

event instance-attribute 
event: str

event

name instance-attribute 
name: str

name

resource instance-attribute 
resource: str

resource

target_url class-attribute instance-attribute 
target_url: str = dataclass_field(metadata={'wire_name': 'targetUrl'})

targetUrl

MessagesCreatedResponse dataclass 

MessagesCreatedResponse(*, created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a message is created

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

name class-attribute instance-attribute 
name: Optional[str] = dataclass_field(default=None, kw_only=True)

name

target_url class-attribute instance-attribute 
target_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute 
resource: Optional[str] = dataclass_field(default=None, kw_only=True)

resource

event class-attribute instance-attribute 
event: Optional[str] = dataclass_field(default=None, kw_only=True)

event

filter class-attribute instance-attribute 
filter: Optional[str] = dataclass_field(default=None, kw_only=True)

filter

secret class-attribute instance-attribute 
secret: Optional[str] = dataclass_field(default=None, kw_only=True)

secret

status class-attribute instance-attribute 
status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

MessagesDeletedInput dataclass 

MessagesDeletedInput(event: str, name: str, resource: str, target_url: str)

When a message is deleted

Attributes

event instance-attribute 
event: str

event

name instance-attribute 
name: str

name

resource instance-attribute 
resource: str

resource

target_url class-attribute instance-attribute 
target_url: str = dataclass_field(metadata={'wire_name': 'targetUrl'})

targetUrl

MessagesDeletedResponse dataclass 

MessagesDeletedResponse(*, created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a message is deleted

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

name class-attribute instance-attribute 
name: Optional[str] = dataclass_field(default=None, kw_only=True)

name

target_url class-attribute instance-attribute 
target_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute 
resource: Optional[str] = dataclass_field(default=None, kw_only=True)

resource

event class-attribute instance-attribute 
event: Optional[str] = dataclass_field(default=None, kw_only=True)

event

filter class-attribute instance-attribute 
filter: Optional[str] = dataclass_field(default=None, kw_only=True)

filter

secret class-attribute instance-attribute 
secret: Optional[str] = dataclass_field(default=None, kw_only=True)

secret

status class-attribute instance-attribute 
status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

SpaceCreatedInput dataclass 

SpaceCreatedInput(event: str, name: str, resource: str, target_url: str)

When a space is created

Attributes

event instance-attribute 
event: str

event

name instance-attribute 
name: str

name

resource instance-attribute 
resource: str

resource

target_url class-attribute instance-attribute 
target_url: str = dataclass_field(metadata={'wire_name': 'targetUrl'})

targetUrl

SpaceCreatedResponse dataclass 

SpaceCreatedResponse(*, created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a space is created

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

name class-attribute instance-attribute 
name: Optional[str] = dataclass_field(default=None, kw_only=True)

name

target_url class-attribute instance-attribute 
target_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute 
resource: Optional[str] = dataclass_field(default=None, kw_only=True)

resource

event class-attribute instance-attribute 
event: Optional[str] = dataclass_field(default=None, kw_only=True)

event

filter class-attribute instance-attribute 
filter: Optional[str] = dataclass_field(default=None, kw_only=True)

filter

secret class-attribute instance-attribute 
secret: Optional[str] = dataclass_field(default=None, kw_only=True)

secret

status class-attribute instance-attribute 
status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

SpaceUpdatedInput dataclass 

SpaceUpdatedInput(event: str, name: str, resource: str, target_url: str)

When a space is updated

Attributes

event instance-attribute 
event: str

event

name instance-attribute 
name: str

name

resource instance-attribute 
resource: str

resource

target_url class-attribute instance-attribute 
target_url: str = dataclass_field(metadata={'wire_name': 'targetUrl'})

targetUrl

SpaceUpdatedResponse dataclass 

SpaceUpdatedResponse(*, created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a space is updated

Attributes

created class-attribute instance-attribute 
created: Optional[str] = dataclass_field(default=None, kw_only=True)

created

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

name class-attribute instance-attribute 
name: Optional[str] = dataclass_field(default=None, kw_only=True)

name

target_url class-attribute instance-attribute 
target_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute 
resource: Optional[str] = dataclass_field(default=None, kw_only=True)

resource

event class-attribute instance-attribute 
event: Optional[str] = dataclass_field(default=None, kw_only=True)

event

filter class-attribute instance-attribute 
filter: Optional[str] = dataclass_field(default=None, kw_only=True)

filter

secret class-attribute instance-attribute 
secret: Optional[str] = dataclass_field(default=None, kw_only=True)

secret

status class-attribute instance-attribute 
status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

WebexClient 

WebexClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for webex connector.

Initialize a WebexClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
credential AsyncTokenCredential | AzureKeyCredential

Caller-owned Azure Core credential.

 required
max_retry_attempts int

The maximum number of request attempts.

 3
timeout float

The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.

 30.0
use_exponential_backoff bool

Whether retries use exponential backoff.

 True
initial_retry_delay_seconds float

The initial retry delay in seconds.

 0.5
maximum_retry_delay_seconds float

The maximum retry delay in seconds.

 120.0
retry_jitter_factor float

The jitter fraction applied to retry delays.

 0.1
retry_unsafe_http_methods bool

Whether unsafe HTTP methods may be retried.

 False
transport Optional[AsyncHttpTransport]

Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.

 None
**kwargs Any

Optional Azure Core pipeline policy settings.

 {}

Methods:

create_space_member async 
create_space_member(input: CreateSpaceMemberInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add Member to Space

Add a member to an existing space

Swagger operation ID: CreateSpaceMember.

Parameters:

Name Type Description Default
input CreateSpaceMemberInput | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_messages 
list_messages(room_id: str, *, mentioned_people: Optional[str] = None, before_message: Optional[str] = None, before: Optional[str] = None, max: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Messages

Get a list of recent messages for a space

Returns a single-page Azure Core async collection.

Swagger operation ID: GetMessages.

Parameters:

Name Type Description Default
room_id str

List messages in a space for a given space ID.

 required
mentioned_people Optional[str]

List messages where the caller is mentioned by specifying "me" or the caller personId.

 None
before_message Optional[str]

List messages sent before a message, by ID.

 None
before Optional[str]

List messages sent before a date and time, in ISO8601 format.

 None
max Optional[int]

Limit the maximum number of messages in the response.

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
send_message async 
send_message(input: SendMessageInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send a Message

Send a message to webex

Swagger operation ID: SendMessage.

Parameters:

Name Type Description Default
input SendMessageInput | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
get_message_details async 
get_message_details(message_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Message Details

Shows details for a message, by message ID.

Swagger operation ID: GetMessageDetails.

Parameters:

Name Type Description Default
message_id str

The message ID.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_people 
list_people(*, id: Optional[str] = None, email: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get People

Lookup details and presence information for people in your organization

Returns a single-page Azure Core async collection.

Swagger operation ID: GetPeople.

Parameters:

Name Type Description Default
id Optional[str]

List people by ID. Accepts up to 85 person IDs separated by commas.

 None
email Optional[str]

List people with this email address.

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
get_my_own_details async 
get_my_own_details(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get My Own Details

Lookup your own details

Swagger operation ID: GetMyOwnDetails.

Parameters:

Name Type Description Default
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_spaces 
list_spaces(*, max: Optional[int] = None, type_: Optional[str] = None, sort_by: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Spaces List

This action retrieves a list of spaces

Returns a single-page Azure Core async collection.

Swagger operation ID: GetSpaces.

Parameters:

Name Type Description Default
max Optional[int]

Maximum number of spaces to return.

 None
type_ Optional[str]

(group) only include group spaces, (direct) only include 1 to 1 spaces, returns all if not specified.

 None
sort_by Optional[str]

(id) the space id, (lastactivity) the last activity timestamp, (created) space creation date.

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
create_space async 
create_space(input: CreateSpaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create Space

Create space or team space

Swagger operation ID: CreateSpace.

Parameters:

Name Type Description Default
input CreateSpaceInput | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
get_space_detail async 
get_space_detail(room_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Space Details

Return details of a given space

Swagger operation ID: GetSpaceDetail.

Parameters:

Name Type Description Default
room_id str

Select a space.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
create_team_member async 
create_team_member(input: CreateTeamMemberInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add Member to Team

Add a member to a team

Swagger operation ID: CreateTeamMember.

Parameters:

Name Type Description Default
input CreateTeamMemberInput | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.