文档首页/ 华为云会议 Meeting/ 服务端API参考/ 会议管理/ 接口参考/ 查询在线会议与会者信息
更新时间：2024-12-19 GMT+08:00
查看PDF
分享

查询在线会议与会者信息

描述

该接口用于查询指定会议的在线与会者信息。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/mmc/management/conferences/online/conf-attendee

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

X-Access-Token

是

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

conf_id

是

String

Query

会议ID。

offset

否

Integer

Query

记录数偏移.默认为0。

limit

否

Integer

Query

返回的与会者记录数。默认是20, 最大500条。

search_key

否

Integer

Query

查询条件,支持name、call_number、third_account查询。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

data

Array of OnlineAttendeeRecordInfo objects

在线与会者信息列表。

offset

Integer

记录数偏移,第几条。

limit

Integer

每页的记录数。

count

Integer

总记录数
表5 OnlineAttendeeRecordInfo 数据结构

参数

类型

描述

participant_id

String

与会者标识。

name

String

与会者名称。

call_number

String

呼叫号码。

role

Integer

会议中的角色,枚举值如下: 1:会议主席 0:普通与会者。

third_account

String

开放性场景标识第三方账号信息。

account

String

用户账号。

user_id

String

用户UUID。

请求消息示例

GET /v1/mmc/management/conferences/online/conf-attendee?conf_id=964138987&search_key=wu
Connection: keep-alive
X-Access-Token: *******
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200 OK
X-Request-Id: 0905d26b-8de3-42f3-8a35-e8cff505ea74
Pragma: no-cache
Cache-Control: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
X-Xss-Protection: 1; mode=block
X-Download-Options: noopen
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Frame-Options: SAMEORIGIN
Content-Security-Policy: connect-src 'self' *.huaweicloud.com ;style-src 'self' 'unsafe-inline' 'unsafe-eval';object-src 'self'; font-src 'self' data:;
Vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers
Etag: "0765cdce0f557b279da32b567609d4ba5"
Content-Type: application/json;charset=UTF-8
Content-Length: 17
Date: Thu, 14 Nov 2024 02:19:47 GMT
X-Envoy-Upstream-Service-Time: 123
Server: istio-envoy

{
    "in_conf": true,
    "conf_id": "969647670"
}

错误码

当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。

CURL命令示例

curl -k -i -X GET  -H "X-Access-Token:******"  https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/online/conf-attendee?conf_id=964138987&search_key=wu

父主题： 接口参考

相关文档