wxc_sdk.rooms package

Rooms API

class wxc_sdk.rooms.GetRoomMeetingDetailsResponse(*, roomId: str | None = None, meetingLink: str | None = None, sipAddress: str | None = None, meetingNumber: str | None = None, meetingId: str | None = None, callInTollFreeNumber: str | None = None, callInTollNumber: str | None = None)[source]

Bases: ApiModel

room_id: str | None

A unique identifier for the room.

The Webex meeting URL for the room.

sip_address: str | None

The SIP address for the room.

meeting_number: str | None

The Webex meeting number for the room.

meeting_id: str | None

The Webex meeting ID for the room.

call_in_toll_free_number: str | None

The toll-free PSTN number for the room.

call_in_toll_number: str | None

The toll (local) PSTN number for the room.

class wxc_sdk.rooms.Room(*, id: str | None = None, title: str | None = None, teamId: str | None = None, classificationId: str | None = None, type: RoomType | None = None, lastActivity: datetime | None = None, creatorId: str | None = None, created: datetime | None = None, ownerId: str | None = None, isReadOnly: bool | None = None, isLocked: bool | None = None, isAnnouncementOnly: bool | None = None, isPublic: bool | None = None, madePublic: datetime | None = None, description: str | None = None)[source]

Bases: ApiModel

id: str | None

A unique identifier for the room.

title: str | None

A user-friendly name for the room.

team_id: str | None

The ID for the team with which this room is associated.

classification_id: str | None

The classificationId for the room.

type: RoomType | None

The room type.

last_activity: datetime | None

The date and time of the room’s last activity.

creator_id: str | None

The ID of the person who created this room.

created: datetime | None

The date and time the room was created.

owner_id: str | None

The ID of the organization which owns this room. See Webex Data in the Compliance Guide for more information.

is_read_only: bool | None
is_locked: bool | None

Set the space as locked/moderated and the creator becomes a moderator

is_announcement_only: bool | None

Sets the space into announcement Mode.

is_public: bool | None

The room is public and therefore discoverable within the org. Anyone can find and join that room.

made_public: datetime | None

Date and time when the room was made public.

description: str | None

The description of the space.

class wxc_sdk.rooms.RoomsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Rooms are virtual meeting places where people post messages and collaborate to get work done. This API is used to manage the rooms themselves. Rooms are created and deleted with this API. You can also update a room to change its title, for example. To create a team room, specify the a teamId in the POST payload. Note that once a room is added to a team, it cannot be moved. To learn more about managing teams, see the Teams API. To manage people in a room see the Memberships API. To post content see the Messages API.

list(team_id: str | None = None, type_: RoomType | None = None, org_public_spaces: bool | None = None, from_: datetime | None = None, to_: datetime | None = None, sort_by: str | None = None, **params) → Generator[Room, None, None][source]

List rooms. The title of the room for 1:1 rooms will be the display name of the other person. By default, lists rooms to which the authenticated user belongs. Long result sets will be split into pages. Known Limitations: The underlying database does not support natural sorting by lastactivity and will only sort on limited set of results, which are pulled from the database in order of roomId. For users or bots in more than 3000 spaces this can result in anomalies such as spaces that have had recent activity not being returned in the results when sorting by lastacivity.

Parameters:

  • team_id (str) – List rooms associated with a team, by ID.

  • type (RoomType) – List rooms by type. Possible values: direct, group

  • org_public_spaces (bool) – Shows the org’s public spaces joined and unjoined. When set the result list is sorted by the madePublic timestamp.

  • from (datetime) – Filters rooms, that were made public after this time. See madePublic timestamp

  • to (datetime) – Filters rooms, that were made public before this time. See maePublic timestamp

  • sort_by (str) – Sort results. Possible values: id, lastactivity, created

create(title: str, team_id: str | None = None, classification_id: str | None = None, is_locked: bool | None = None, is_public: bool | None = None, description: str | None = None, is_announcement_only: bool | None = None) → Room[source]

Creates a room. The authenticated user is automatically added as a member of the room. See the Memberships API to learn how to add more people to the room.

To create a 1:1 room, use the Create Messages endpoint to send a message directly to another person by using the toPersonId or toPersonEmail parameters. Bots are not able to create and simultaneously classify a room. A bot may update a space classification after a person of the same owning organization joined the space as the first human user.

A space can only be put into announcement mode when it is locked.

Parameters:

  • title (str) – A user-friendly name for the room.

  • team_id (str) – The ID for the team with which this room is associated.

  • classification_id (str) – The classificationId for the room.

  • is_locked (bool) – Set the space as locked/moderated and the creator becomes a moderator

  • is_public (bool) – The room is public and therefore discoverable within the org. Anyone can find and join that room. When true the description must be filled in.

  • description (str) – The description of the space.

  • is_announcement_only (bool) – Sets the space into announcement Mode.

details(room_id: str) → Room[source]

Shows details for a room, by ID. The title of the room for 1:1 rooms will be the display name of the other person. Specify the room ID in the roomId parameter in the URI.

Parameters:

room_id (str) – The unique identifier for the room.

meeting_details(room_id: str) → GetRoomMeetingDetailsResponse[source]

Shows Webex meeting details for a room such as the SIP address, meeting URL, toll-free and toll dial-in numbers. Specify the room ID in the roomId parameter in the URI.

Parameters:

room_id (str) – The unique identifier for the room.

update(update: Room) → Room[source]

Updates details for a room, by ID.

Specify the room ID in the roomId parameter in the URI.

A space can only be put into announcement mode when it is locked.

Any space participant or compliance officer can convert a space from public to private. Only a compliance officer can convert a space from private to public and only if the space is classified with the lowest category (usually public), and the space has a description.

To remove a description please use a space character by itself.

Update:

update to apply. ID and title have to be set. Only can update:

  • title: str: A user-friendly name for the room.

  • classification_id: str: The classificationId for the room.

  • team_id: str: The teamId to which this space should be assigned. Only unowned spaces can be assigned to a team. Assignment between teams is unsupported.

  • is_locked: bool: Set the space as locked/moderated and the creator becomes a moderator

  • is_announcement_only: bool: Sets the space into announcement mode or clears the anouncement Mode (false)

  • is_read_only: bool: A compliance officer can set a direct room as read-only, which will disallow any new information exchanges in this space, while maintaining historical data.

delete(room_id: str)[source]

Deletes a room, by ID. Deleted rooms cannot be recovered. As a security measure to prevent accidental deletion, when a non moderator deletes the room they are removed from the room instead. Deleting a room that is part of a team will archive the room instead. Specify the room ID in the roomId parameter in the URI.

Parameters:

room_id (str) – The unique identifier for the room.

base = 'rooms'