批量查询会议账号
更新时间: 2024/07/24 10:02:27
通过该接口批量查询一个或多个视频会议账号的信息。
请求信息
- 请求方法:GET
- 请求 URL:https://meeting.yunxinroom.com/scene/meeting/api/v2/batch-get-user?userUuids=user_uuid_sample1,user_uuid_sample2 HTTP/1.1
- Content-Type:application/json;charset=utf-8
- AppKey:应用的 AppKey。详情请参考 创建应用并获取 AppKey。
- 鉴权头:接口鉴权。详情请参考 请求结构。
请求头参数
请求头(Header)的参数说明,请参考 请求结构。
路径参数
URL 里的请求参数,而不是 Body。
名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
userUuids | String Array | 是 | 用户账号数组。 |
请求路径示例
HTTPhttps://meeting.yunxinroom.com/scene/meeting/api/v2/batch-get-user?userUuids=user_uuid_sample1,user_uuid_sample2
响应信息
响应参数
以下是返回结果(Body)中 data
属性内包含的参数。有关统一返回参数的说明,请参考 返回结果。
名称 | 类型 | 说明 |
---|---|---|
notFoundUserUuids | JsonArray | 不存在的账号,包括被注销的账号。 |
userInfos | JsonArray | 查询到的账号信息列表。 |
userInfos.userUuid | String | 用户账号。 |
userInfos.name | String | 用户名称,即账号使用者的姓名,称呼,昵称等。 |
userInfos.userToken | String | 用户账号登录令牌 Token。 |
userInfos.privateMeetingNum | String | 个人会议唯一号,全局唯一。 |
userInfos.shortMeetingNum | String | 个人会议短号。 |
userInfos.sipCid | String | 企业内 SIP 号。 |
userInfos.avatar | String | 存储头像图案的 URL。 |
userInfos.phoneNumber | String | 手机号码。 |
userInfos.email | String | 邮箱地址。 |
userInfos.state |
Integer |
|
userInfos.departments |
JsonArray |
用户所在的部门路径列表,最多支持 20 级。 示例:["一级部门 1,二级部门 1"]。 |
响应体示例
JSON{
"notFoundUserUuids":["some_not_found_user_uuid"],
"userInfos"[
{
"userUuid": "user_uuid_sample",
"userToken": "user_token_sample",
"name": "someone_name",
"privateMeetingNum": "private_meeting_number_sample",
"shortMeetingNum": "short_meeting_number_sample",
"sipCid": "sip_cid_sample",
"avatar": "https://sample.com/sample_url_path",
"phoneNumber": "13912341234",
"email": "someone@example.com",
"state": 1,
"departments":["/一级部门/二级部门"]
}
]
}
错误码
详情请参考 错误码。
此文档是否对你有帮助?