post/v1/channel/join/request
https://managedservices-prod.rteappbuilder.com/
SAMPLE REQUEST
{
  "passphrase": "YLUStods7dUIBqr_WjhUCNQYVi?fFZI5",
  "send_event": false
}
success
title
TYPE: STRING
isHost
TYPE: BOOLEAN
secret
TYPE: STRING
secretSalt
TYPE: STRING
mainUser
TYPE: OBJECT
rtc
TYPE: STRING
rtm
TYPE: STRING
chat
TYPE: STRING
uid
TYPE: INTEGER
screenShare
TYPE: OBJECT
rtc
TYPE: STRING
rtm
TYPE: STRING
chat
TYPE: STRING
uid
TYPE: INTEGER
invalid input or request body
error
TYPE: OBJECT
code
TYPE: INTEGER
message
TYPE: STRING
forbidden if whiteboard isnt setup for your project
error
TYPE: OBJECT
code
TYPE: INTEGER
message
TYPE: STRING
not found if passphrase is invalid
error
TYPE: OBJECT
code
TYPE: INTEGER
message
TYPE: STRING
internal server error
error
TYPE: OBJECT
code
TYPE: INTEGER
message
TYPE: STRING
SAMPLE RESPONSE
{
  "title": "YLUStods7dUIBqr_WjhUCNQYVi?fFZI5",
  "isHost": "boolean",
  "secret": "YLUStods7dUIBqr_WjhUCNQYVi?fFZI5",
  "secretSalt": " 4toOwMl12wdIbFWnYjCv06y4g+CXwCi1jFrmWU5x5SA=",
  "mainUser": {
    "rtc": "rtc-token",
    "rtm": "rtm-token",
    "chat": "chat-token",
    "uid": "integer"
  },
  "screenShare": {
    "rtc": "rtc-token",
    "rtm": "rtm-token",
    "chat": "chat-token",
    "uid": "integer"
  }
}
SAMPLE RESPONSE
{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}
SAMPLE RESPONSE
{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}
SAMPLE RESPONSE
{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}
SAMPLE RESPONSE
{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}
Loading...