更新时间:2023-12-18 GMT+08:00
分享

查询历史的网络研讨会列表

描述

该接口用于查询历史网络研讨会。管理员可查询企业内历史网络研讨会,非管理员可查询个人历史网络研讨会。

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/wss/webinar/open/conferences/history

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

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:按会议开始时间降序排序

startTime

String

Query

开始时间(UTC时间), 格式:yyyy-MM-dd HH:mm。

endTime

String

Query

结束时间(UTC时间), 格式:yyyy-MM-dd HH:mm。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

offset

Integer

偏移量。

limit

Integer

每页的记录数。

count

Integer

总记录数。

data

Array of OpenWebinarHistoryInfo objects

历史网络研讨会信息列表。

表5 OpenWebinarHistoryInfo 数据结构

参数

类型

描述

conferenceId

String

网络研讨会ID。

confUUID

String

网络研讨会UUID。

subject

String

网络研讨会主题。

scheduserName

String

预订者名称。

moderator

String

网络研讨主持人名称。

deptName

String

预订人部门名称。

startTime

String

网络研讨会开始时间(UTC时间),格式“yyyy-MM-dd HH:mm”。

timeZoneId

Integer

会议通知中会议时间的时区信息。时区信息,参考时区映射关系

说明:
  • 举例:“timeZoneID”:"26",则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。

duration

Integer

网络研讨会持续时长,单位分钟。

actualStartTime

String

网络研讨会实际召开时间(UTC时间),格式“yyyy-MM-dd HH:mm”。

endTime

String

网络研讨会结束时间(UTC时间),格式“yyyy-MM-dd HH:mm”。

actualDuration

Integer

网络研讨会实际时长,单位分钟。

attendeeCount

Integer

与会人数。

chairCount

Integer

主持人数。

guestCount

Integer

嘉宾数。

audienceCount

Integer

观众数。

vmrId

String

VMR ID。

vmrPkgName

String

网络研讨会VMR名称。

vmrPkgAudienceParties

Integer

网络研讨会VMR最大观众数。

请求消息示例

GET /v1/wss/webinar/open/conferences/history?endTime=2021-04-24%2023%3A59&limit=10&offset=0&startTime=2021-04-04%2000%3A01 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:27:12 GMT
Pragma: no-cache
Server: api-gateway
Strict-Transport-Security: max-age=16070400; includeSubDomains
X-APIG-Latency: 94
X-APIG-Ratelimit-Api: remain:98,limit:100,time:1 minute
X-APIG-Ratelimit-Api-Allenv: remain:199,limit:200,time:1 second
X-APIG-Upstream-Latency: 93
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Envoy-Upstream-Service-Time: 28
X-Frame-Options: SAMEORIGIN
X-Request-Id: 9329578a482d14b6eb8e96256c63f0dc
X-Xss-Protection: 1;mode=block
{
	"offset": 0,
	"limit": "10",
	"count": 2,
	"data": [{
		"conferenceId": "981177978",
		"confUUID": "04ec5f46a28211ebba1da504f475f24e",
		"subject": "网络研讨会",
		"scheduserName": "user",
		"moderator": "",
		"deptName": "dept",
		"timeZoneId": 56,
		"startTime": "2021-04-21 11:30:00",
		"duration": 120,
		"actualStartTime": "2021-04-21 09:14:47",
		"endTime": "2021-04-21 09:14:57",
		"actualDuration": 1,
		"attendeeCount": 0,
		"chairCount": 0,
		"guestCount": 0,
		"audienceCount": 0,
		"vmrId": "5f2ed435e37540d4bca01b42de7c2575",
		"vmrPkgAudienceParties": 3000,
		"vmrPkgName": "网络研讨会_1000方观众"
	},
	{
		"conferenceId": "980319792",
		"confUUID": "484f0c3e9d2611eb910121ad63dd9f60",
		"subject": "user2网络研讨会",
		"scheduserName": "user2",
		"moderator": "",
		"deptName": "dept",
		"timeZoneId": 56,
		"startTime": "2021-04-14 14:00:00",
		"duration": 15,
		"actualStartTime": "2021-04-14 13:35:31",
		"endTime": "2021-04-14 13:36:01",
		"actualDuration": 1,
		"attendeeCount": 0,
		"chairCount": 0,
		"guestCount": 0,
		"audienceCount": 0,
		"vmrId": "2c908f997544c76501754927728b0167",
		"vmrPkgAudienceParties": 1000,
		"vmrPkgName": "网络研讨会_1000方观众"
	}]
}

错误码

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

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token:cnr1519IZUrrVdIgql7TRJHRl6AfFOOKzkO9zmqJ' https://api.meeting.huaweicloud.com/v1/wss/webinar/open/conferences/history?endTime=2021-04-24%2023%3A59&limit=10&offset=0&startTime=2021-04-04%2000%3A01

相关文档