Skip to content

Message Types

Ping

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null
}

Pong

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null
}

Broadcast

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "message": null
}

Hello

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "sessionId": null
}

ServerTime

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "unixNano": null,
  "unixTimestamp": null
}

PlaybackChannelMessage

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null,
  "count": null,
  "inverse": null,
  "nextId": null
}

GetChannelMeta

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null,
  "data": null
}

SetChannelMeta

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null
}

CreateChannel

{
  "appId": null,
  "channelId": null,
  "directUrl": null,
  "idleTimeout": null,
  "ownerKey": null,
  "participatorKey": null,
  "region": null
}

JoinChannel

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null,
  "channelMetadata": null,
  "role": null,
  "sessionId": null,
  "sessionMetadata": null,
  "subject": null
}

LeaveChannel

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null,
  "sessionId": null
}

CloseChannel

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null
}

ChannelMessage

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null,
  "fromSessionId": null,
  "message": null,
  "offset": null,
  "subject": null,
  "subjectName": null,
  "metadata": null
}

ChannelCount

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null,
  "count": null,
  "ownerCount": null,
  "participatorCount": null
}

ChannelOwnerMessage

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null,
  "message": null,
  "offset": null,
  "subject": null,
  "subjectName": null,
  "metadata": null
}

ReplayChannelMessage

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "channelId": null,
  "count": null,
  "inverse": null,
  "nextId": null
}

GetVoteMeta

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "data": null,
  "name": null,
  "voteId": null,
  "voteOptions": [
    {
      "id": "",
      "name": "",
      "subjects": null
    }
  ]
}

SetVoteMeta

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null
}

CreateVote

{
  "appId": null,
  "directUrl": null,
  "idleTimeout": null,
  "name": null,
  "unique": null,
  "voteId": null,
  "voteKey": null,
  "voteOptions": [
    {
      "id": "",
      "name": ""
    }
  ]
}

JoinVote

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "name": null,
  "sessionId": null,
  "sessionMetadata": null,
  "voteId": null,
  "voteMetadata": null,
  "voteOptions": [
    {
      "id": "",
      "name": "",
      "subjects": null
    }
  ]
}

LeaveVote

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null
}

CloseVote

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "voteId": null
}

VoteMessage

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "fromSessionId": null,
  "message": null,
  "voteId": null
}

VoteSelect

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "deny": null,
  "voteId": null,
  "voteOptionId": null
}

VoteCount

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "voteId": null,
  "voteOptions": [
    {
      "id": "",
      "name": "",
      "count": null,
      "subjects": null
    }
  ]
}

VoteOwnerMessage

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "message": null,
  "voteId": null
}

VoteStatus

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "status": null,
  "voteId": null
}

GetSessionMeta

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "sessionId": null,
  "data": null,
  "name": null,
  "sessionId": null,
  "subject": null
}

SetSessionMeta

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null
}

SessionMessage

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "fromSessionId": null,
  "message": null
}

Error

{
  "classCode": null,
  "timestamp": null,
  "transitId": null,
  "messageId": null,
  "data": null,
  "error": null,
  "errorCategory": null,
  "errorCode": null,
  "errorDescription": null,
  "errorLevel": null,
  "message": null,
  "statusCode": null
}