华为云会议 MEETING-执行App ID鉴权:请求参数

时间:2024-06-24 17:26:32

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Authorization

String

Header

携带应用鉴权信息。

  • 规则:HMAC-SHA256 signature=HexEncode(HMAC256((appId + ":" + userId + ":" + expireTime + ":" + nonce), appKey)),access=base64(appId)
  • 样例:HMAC-SHA256 signature=07f31aa9eafb06652c6899248b145c1a3264242e2ccf4c81b1b6eb99bb5c,access=ZmRiOGU0Njk5NTg2NDU4YmJkMTBjODM0ODcyZGNjNjI=
说明:

如携带了userId信息,则Body中,也需填写对应的userId信息。

(必填)鉴权头域携带access内容为对应颁发应用id进行base64编码。

X-Token-Type

String

Header

Token类型设置为:LongTicket

Content-Type

String

Header

Body的媒体格式。

  • 样例:application/json; charset=UTF-8

X-Request-ID

String

Header

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

Accept-Language

String

Header

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

appId

String

Body

App ID。如何获取App ID请参考“App ID的申请”。

clientType

Integer

Body

登录账号类型。

  • 72:API调用类型

corpId

String

Body

企业ID。

说明:
  • 当SP应用场景携带,如果corpId和userId字段未携带或值为空字符串时,当作SP默认管理员登录。
  • 仅在SP模式下需要填写,单企业模式不要填写,否则会鉴权失败。

expireTime

Long

Body

应用鉴权信息过期时间戳,单位秒。

说明:
  • 当收到App ID鉴权请求时服务端的Unix时间戳大于expireTime时,本次鉴权失败。
  • 样例:如果要求App ID鉴权信息10分钟后过期,expireTime = 当前Unix时间戳 + 60*10。
  • 如果要求应用鉴权信息始终不过期,expireTime = 0。

nonce

String

Body

随机字符串,用于计算应用鉴权信息。

minLength:32

maxLength:64

userEmail

String

Body

email地址。

userId

String

Body

第三方用户ID。

说明:

当userId字段未携带或值为空字符串时,当作企业默认管理员登录。

userName

String

Body

用户名称。

userPhone

String

Body

手机号,例如中国大陆手机+86xxxxxxx

deptCode

String

Body

部门编码。通过“查询部门及其一级子部门列表”接口获取。

support.huaweicloud.com/api-meeting/meeting_21_0311.html