wxc_sdk.meetings.invitees package

Bases: ApiModel

email: str | None: Email address for meeting invitee.

display_name: str | None: Display name for meeting invitee. The maximum length of displayName is 128 characters. In Webex App, if the email has been associated with an existing Webex account, the display name associated with the Webex account will be used; otherwise, the email will be used as displayName. In Webex site, if displayName is specified, it will show displayName. If displayName is not specified, and the email has been associated with an existing Webex account, the display name associated with the Webex account will be used; otherwise, the email will be used as displayName. : Please note that if the invitee has an existing Webex account, the displayName shown in the meeting will be the displayName associated with the Webex account; otherwise, displayName shown in the meeting will be the displayName which is specified by the invitee who does not have a Webex account.

co_host: bool | None: Whether or not invitee is a designated alternate host for the meeting. See Add Alternate Hosts for Cisco Webex Meetings for more details.

send_email: bool | None: If true, send an email to the invitee.

panelist: bool | None: If true, the invitee is a designated panelist for the event meeting.

Bases: ApiModel

id: str | None: Unique identifier for meeting invitee.

email: str | None: Email address for meeting invitee. This attribute can be modified by Update a Meeting Invitee API.

display_name: str | None: Display name for meeting invitee. This attribute can be modified by Update a Meeting Invitee API.

co_host: bool | None: Webex Meetings for more details.

meeting_id: str | None: series, a scheduled meeting, or a meeting instance which has ended or is ongoing.

panelist: bool | None: If true, the invitee is a designated panelist for the event meeting.

class wxc_sdk.meetings.invitees.MeetingInviteesApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

This API manages invitees’ relationships to a meeting. You can use the Meeting Invitees API to list, create, update, and delete invitees. Refer to the Meetings API Scopes section of Meetings Overview for scopes required for each API.

list(meeting_id: str, host_email: str | None = None, panelist: bool | None = None, **params) → Generator[Invitee, None, None][source]

Lists meeting invitees for a meeting with a specified meetingId. You can set a maximum number of invitees to return. This operation can be used for meeting series, scheduled meetings, and ended or ongoing meeting instance objects. If the specified meetingId is for a meeting series, the invitees for the series will be listed; if the meetingId is for a scheduled meeting, the invitees for the particular scheduled meeting will be listed; if the meetingId is for an ended or ongoing meeting instance, the invitees for the particular meeting instance will be listed. See the Webex Meetings guide for more information about the types of meetings. The list returned is sorted in ascending order by email address. Long result sets are split into pages.

Parameters:

meeting_id (str) – Unique identifier for the meeting for which invitees are being requested. The meeting can be a meeting series, a scheduled meeting, or a meeting instance which has ended or is ongoing. The meeting ID of a scheduled personal room meeting is not supported for this API.
host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return meeting invitees that are hosted by that user.
panelist (bool) – Filter invitees or attendees for webinars only. If true, returns invitees. If false, returns attendees. If null, returns both invitees and attendees.

Invite a person to attend a meeting. Identify the invitee in the request body, by email address.

Parameters:

email (str) – Email address for meeting invitee.
meeting_id (str) – Unique identifier for the meeting to which a person is being invited. This attribute only applies to meeting series and scheduled meeting. If it’s a meeting series, the meeting invitee is invited to the entire meeting series; if it’s a scheduled meeting, the meeting invitee is invited to this individual scheduled meeting. It doesn’t apply to an ended or ongoing meeting instance. The meeting ID of a scheduled personal room meeting is not supported for this API.
display_name (str) – Display name for meeting invitee. The maximum length of displayName is 128 characters. In Webex App, if the email has been associated with an existing Webex account, the display name associated with the Webex account will be used; otherwise, the email will be used as displayName. In Webex site, if displayName is specified, it will show displayName. If displayName is not specified, and the email has been associated with an existing Webex account, the display name associated with the Webex account will be used; otherwise, the email will be used as displayName. Please note that if the invitee has an existing Webex account, the displayName shown in the meeting will be the displayName associated with the Webex account; otherwise, displayName shown in the meeting will be the displayName which is specified by the invitee who does not have a Webex account.
co_host (bool) – Whether or not invitee is a designated alternate host for the meeting. See Add Alternate Hosts for Cisco Webex Meetings for more details.
send_email (bool) – If true, send an email to the invitee.
panelist (bool) – If true, the invitee is a designated panelist for the event meeting.
host_email (str) – Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.

