查询正在召开的网络研讨会列表 - ListOngoingWebinars

描述

该接口用于查询正在召开的网络研讨会。管理员可查询企业内正在召开网络研讨会，非管理员可查询自己预订的正在召开的网络研讨会。

调试

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

URI

GET /v1/wss/webinar/open/conferences/ongoing

请求参数

表1 参数说明
参数	是否必须	类型	位置	描述
X-Access-Token	是	String	Header	授权令牌。获取“执行App ID鉴权”响应的accessToken。
X-Request-Id	否	String	Header	请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。
Accept-Language	否	String	Header	语言参数，默认为中文zh-CN，英文为en-US。
offset	否	Integer	Query	查询偏移量,若超过最大数量，则返回最后一页的数据。默认为0。
limit	否	Integer	Query	查询数量。默认值：10。最大500条。
searchKey	否	String	Query	查询条件。支持主题/会议ID/创建人和资源搜索。
sortType	否	String	Query	查询结果排序。默认升序。 ASC_StartTIME：按会议开始时间升序排序 DSC_StartTIME：按会议开始时间降序排序

状态码

表2 状态码说明
HTTP状态码	描述
200	操作成功。
400	参数异常。
401	未鉴权或鉴权失败。
403	权限受限。
500	服务端异常。

响应参数

表3 响应参数
参数	类型	描述
offset	Integer	偏移量。
limit	Integer	每页的记录数。
count	Integer	总记录数。
data	Array of OpenWebinarOngoingInfo objects	正在网络召开研讨会信息列表。

表4 OpenWebinarOngoingInfo 数据结构
参数	类型	描述
conferenceId	String	网络研讨会ID。
confUUID	String	网络研讨会UUID。
corpId	String	企业ID。
subject	String	网络研讨会主题。
deptName	String	预订人部门名称。
description	String	网络研讨会描述。
startTime	String	网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。
timeZoneId	Integer	会议通知中会议时间的时区信息。时区信息，参考时区映射关系。说明：举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。
scheduserId	String	网络研讨会预订者的用户UUID。
scheduserName	String	预订者名称。
vmrPkgName	String	网络研讨会VMR名称。
chairJoinUri	String	主持人入会地址。
chairPasswd	String	主持人入会密码。
guestJoinUri	String	嘉宾入会地址。
guestPasswd	String	嘉宾入会密码。
audienceJoinUri	String	观众入会地址。
audiencePasswd	String	观众入会密码。
onlineAttendeeCount	Integer	实时在线人数。

请求消息示例

GET /v1/wss/webinar/open/conferences/ongoing?limit=10&offset=0&sortType=ASC_StartTIME HTTP/1.1
Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com
User-Agent: APIGatewayDebugClient/1.0
X-Access-Token: cnr1519IZUrrVdIgql7TRJHRl6AfFOOKzkO9zmqJ
X-APIG-Mode: debug

响应消息示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Connection: keep-alive
Content-Security-Policy: connect-src 'self' *.huaweicloud.com ;style-src 'self' 'unsafe-inline' 'unsafe-eval';object-src 'self'; font-src 'self' data:;
Content-Type: application/json; charset=UTF-8
Date: Fri, 30 Apr 2021 02:14:51 GMT
Pragma: no-cache
Server: api-gateway
Strict-Transport-Security: max-age=16070400; includeSubDomains
X-APIG-Latency: 88
X-APIG-Ratelimit-Api: remain:99,limit:100,time:1 minute
X-APIG-Ratelimit-Api-Allenv: remain:199,limit:200,time:1 second
X-APIG-Upstream-Latency: 86
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Envoy-Upstream-Service-Time: 25
X-Frame-Options: SAMEORIGIN
X-Request-Id: c56c59b8c68443fcf480c83a26424b7e
X-Xss-Protection: 1;mode=block
{
	"offset": 0,
	"limit": "10",
	"count": 1,
	"data": [{
		"onlineAttendeeCount": 1,
		"confUUID": "9cc9db0ba95911eba637897a0ff0f70e",
		"deptName": "dept",
		"conferenceId": "981326872",
		"corpId": "314765464",
		"subject": "网络研讨会",
		"startTime": "2021-04-30 02:13",
		"timeZoneId": 56,
		"scheduserName": "user",
		"vmrPkgName": "网络研讨会_1000方观众",
		"chairJoinUri": "https://meeting.huaweicloud.com/#/j/981326872/64368***************************************034f",
		"chairPasswd": "*******",
		"guestJoinUri": "https://meeting.huaweicloud.com/#/j/981326872/411ed***************************************a7fb",
		"guestPasswd": "*******",
		"audienceJoinUri": "https://meeting.huaweicloud.com/#/j/981326872/b08***************************************5d8",
		"audiencePasswd": "*******"
	}]
}

错误码

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

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token:cnr1519IZUrrVdIgql7TRJHRl6AfFOOKzkO9zmqJ' https://api.meeting.huaweicloud.com/v1/wss/webinar/open/conferences/ongoing?limit=10&offset=0&sortType=ASC_StartTIME

父主题：接口参考

上一篇：取消网络研讨会 - DeleteWebinar

下一篇：查询即将召开的网络研讨会列表 - ListUpComingWebinars