Skip to main content
Skip table of contents

Using a room ID to join a guest entitlements room

Request

When a user enters a room ID to join a guest entitlements room, the client should send a PUT request to:

CODE
https://<host>:<port>/ges/v1/user/room/{roomId}

Headers

  • Authorisation

  • x-correlation-id – identifier for logging, to correlate messages across a call flow

Mandatory arguments

  • roomId – the ID of the room (in the URL)

Response

A successful request returns an HTTP 200 status.

The response includes the room ID and the shared content ID, which is the ID of the channel that the room has been created for. Once this client receives a success response, it should switch to this channel.

Example

A successful request returns a payload that looks like this:

JSON
{
  "roomId": "YE7JY49WGU",
  "sharedContentId": "2QYB1ejxygDGVoTEJd3w"
}

See also

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.