List Rooms
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.
GET/v1/rooms
Query Parameters
teamId
string
List rooms associated with a team, by ID.
type
string
List rooms by type.
Possible values: direct, group
sortBy
string
Sort results.
Possible values: id, lastactivity, created
max
number
Limit the maximum number of rooms in the response.
Default: 100
Response Properties
items
array
id
string
A unique identifier for the room.
title
string
A user-friendly name for the room.
type
enum
The room type.
direct
1:1 room
group
group room
isLocked
boolean
Whether the room is moderated (locked) or not.
teamId
string
The ID for the team with which this room is associated.
lastActivity
string
The date and time of the room's last activity.
creatorId
string
The ID of the person who created this room.
created
string
The date and time the room was created.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
GET
/v1/rooms{?teamId,type,sortBy,max}
Log in to try the API.
Header
Query Parameters
- List rooms associated with a team, by ID.
- List rooms by type.
- Sort results.
- Limit the maximum number of rooms in the response.
https://api.ciscospark.com/v1/rooms?teamId=Y2lzY29zcGFyazovL3VzL1JPT00vNjRlNDVhZTAtYzQ2Yi0xMWU1LTlkZjktMGQ0MWUzNDIxOTcz&type=%5Bobject%20Object%5D,%5Bobject%20Object%5D&sortBy=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&max=100
{
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
"title": "Project Unicorn - Sprint 0",
"type": "group",
"isLocked": true,
"teamId": "Y2lzY29zcGFyazovL3VzL1JPT00vNjRlNDVhZTAtYzQ2Yi0xMWU1LTlkZjktMGQ0MWUzNDIxOTcz",
"lastActivity": "2016-04-21T19:12:48.920Z",
"creatorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"created": "2016-04-21T19:01:55.966Z"
}
]
}