Request
When a user creates a guest entitlements room, the client should send a POST request to:
https://<host>:<port>/ges/v1/user/room
Headers
-
Authorisation
-
x-correlation-id– identifier for logging, to correlate messages across a call flow
Mandatory arguments
-
editorialChannelId– the ID of editorial channel to be shared
Example
A request with a body in the following form requests a guest entitlements room for the channel with the specified ID:
JSON
{
"createRoom": {
"editorialChannelId": "Xzr%KLCeYrTk592fSF5VuBhPEfkjqAFw8fc+@nW"
}
}
Response
A successful request returns an HTTP 200 status.
The response includes the room ID, which the client application should display to the user so they can share it with people they want to invite.
Example
A successful request returns a payload that looks like this:
JSON
{
"roomId": "YE7JY49WGU"
}