文档首页/ 华为云会议 Meeting/ 服务端API参考/ 会议控制/ 接口参考/ 获取会控Token
更新时间：2024-01-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取会控Token

描述

该接口用于获取正在召开会议的会控Token（未开始的会议调用该接口返回失败）。Token有效期是半个小时。

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/mmc/control/conferences/token

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conferenceID

是

String

Query

会议ID。

说明：

创建会议时返回的conferenceID。不是vmrConferenceID。

X-Conference-Authorization

否

String

Header

会控Token。

说明：
  • 仅会控Token保活场景需要携带
  • 如果会话已过期并且请求中携带了密码，则进行重新鉴权并回复新的会控Token

X-Password

是

String

Header

会议的主持人密码。

说明：

对于会控Token保活场景，不对主持人密码鉴权。

X-Login-Type

是

Integer

Header

请求类型。

  • 1：固定为1。

X-Nonce

否

String

Header

用户临时nonce token。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

data

data object

会控Token信息。

addressToken

String

企业通讯录查询临时Token。

gloablPublicIP

String

华为云会议Portal地址。
表5 data数据结构说明

参数

类型

描述

token

String

会控Token。有效期半个小时。

说明：

会控Token支持两种使用方式：

  • 后续所有会控接口，都可以直接使用该token，如：X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb。
  • 使用Base64转码使用，转码格式，Basic空格+Base64(token)，示例如下：X-Conference-Authorization:Basic Y25yYjQyNmNhMzgyMWY4YTE4ZTc4ZDU5ZGE1NzJhNDIxNjQ0YzUyZGZkOWE0NzMwMjk4。

tmpWsToken

String

会控WebSocket建链鉴权Token。

wsURL

String

会控WebSocket建链URL。

role

Integer

会议中的角色。

  • 0 ：普通与会者
  • 1 ：会议主持人

expireTime

long

会控Token过期时间戳（单位：毫秒）。

userID

String

会议预定者的用户UUID。

orgID

String

会议所属企业ID。

participantID

String

终端请求时，返回终端入会后会场ID。

说明：

该参数将废弃，请勿使用。

confTokenExpireTime

Integer

会控Token有效时长（单位秒）。

vmrCurrentConfID

String

云会议室会议的当前会议ID。

supportNotifyType

Array of strings

会控WebSocket消息推送支持类型。

请求消息示例

GET /v1/mmc/control/conferences/token?conferenceID=914083901
Connection: keep-alive
X-Password: *******
X-Login-Type: 1
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 337
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 630c3bc684928cfa780860fe6a14f38f
Server: api-gateway
X-Request-Id: d689482097c019094f8aa41e57e52e8e

{
    "data": {
        "token": "stb15afe94b97a5cd7f152d5308c420dbdce85beda4a3b39f26",
        "tmpWsToken": "stba0a69f40a78e50f3789e72386f7da84809fbc86a1400bea5",
        "wsURL": "wss://119.3.200.83:443",
        "role": 1,
        "expireTime": 1576651143250,
        "userID": "ff808081699b56cb0169be103500012b",
        "orgID": "15659",
        "confTokenExpireTime": 1800,
        "vmrCurrentConfID": "914083901",
        "supportNotifyType": [
            "INCREMENT"
        ]
    },
    "addressToken": "stbWdPZ2ooVesQTWqZESu7AjVlH9Pv4O1KcQ",
    "gloablPublicIP": "meeting.huaweicloud.com"
}

错误码

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

CURL命令示例

curl -k -i -X GET -H 'X-Login-Type: 1' -H 'X-Password: ******' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/token?conferenceID=914083901'
父主题： 接口参考