智慧服务,成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 会议控制 > 接口参考 获取会控Token

入门使用

获取会控Token

更新时间:2019-11-19

描述

通过该接口获取会控授权令牌,然后会议会被拉起。

接口原型

表1 接口原型

请求方法

GET

请求地址

/conferences/{confID}/token

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

confID

String

URL

会议ID。

tmpToken

String

URL

终端获取会控Token所用的临时Token。

该tmpToken从SIP INFO中获取。

Conference-Authorization

String

Header

如果携带该值,则表示是保活消息,如果会话已过期并且请求中携带了密码,则进行重新鉴权并回复新的会话标识。

该头域统一为BASE64编码。

password

String

Header

会议的主席密码。

通过会议管理接口的返回响应参数PasswordEntry获取。

对于会控Token保活场景,可以不携带会议密码。

loginType

Int

Header

区分请求类型。

  • 0:终端请求
  • 1:CloudPortal请求

响应参数

表3 参数说明

参数

类型

描述

returnCode

Int

返回码。

returnDesc

String

返回描述。

data

tokenInfo

Token信息。

addressToken

String

地址本查询临时Token。

表4 tokenInfo 数据结构

参数

类型

描述

token

String

会控鉴权Token。

说明:

使用会控鉴权Token时,需要对token进行Base64转码

样例:1)比如获取token为token528d916cb482959860b70f1190c8b67024a0faf693553c3a

2)然后转成Base64后为Basic dG9rZW41MjhkOTE2Y2I0ODI5NTk4NjBiNzBmMTE5MGM4YjY3MDI0YTBmYWY2OTM1NTNjM2E=

tmpWsToken

String

websocket建链鉴权Token,成功时必带。

wsURL

String

websocket建链URL。

role

Int

会议中的角色。

  • 1:会议主席
  • 0:普通与会者

expireTime

Long

会话过期时间。UTC时间毫秒数。

userID

String

用户ID。

orgID

String

组织ID。

请求消息示例

GET /conferences/914021994/token
Connection: keep-alive
password: *******
loginType: 1
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
 

响应消息示例

HTTP/1.1 200 
Date: Mon, 11 Mar 2019 08:49:53 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

{
    "returnCode": 0,
    "returnDesc": "Success",
    "data": {
        "token": "token528d916cb482959860b70f1190c8b67024a0faf693553c3a",
        "tmpWsToken": "0e23af8743d711e9b6b51bd15bad5803",
        "wsURL": "wss://nmeeting.huaweicloud.com:443",
        "role": 1,
        "expireTime": 1552294454574,
        "userID": "user02",
        "orgID": "41916"
    },
    "addressToken": "M1dnUTNxQVhva3dmRXVlNVVNaGhrVDlJYXNndjBmZnJY"
}
 

CURL命令示例

curl -k -i -X GET -H 'loginType: 1' -H 'password: ******' 'https://api.meeting.huaweicloud.com/conferences/914010951/token'