create_invitees(meeting_id: str, items: List[CreateInviteesItem], host_email: str | None = None) → List[Invitee][source]

Invite people to attend a meeting in bulk. Identify each invitee by the email address of each item in the items of the request body. Each invitee should have a unique email. This API limits the maximum size of items in the request body to 100.

Parameters:

meeting_id (str) – Unique identifier for the meeting to which the people are being invited. This attribute only applies to meeting series and scheduled meetings. If it’s a meeting series, the meeting invitees are invited to the entire meeting series; if it’s a scheduled meeting, the meeting invitees are invited to this individual scheduled meeting. It doesn’t apply to an ended or ongoing meeting instance. The meeting ID of a scheduled personal room meeting is not supported for this API.
host_email (str) – Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.
items (CreateInviteesItem) – Meeting invitees to be inserted.

invitee_details(meeting_invitee_id: str, host_email: str | None = None) → Invitee[source]

Retrieve details for a meeting invitee identified by a meetingInviteeId in the URI.

Parameters:

meeting_invitee_id (str) – Unique identifier for the invitee whose details are being requested.
host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting invitee that is hosted by that user.

Update details for a meeting invitee identified by a meetingInviteeId in the URI.

Parameters:

meeting_invitee_id (str) – Unique identifier for the invitee to be updated. This parameter only applies to an invitee to a meeting series or a scheduled meeting. It doesn’t apply to an invitee to an ended or ongoing meeting instance.
email (str) – Email address for meeting invitee.
display_name (str) – Display name for meeting invitee. The maximum length of displayName is 128 characters. In Webex App, if the email has been associated with an existing Webex account, the display name associated with the Webex account will be used; otherwise, the email will be used as displayName. In Webex site, if displayName is specified, it will show displayName. If displayName is not specified, and the email has been associated with an existing Webex account, the display name associated with the Webex account will be used; otherwise, the email will be used as displayName. Please note that if the invitee has an existing Webex account, the displayName shown in the meeting will be the displayName associated with the Webex account; otherwise, displayName shown in the meeting will be the displayName which is specified by the invitee who does not have a Webex account.
co_host (bool) – Whether or not invitee is a designated alternate host for the meeting. See Add Alternate Hosts for Cisco Webex Meetings for more details.
send_email (bool) – If true, send an email to the invitee.
panelist (bool) – If true, the invitee is a designated panelist for the event meeting.
host_email (str) – Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.

delete(meeting_invitee_id: str, host_email: str | None = None, send_email: bool | None = None)[source]

Removes a meeting invitee identified by a meetingInviteeId specified in the URI. The deleted meeting invitee cannot be recovered. If the meeting invitee is associated with a meeting series, the invitee will be removed from the entire meeting series. If the invitee is associated with a scheduled meeting, the invitee will be removed from only that scheduled meeting.

Parameters:

meeting_invitee_id (str) – Unique identifier for the invitee to be removed. This parameter only applies to an invitee to a meeting series or a scheduled meeting. It doesn’t apply to an invitee to an ended or ongoing meeting instance.
host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will delete a meeting invitee that is hosted by that user.
send_email (bool) – If true, send an email to the invitee.

base = 'meetingInvitees'

Bases: CreateInviteesItem

meeting_id: str | None: Unique identifier for the meeting to which a person is being invited. This attribute only applies to meeting series and scheduled meeting. If it’s a meeting series, the meeting invitee is invited to the entire meeting series; if it’s a scheduled meeting, the meeting invitee is invited to this individual scheduled meeting. It doesn’t apply to an ended or ongoing meeting instance. The meeting ID of a scheduled personal room meeting is not supported for this API.

host_email: str | None: Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.

Bases: CreateInviteesItem

host_email: str | None: Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.

class wxc_sdk.meetings.invitees.CreateMeetingInviteesBody(*, meetingId: str | None = None, hostEmail: str | None = None, items: list[CreateInviteesItem] | None = None)[source]

Bases: ApiModel

meeting_id: str | None: Unique identifier for the meeting to which the people are being invited. This attribute only applies to meeting series and scheduled meetings. If it’s a meeting series, the meeting invitees are invited to the entire meeting series; if it’s a scheduled meeting, the meeting invitees are invited to this individual scheduled meeting. It doesn’t apply to an ended or ongoing meeting instance. The meeting ID of a scheduled personal room meeting is not supported for this API.

host_email: str | None: Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.

items: list[CreateInviteesItem] | None: Meeting invitees to be inserted.