POST game/{instanceId}/join

Join a multiplayer game.

Example

POST /api/v1/game/a2c4f9bd-b698-4b21-839d-81e75e514d0c/join HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer ...
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "gameId": "a2c4f9bd-b698-4b21-839d-81e75e514d0c",
  "instanceId": "a2c4f9bd-b698-4b21-839d-81e75e514d0c",
  "playId": "TerminalScene01",
  "socketUrl": "wss://ws1.ws.prod.theendlessmission.com/game/a2c4f9bd-b698-4b21-839d-81e75e514d0c",
  "accessToken": "eyJhb...Qjg",
  "settings": {
    "decoration": "halloween-19",
    "lighting": "spooky-rave-party"
  }
}

Security

Authentication is required.

URL Parameters

NameDescriptionValue
instanceIdthe ID of the game instance to join, as a GUID with dashesstring

Query Parameters

NONE

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Other error responses are standard.

Response Body

NameDescriptionValue
instanceIdthe ID of the game instance to joinstring
gameIdthe ID of the game that was createdNOTE: this field is deprecated and will be removed. Use instanceId instead.string
playIdthe ID of the game being played on this instance; it may be a UUID of an entity (by reivision), or it may be another identifier known by the game client.string
socketUrlthe URL to use to establish a WebSocket connectionstring
accessTokena token granting access to the socket host, as a JWTstring
settingsa game-type-specific bag of settings, to be given to a player joining the game; no schema is enforced on these settingsobject