Session Service WebSocket Communication 1.1.0

Accepts one of the following messages:

• #0userTokenUserTokenCommandMessage

  Message IDUserTokenCommandMessage

  User Token Command

  Payload

  Expand all

  object

  token

  string

  Additional properties are allowed.

  Extensions

  Expand all

  object

  x-ack

  Expand all

  object

  User Token Response

  command

  required

  string

  Command Type

  Allowed values:
  • "userToken"
  • "createSession"
  • "joinSession"
  • "leaveSession"
  • "sendMessage"
  • "stopVideo"
  • "playVideo"

  content

  Expand all

  required

  object

  User Token Response Content. It uses both ResponseStatus and UserTokenResponseStatus. The purpose of the first one is to signal communication errors with the Authentication of User Service, while the second one to inform if the token is valid or invalid.

  status

  required

  number

  Response Status

  Allowed values:
  • 0
  • 1

  tokenStatus

  required

  number

  Token Status

  Allowed values:
  • 0
  • 1

  user

  Expand all

  object

  User is an entity with id UserId and a string value representing the Username

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "token": "string"
  }
  

  This example has been generated automatically.

• #1createSessionCreateSessionCommandMessage

  Message IDCreateSessionCommandMessage

  Create Session Command

  Payload

  Expand all

  object

  videoUrl

  string

  Additional properties are allowed.

  Extensions

  Expand all

  object

  x-ack

  Expand all

  object

  Create Session Response

  command

  required

  string

  Command Type

  Allowed values:
  • "userToken"
  • "createSession"
  • "joinSession"
  • "leaveSession"
  • "sendMessage"
  • "stopVideo"
  • "playVideo"

  content

  Expand all

  required

  object

  Create Session Response Content

  sessionName

  required

  string

  status

  required

  number

  Response Status

  Allowed values:
  • 0
  • 1

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "videoUrl": "string"
  }
  

  This example has been generated automatically.

• #2joinSessionJoinSessionCommandMessage

  Message IDJoinSessionCommandMessage

  Join Session Command

  Payload

  Expand all

  object

  sessionName

  string

  Additional properties are allowed.

  Extensions

  Expand all

  object

  x-ack

  Expand all

  object

  Join Session Response

  command

  required

  string

  Command Type

  Allowed values:
  • "userToken"
  • "createSession"
  • "joinSession"
  • "leaveSession"
  • "sendMessage"
  • "stopVideo"
  • "playVideo"

  content

  Expand all

  required

  object

  Join Session Response Content

  status

  required

  number

  Join Session Response Type

  Allowed values:
  • 0
  • 1
  • 2

  videoId

  required

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "sessionName": "string"
  }
  

  This example has been generated automatically.

• #3leaveSessionLeaveSessionCommandMessage

  Message IDLeaveSessionCommandMessage

  Leave Session Command

  Extensions

  Expand all

  object

  x-ack

  Expand all

  object

  Leave Session Response

  command

  required

  string

  Command Type

  Allowed values:
  • "userToken"
  • "createSession"
  • "joinSession"
  • "leaveSession"
  • "sendMessage"
  • "stopVideo"
  • "playVideo"

  content

  required

  number

  Response Status

  Allowed values:
  • 0
  • 1

  Additional properties are NOT allowed.

  Examples

• #4sendMessageSendTextMessageCommandMessage

  Message IDSendTextMessageCommandMessage

  Send Chat Text Message Command

  Payload

  Expand all

  object

  message

  string

  Additional properties are allowed.

  Extensions

  Expand all

  object

  x-ack

  Expand all

  object

  Send Message Response

  command

  required

  string

  Command Type

  Allowed values:
  • "userToken"
  • "createSession"
  • "joinSession"
  • "leaveSession"
  • "sendMessage"
  • "stopVideo"
  • "playVideo"

  content

  required

  number

  Response Status

  Allowed values:
  • 0
  • 1

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "message": "string"
  }
  

  This example has been generated automatically.

• #5playVideoPlayVideoCommandMessage

  Message IDPlayVideoCommandMessage

  Play Video Command

  Payload

  Expand all

  object

  timestamp

  number

  Additional properties are allowed.

  Extensions

  Expand all

  object

  x-ack

  Expand all

  object

  Play Video Response

  command

  required

  string

  Command Type

  Allowed values:
  • "userToken"
  • "createSession"
  • "joinSession"
  • "leaveSession"
  • "sendMessage"
  • "stopVideo"
  • "playVideo"

  content

  required

  number

  Response Status

  Allowed values:
  • 0
  • 1

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "timestamp": 0
  }
  

  This example has been generated automatically.

• #6stopVideoStopVideoCommandMessage

  Message IDStopVideoCommandMessage

  Stop Video Command

  Payload

  Expand all

  object

  timestamp

  number

  Additional properties are allowed.

  Extensions

  Expand all

  object

  x-ack

  Expand all

  object

  Stop Video Reponse

  command

  required

  string

  Command Type

  Allowed values:
  • "userToken"
  • "createSession"
  • "joinSession"
  • "leaveSession"
  • "sendMessage"
  • "stopVideo"
  • "playVideo"

  content

  required

  number

  Response Status

  Allowed values:
  • 0
  • 1

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "timestamp": 0
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0textMessageSendTextMessageReactionMessage

  Message IDSendTextMessageReactionMessage

  Send Chat Text Message Reaction

  Payload

  Expand all

  object

  Text Message

  content

  required

  string

  sender

  Expand all

  required

  object

  User is an entity with id UserId and a string value representing the Username

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "content": "string",
    "sender": {}
  }
  

  This example has been generated automatically.

• #1notificationMessageSendNotificationMessageReactionMessage

  Message IDSendNotificationMessageReactionMessage

  Send Chat Notification Message Reaction

  Payload

  Expand all

  object

  Notification Message

  content

  required

  number

  Join Notification

  Allowed values:
  • 0
  • 1

  sender

  Expand all

  required

  object

  User is an entity with id UserId and a string value representing the Username

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "content": 0,
    "sender": {}
  }
  

  This example has been generated automatically.

• #2videoStateGetVideoStateReactionMessage

  Message IDGetVideoStateReactionMessage

  Get Video State Reaction

  Extensions

  Expand all

  object

  x-ack

  Expand all

  object

  Video State

  state

  required

  string

  Play State

  Allowed values:
  • "Paused"
  • "Playing"

  timestamp

  required

  number

  Additional properties are NOT allowed.

  Examples

• #3synchronizeSynchronizeVideoReactionMessage

  Message IDSynchronizeVideoReactionMessage

  Synchronize Video Reaction

  Payload

  Expand all

  object

  Video State

  state

  required

  string

  Play State

  Allowed values:
  • "Paused"
  • "Playing"

  timestamp

  required

  number

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "state": "Paused",
    "timestamp": 0
  }
  

  This example has been generated automatically.