{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Rooms API", "version": "1.0.0" }, "items": [ { "info": { "name": "Rooms", "type": "folder" }, "items": [ { "info": { "name": "List Rooms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rooms", "params": [ { "name": "teamId", "value": "Y2lzY29zcGFyazovL3VzL1JPT00vNjRlNDVhZTAtYzQ2Yi0xMWU1LTlkZjktMGQ0MWUzNDIxOTcz", "type": "query", "description": "List rooms associated with a team, by ID. Cannot be set in combination with `orgPublicSpaces`." }, { "name": "type", "value": "group", "type": "query", "description": "List rooms by type. Cannot be set in combination with `orgPublicSpaces`." }, { "name": "orgPublicSpaces", "value": "true", "type": "query", "description": "Shows the org's public spaces joined and unjoined. When set the result list is sorted by the `madePublic` timestamp." }, { "name": "from", "value": "2022-10-10T17:00:00.000Z", "type": "query", "description": "Filters rooms, that were made public after this time. See `madePublic` timestamp" }, { "name": "to", "value": "2022-10-11T17:00:00.000Z", "type": "query", "description": "Filters rooms, that were made public before this time. See `maePublic` timestamp" }, { "name": "sortBy", "value": "id", "type": "query", "description": "Sort results. Cannot be set in combination with `orgPublicSpaces`." }, { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of rooms in the response. Value must be between 1 and 1000, inclusive." } ] }, "docs": "List rooms to which the authenticated user belongs to.\n\nThe `title` of the room for 1:1 rooms will be the display name of the other person. Please use the [memberships API](https://developer.webex.com/docs/api/v1/memberships) to list the people in the space.\n\nLong result sets will be split into [pages](/docs/basics#pagination).\n\nKnown Limitations:\nThe underlying database does not support natural sorting by `lastactivity` and will only sort on limited set of results, which are pulled from the dat" }, { "info": { "name": "Create a Room", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rooms", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a room. The authenticated user is automatically added as a member of the room. See the [Memberships API](/docs/api/v1/memberships) to learn how to add more people to the room.\n\nTo create a 1:1 room, use the [Create Messages](/docs/api/v1/messages/create-a-message) endpoint to send a message directly to another person by using the `toPersonId` or `toPersonEmail` parameters.\n\nBots are not able to create and simultaneously classify a room. A bot may update a space classification after a per" }, { "info": { "name": "Get Room Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rooms/:roomId", "params": [ { "name": "roomId", "value": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0", "type": "path", "description": "The unique identifier for the room." } ] }, "docs": "Shows details for a room, by ID.\n\nThe `title` of the room for 1:1 rooms will be the display name of the other person. When a Compliance Officer lists 1:1 rooms, the \"other\" person cannot be determined. This means that the room's title may not be filled in and instead shows \"Empty Title\". Please use the [memberships API](https://developer.webex.com/docs/api/v1/memberships) to list the other person in the space.\n\nSpecify the room ID in the `roomId` parameter in the URI." }, { "info": { "name": "Update a Room", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/rooms/:roomId", "params": [ { "name": "roomId", "value": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0", "type": "path", "description": "The unique identifier for the room." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates details for a room, by ID.\n\nSpecify the room ID in the `roomId` parameter in the URI.\nA space can only be put into announcement mode when it is locked.\nAny 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.\nTo remove a `description` please use a space character ` ` by itself." }, { "info": { "name": "Delete a Room", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/rooms/:roomId", "params": [ { "name": "roomId", "value": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0", "type": "path", "description": "The unique identifier for the room." } ] }, "docs": "Deletes a room, by ID. Deleted rooms cannot be recovered.\nAs a security measure to prevent accidental deletion, when a non moderator deletes the room they are removed from the room instead.\n\nDeleting a room that is part of a team will archive the room instead.\n\nA Compliance Officer has no special privileges, i.e. they cannot delete rooms they are not part of.\n\nSpecify the room ID in the `roomId` parameter in the URI." }, { "info": { "name": "Get Room Meeting Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rooms/:roomId/meetingInfo", "params": [ { "name": "roomId", "value": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0", "type": "path", "description": "The unique identifier for the room." } ] }, "docs": "
\n\nThe meetingInfo API is deprecated and will be EOL on Jan 31, 2025. Meetings in the WSMP must be scheduled and licensed via the meetings backend.\nThe [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) endpoint will provide the SIP address for the meeting to call.\n\n
\n\nShows Webex meeting details for a room such as the SIP address, meeting URL, toll-free and toll dial-in numbers.\n\nSpecify the room ID in the `roomId` parameter in the URI." } ] } ], "bundled": true }