查询网络研讨会详情
描述
该接口用于查询指定网络研讨会的详情。
调试
您可以在API Explorer中直接运行调试该接口。
接口原型
|
请求方法 |
GET |
|---|---|
|
请求地址 |
/v1/wss/webinar/open/conferences/{conference_id} |
|
传输协议 |
HTTPS |
请求参数
|
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
conference_id |
是 |
String |
Path |
网络研讨会ID。 |
|
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
|
X-Request-Id |
否 |
String |
Header |
请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 |
|
Accept-Language |
否 |
String |
Header |
语言参数，默认为中文zh-CN，英文为en-US。 |
状态码
|
HTTP状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
参数异常。 |
|
401 |
未鉴权或鉴权失败。 |
|
403 |
权限受限。 |
|
500 |
服务端异常。 |
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
conferenceId |
String |
网络研讨会ID。 |
|
corpId |
String |
企业ID。 |
|
subject |
String |
会议主题。长度限制为128个字符。 |
|
description |
String |
网络研讨会主题。 |
|
startTime |
String |
网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 |
|
duration |
Integer |
网络研讨会持续时长，单位分钟，取值范围[15,1440]。 |
|
timeZoneId |
Integer |
会议通知中会议时间的时区信息。时区信息，参考时区映射关系。
说明：
|
|
state |
String |
会议状态。
|
|
scheduserId |
String |
网络研讨会预订者的用户UUID。 |
|
deptName |
String |
预订者部门命名。 |
|
scheduserName |
String |
预订者名称。 |
|
vmrPkgName |
String |
网络研讨会VMR名称。 |
|
callRestriction |
Boolean |
入会范围开关。 |
|
scope |
Integer |
主持人、嘉宾入会范围。
|
|
audienceScope |
Integer |
观众入会范围。
|
|
chairJoinUri |
String |
主持人入会地址。 |
|
chairPasswd |
String |
主持人入会密码。 |
|
guestJoinUri |
String |
嘉宾入会地址。 |
|
guestPasswd |
String |
嘉宾入会密码。 |
|
audienceJoinUri |
String |
观众入会地址。 |
|
audiencePasswd |
String |
观众入会密码。 |
|
attendees |
Array of strings |
与会嘉宾名称列表。 |
|
notifySetting |
NotifySetting object |
网络研讨会通知配置。 |
|
enableRecording |
String |
录制是否开启。
|
|
liveAddress |
String |
主流直播推流地址。仅设置liveAddress，未设置auxAddress，无人共享时直播画面显示演讲者视图，有人共享时直播画面显示共享屏幕视图。若同时设置了liveAddress和auxAddress，liveAddress对应直播画面显示演讲者视图，auxAddress对应直播画面显示共享屏幕视图。 |
|
auxAddress |
String |
auxAddress对应辅流直播推流地址，在设置liveAddress后如果设置了auxAddress，liveAddress对应直播画面显示演讲者视图，auxAddress对应直播画面显示共享屏幕视图。 |
|
liveUrl |
String |
直播观看地址。 |
请求消息示例
GET /v1/wss/webinar/open/conferences/982311022 HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 X-Access-Token: cnr1519GbhwxP6eXPT70gHBabwCoAnFHezYAln4F 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, 23 Apr 2021 07:44:58 GMT
Pragma: no-cache
Server: api-gateway
Strict-Transport-Security: max-age=16070400; includeSubDomains
X-APIG-Latency: 87
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: 32
X-Frame-Options: SAMEORIGIN
X-Request-Id: 11379ed26a172206cf67e6288b0d73db
X-Xss-Protection: 1;mode=block
{
"conferenceId": "982311022",
"corpId": "314765464",
"subject": "网络研讨会",
"description": "",
"startTime": "2021-04-29 11:00",
"duration": 120,
"timeZoneId": 56,
"state": "schedule",
"scheduserId": "bb05917f7363407ea6b1df019fdf257a",
"scheduserName": "user",
"vmrPkgName": "网络研讨会_1000方观众",
"callRestriction": false,
"scope": 0,
"audienceScope": 0,
"chairJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/f78c***************************************43c3d",
"chairPasswd": "********",
"guestJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/8e05****************************************014d",
"guestPasswd": "********",
"audienceJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/aab7*************************************4d7e5",
"audiencePasswd": "*********",
"notifySetting": {
"enableCalendar": "N",
"enableSms": "N",
"enableEmail": "N"
},
"attendees": ["user"],
"enableRecording": "Y"
}
错误码
当您使用华为云会议服务端API时，如果遇到“WSS”开头的错误码，请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token:cnr1519GbhwxP6eXPT70gHBabwCoAnFHezYAln4F' https://api.meeting.huaweicloud.com/v1/wss/webinar/open/conferences/982311022
