创建会议账号
更新时间: 2024/07/24 10:00:39
通过该接口创建一个会议账号,客户端需要使用返回的账户 ID 和 Token 进行登录鉴权。
- 如果您之前没有 IM 账号,创建会议账号时,会自动创建和会议账号绑定的 IM 账号。
- 如果您已经集成了云信 IM SDK,已有云信的 IM 账号,您可以调用该接口创建一个与 IM 账号绑定的会议账号。
- 如果需要绑定已有的 IM 账号,请先获得
imAccid
和imToken
的值。获取方式请参考注册云信 IM 账号。
功能原理
sequenceDiagram
autonumber
participant App
participant AppServer
participant NEMeetingKit
participant NEMeetingServer
Note over App, NEMeetingServer: 创建会议账号
App->>AppServer: 创建会议账号
AppServer->>NEMeetingServer: 创建会议账号
NEMeetingServer->>NEMeetingServer: 创建会议账号
NEMeetingServer-->>AppServer: 返回会议账号(userUuid)和Token(userToken)
AppServer-->>App: 返回会议账号(userUuid)和Token(userToken)
Note over App, NEMeetingServer: 登录鉴权
App->>NEMeetingKit: 请求登录,传入accountId和accountToken
NEMeetingKit->>NEMeetingServer: 校验 Token
NEMeetingServer-->>NEMeetingKit:校验 Token 成功,返回成功的回调
NEMeetingKit-->>App: 返回成功的回调
接口请求信息
- 请求方法:PUT
- URL:https://roomkit.netease.im/scene/meeting/api/{appId}/v1/account/create
- Content-Type:application/json;charset=utf-8
URL 中参数说明:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
appId | String | 必选 | abcdefg**** | 应用的 App Key。 |
请求参数
-
请求中 Header 的设置请参考请求结构描述。
-
请求中 Body 须为 JSON 格式,参数说明如下:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
imAccid | String | 可选 | abcdefg**** | 该会议账号对应的 IM 的用户 ID,用于登录 IM。
|
imToken | String | 可选 | qwer**** | 该会议账号对应的 IM 的 Token,用于登录 IM。
|
shortMeetingNum | String | 可选 | 1234 | 个人会议短号。长度为 4 ~ 8 位。 |
nickname | String | 可选 | zhangsan | 该会议账号在会议中的昵称。 |
返回参数
以下是返回结果中 data
属性内包含的参数。其他统一返回参数的相关说明请参考返回结果。
参数 | 类型 | 示例 | 描述 |
---|---|---|---|
userUuid | String | abcdef**** | 会议组件的用户 ID。 客户端使用对应的会议账号登录 NEMeetingKit 时,在 accountId 中请传入该返回值。 |
userToken | String | qwer**** | 会议组件的 Token。 客户端使用对应的会议账号登录 NEMeetingKit 时,在 accountToken 中请传入该返回值。此 Token 为永久静态 Token。 |
nickname | String | netease | 用户昵称。 |
privateMeetingNum | String | 6568846412 | 个人会议的会议码。 |
shortMeetingNum | String | 1234 | 个人会议短号。 |
settings | Object | {} | 会议配置参数,返回空。保留字段,在创建账号的接口中无实际含义。 |
示例
请求 Body 示例
json{
"imAccid": "abcdefg****",
"imToken": "qwer****"
}
返回示例
{
"userUuid": "abcdefg****",
"userToken": "1234****",
"nickname": "netease",
"privateMeetingNum": "6568846412",
"shortMeetingNum": "1234",
"settings": {}
}
此文档是否对你有帮助?