join an agora channel

post/v1/channel/join

post/v1/channel/join

https://managedservices-prod.rteappbuilder.com/

Request

HEADER

AuthorizationREQUIRED

TYPE: STRING

JWT token as auth header

REQUEST BODY

request to join an agora channel

passphrase

TYPE: STRING

SAMPLE REQUEST
{
  "passphrase": "string"
}

Responses

success

channel_name

TYPE: STRING

title

TYPE: STRING

is_host

TYPE: BOOLEAN

secret

TYPE: STRING

chat

TYPE: OBJECT

isGroupOwner

TYPE: BOOLEAN

groupId

TYPE: STRING

userToken

TYPE: STRING

error

TYPE: OBJECT

code

TYPE: STRING

message

TYPE: STRING

secret_salt

TYPE: STRING

main_user

TYPE: OBJECT

rtc

TYPE: STRING

rtm

TYPE: STRING

uid

TYPE: INTEGER

screen_share_user

TYPE: OBJECT

rtc

TYPE: STRING

rtm

TYPE: STRING

uid

TYPE: INTEGER

whiteboard

TYPE: OBJECT

room_token

TYPE: STRING

room_uuid

TYPE: STRING

error

TYPE: OBJECT

code

TYPE: STRING

message

TYPE: STRING

SAMPLE RESPONSE
{
  "channel_name": "string",
  "title": "my first channel",
  "is_host": "boolean",
  "secret": "string",
  "chat": {
    "isGroupOwner": "boolean",
    "groupId": "string",
    "userToken": "string",
    "error": {
      "code": 2004,
      "message": "service unavailable"
    }
  },
  "secret_salt": "string",
  "main_user": {
    "rtc": "string",
    "rtm": "string",
    "uid": "integer"
  },
  "screen_share_user": {
    "rtc": "string",
    "rtm": "string",
    "uid": "integer"
  },
  "whiteboard": {
    "room_token": "string",
    "room_uuid": "string",
    "error": {
      "code": 2004,
      "message": "service unavailable"
    }
  }
}

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."
  }
}