更新时间:2023-12-29 GMT+08:00

企业管理员生成激活码

描述

企业管理员生成智慧屏、电子白板(SmartRooms)、Ideahub的激活码。

调试

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

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/usg/dcs/corp/vision/activecode

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

X-Access-Token

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Request-Id

String

Header

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

Accept-Language

String

Header

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

country

String

Body

手机号所属的国家

默认值:chinaPR。

maxLength:255

minLength:0

deptCode

String

Body

部门编码,若不携带则默认根部门。

description

String

Body

描述信息。

devName

String

Body

终端的名称。

devType

String

Body

终端类型。

  • idea-hub:智能协作大屏
  • huawei-vision:智慧屏TV
  • welink-desktop(iwb):SmartRooms会议版
  • smart-rooms:SmartRooms完整版

emailAddr

String

Body

邮箱地址。

说明:

如无中国大陆手机号,则邮箱必填。

smsNumber

String

Body

号码信息,如果为手机号,必须加上国家码,当前仅支持中国大陆手机号。

例如中国大陆手机+86xxxxxxx,当填写手机号时 “country”参数必填,手机格式必须满足(^$|^[+]?[0-9]+$)。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

activeCode

String

激活码。

请求消息示例

POST /v1/usg/dcs/corp/vision/activecode
Connection: keep-alive
X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD
content-type: application/json
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191))

{
    "country": "chinaPR",
    "deptCode": "1",
    "description": "测试终端",
    "devName": "test_device",
    "devType": "idea-hub",
    "emailAddr": "******",
    "smsNumber": "+86173****9092"
}

响应消息示例

HTTP/1.1 200 
Date: Mon, 13 Jul 2020 02:20:32 GMT
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 5032547386ab1e2e6a24842e9e1abea9

{
    "activeCode": "085***642"
}

错误码

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

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD' -d '{"country": "chinaPR","deptCode": "1","description": "测试终端","devName": "test_device","devType": "idea-hub","emailAddr": "******","smsNumber": "+86173****9092"}'
https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/vision/activecode