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

查询网络研讨会高级设置

描述

该接口用于查询指定网络研讨会的高级设置。管理员可查询企业内的网络研讨会高级设置,非管理员只可查询自己预定的网络研讨会的高级设置。

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/wss/webinar/open/room-setting/{conference_id}

传输协议

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。

conference_id

String

Path

网络研讨会ID。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

roomIntroduce

String

网络研讨会介绍。

cropLogoId

String

企业Logo的文件id。

coverPictureId

String

欢迎界面的文件id。

showAudienceMode

String

显示观众人数的模式。默认为real_time。

  • none: 不显示
  • real_time: 实时显示

isRedoubleOpen

String

智能倍增开关。默认值为Y。

  • Y:开启智能倍增
  • N:关闭智能倍增

baseAudienceCount

Integer

基础设置人数(网络研讨会没人时显示的人数)。默认值为0。

取值范围为[0, 10000]。

multiple

Double

设置倍数(基础人数+真实人数*倍数)。默认值为1.0。

取值范围为[0, 10],取1位小数。

请求消息示例

GET /v1/wss/webinar/open/room-setting/984555800 HTTP/1.1
Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com
User-Agent: APIGatewayDebugClient/1.0
X-Access-Token: cnr1519y4i5r5ikKZYTGqR5b2ybEJORGdm3EcPzU
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: Mon, 17 May 2021 08:43:11 GMT
Pragma: no-cache
Server: api-gateway
Strict-Transport-Security: max-age=16070400; includeSubDomains
X-APIG-Latency: 85
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: 84
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Envoy-Upstream-Service-Time: 59
X-Frame-Options: SAMEORIGIN
X-Request-Id: 48e47dc2e65e3bf85e00a60e2cba5ce7
X-Xss-Protection: 1;mode=block

{"roomIntroduce":"直播间简介","cropLogoId":"76D356E93FA849C7987983EEAB94F4BE","coverPictureId":"D8879E453B8F4277B95864A147B2F3C5","showAudienceMode":"real_time","isRedoubleOpen":"N","baseAudienceCount":0,"multiple":1.0}

错误码

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

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token:cnr1519y4i5r5ikKZYTGqR5b2ybEJORGdm3EcPzU' https://api.meeting.huaweicloud.com/v1/wss/webinar/open/room-setting/984555800

相关文档