更新时间:2022-05-05 GMT+08:00
分享

查询网络研讨会详情

描述

用户通过该接口查询预订的网络研讨会详情。

SLA

请求成功率:>99.99%

TP99请求时延:100ms

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/wss/webinar/open/conferences/{conference_id}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conference_id

String

Path

网络研讨会ID。

X-Access-Token

String

Header

token鉴权。获取执行App ID鉴权响应的accessToken。

X-Request-Id

String

Header

请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用uuId,若不携带,则后台自动生成。

Accept-Language

String

Header

语言参数,默认为中文zh-CN,英文为en-US。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常,响应消息参考 AbnormalResultDTO

响应参数

表4 响应参数

参数

类型

描述

conferenceId

String

网络研讨会ID,长度限制为32个字符。

corpId

String

企业ID

subject

String

会议主题。长度限制为128个字符。

description

String

描述

startTime

String

预订会议开始时间,格式“yyyy-MM-dd HH:mm”(UTC时间)。

duration

Integer

预订会议持续时长,单位分钟

timeZoneId

Integer

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

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

state

String

会议状态。schedule:预定状态;created:会议已经被创建并正在召开;destroyed:会议已经关闭

scheduserId

String

网络研讨会预订者ID

deptName

String

预订人部门

scheduserName

String

会议预订者帐号名称。长度最大限制为96个字符.

vmrPkgName

String

网络研讨会vmr资源名(最大64个字符)

callRestriction

Boolean

入会范围开关

scope

Integer

主持人、嘉宾入会范围 0: 所有用户 1: 非匿名用户(手机pstn入会视为匿名入会) 2: 企业内用户 3: 被邀请用户

audienceScope

Integer

观众入会范围 0: 所有用户 2: 企业内用户和被邀请用户

chairJoinUri

String

主持人入会地址

chairPasswd

String

主持人入会密码

guestJoinUri

String

嘉宾入会地址

guestPasswd

String

嘉宾入会密码

audienceJoinUri

String

观众入会地址

audiencePasswd

String

观众入会密码

attendees

Array of strings

与会嘉宾列表

notifySetting

NotifySetting object

通知信息配置

请求消息示例

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/f78c393cad974a812828342da591f11cab00da91a2c43c3d",
	"chairPasswd": "116817",
	"guestJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/8e057f959576587f9778a65a16a28a89be7a50793d10014d",
	"guestPasswd": "352218",
	"audienceJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/aab78ec3fffcf54313802455d58449efa9617824aac4d7e5",
	"audiencePasswd": "441168",
	"language": "en-US",
	"notifySetting": {
		"enableCalendar": "N",
		"enableSms": "N",
		"enableEmail": "N"
	},
	"attendees": ["user"]
}

错误码

当您使用华为云会议服务端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
分享:

    相关文档

    相关产品

关闭导读