Platform Introduction Bots Integrations Widgets Guest Issuer

Getting Started Basics

Admin API Buttons and Cards Compliance Hybrid Services Webhooks xAPI

Admin Audit Events Attachment Actions Devices Events Licenses Memberships Messages Organizations People Places Resource Group Memberships Resource Groups Roles
Rooms
GET List RoomsPOST Create a RoomGET Get Room DetailsGET Get Room Meeting DetailsPUT Update a RoomDELETE Delete a Room
Team Memberships Teams Webhooks xAPI
API Changelog

iOS Android Browser Node.js Java Community

Get Room Details

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.

GET/v1/rooms/{roomId}
URI Parameters
roomId
stringrequired

The unique identifier for the room.

Response Properties
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.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
GET
/v1/rooms/
Log in to try the API.
Header
https://api.ciscospark.com/v1/rooms/Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
{
  "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"
}