加入会话

POST

/rsc/api/v2/user/sessions/actions/join

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

Body 参数application/json

示例

{
    "sessionInfo": {
        "topic": "string",
        "code": "string",
        "password": "string"
    },
    "mediaOpts": {
        "isVideoMute": true,
        "isAudioMute": true
    },
    "endpointInfo": {
        "nickname": "string",
        "headImage": "string",
        "deviceSn": "UUID.randomUUID().toString()",
        "endpointId": "string",
        "extState": {},
        "deviceId": "string"
    },
    "context": {
        "callId": "string"
    },
    "returnEndpointSize": 20
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/rsc/api/v2/user/sessions/actions/join' \
--header 'x-endpoint-id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sessionInfo": {
        "topic": "string",
        "code": "string",
        "password": "string"
    },
    "mediaOpts": {
        "isVideoMute": true,
        "isAudioMute": true
    },
    "endpointInfo": {
        "nickname": "string",
        "headImage": "string",
        "deviceSn": "UUID.randomUUID().toString()",
        "endpointId": "string",
        "extState": {},
        "deviceId": "string"
    },
    "context": {
        "callId": "string"
    },
    "returnEndpointSize": 20
}'

返回响应

🟢201成功

application/json

Body

示例

{
  "meetingId": 0,
  "sdp": "",
  "endpoint": {
    "nickname": "",
    "avatar": "",
    "isMaster": false,
    "isAudioMute": false,
    "isVideoMute": false,
    "isSpeakRequest": false,
    "isSpeakerMute": false,
    "isLocalRecording": false,
    "isRejoin": false,
    "id": "",
    "userId": "",
    "deviceId": "",
    "createdTime": "",
    "updatedTime": "",
    "lastJoinTime": 0,
    "mediaOpts": {
      "audiossrc": "",
      "videossrc": [
        ""
      ],
      "sharessrc": "",
      "extState": {}
    },
    "role": {
      "type": 0,
      "reason": 0,
      "updatedTime": "",
      "permissions": [
        ""
      ],
      "from": {
        "endpointId": "",
        "userId": "",
        "deviceId": ""
      }
    },
    "permissions": [
      ""
    ],
    "speakRequestTime": "",
    "osType": "",
    "platformType": "",
    "identifier": "",
    "multiStreamInfo": {},
    "displayStatus": 0,
    "videoSourceLocked": false,
    "audioGain": 0
  },
  "serverOpts": {
    "socketUrl": "",
    "socketNsp": "",
    "dataServer": "",
    "pushUrl": "",
    "audioPullUrl": ""
  },
  "session": {
    "id": "",
    "code": "",
    "topic": "",
    "duration": 0,
    "password": "",
    "activated": false,
    "createdTime": "",
    "updatedTime": "",
    "owner": {
      "userId": "",
      "deviceId": "",
      "companyId": ""
    },
    "layout": {
      "id": "",
      "content": ""
    },
    "virtualRoom": {
      "isUsed": false,
      "id": 0,
      "code": "",
      "name": "",
      "password": "",
      "type": 0,
      "option": {
        "changeNameEnable": false,
        "unmuteSelfEnable": false,
        "muted": false,
        "whiteBoardOption": 0,
        "shareOption": 0,
        "markOption": 0,
        "maxEndpointCount": 0,
        "masterPassword": "",
        "masterPasswordTimes": 0,
        "joinPermissionRange": {
          "type": 0,
          "users": [
            {
              "userId": "",
              "deviceId": "",
              "companyId": "",
              "name": "",
              "identifier": "",
              "type": 0
            }
          ]
        },
        "allowJoinBeforeMaster": false,
        "autoMuteType": 0,
        "recordOption": {
          "autoStartRecord": false
        },
        "autoCallEnabled": false
      },
      "owner": {
        "userId": "",
        "deviceId": "",
        "companyId": ""
      }
    },
    "mediaCapabilityOptions": [
      {
        "alias": "",
        "optionValue": ""
      }
    ],
    "options": {
      "locked": false,
      "unmuteSelfEnabled": false,
      "allowSelfChangeNickname": false,
      "muted": false,
      "whiteBoardOption": 0,
      "shareOption": 0,
      "markOption": 0,
      "turnOnVideoSelfEnabled": false,
      "autoMuteType": 0,
      "endpointStatusUpdateNoticeType": 0,
      "voiceActivationEnabled": false
    },
    "mode": {
      "viewState": "",
      "presenter": "",
      "state": 0,
      "settings": {
        "requireWatermark": false
      }
    },
    "mainVenueId": "",
    "recordInfo": {
      "status": 0
    },
    "advancedFeatures": {
      "whiteboardType": ""
    },
    "endpoints": {
      "total": 0,
      "hasMore": false,
      "nextPageFirstJoinTime": 0,
      "data": [
        {
          "nickname": "",
          "avatar": "",
          "isMaster": false,
          "isAudioMute": false,
          "isVideoMute": false,
          "isSpeakRequest": false,
          "isSpeakerMute": false,
          "isLocalRecording": false,
          "isRejoin": false,
          "id": "",
          "userId": "",
          "deviceId": "",
          "createdTime": "",
          "updatedTime": "",
          "lastJoinTime": 0,
          "mediaOpts": {
            "audiossrc": "",
            "videossrc": [
              ""
            ],
            "sharessrc": "",
            "extState": {}
          },
          "role": {
            "type": 0,
            "reason": 0,
            "updatedTime": "",
            "permissions": [
              ""
            ],
            "from": {
              "endpointId": "",
              "userId": "",
              "deviceId": ""
            }
          },
          "permissions": [
            ""
          ],
          "speakRequestTime": "",
          "osType": "",
          "platformType": "",
          "identifier": "",
          "multiStreamInfo": {},
          "displayStatus": 0,
          "videoSourceLocked": false,
          "audioGain": 0
        }
      ]
    }
  },
  "features": {
    "whiteboardType": ""
  },
  "layout": {
    "id": "",
    "content": ""
  }
}

🟠403开启等候室异常

修改于 2025-06-05 02:04:46

关闭会话

隐身入会