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

修改终端

描述

企业管理员通过该接口修改专业会议终端。

如果需要修改IdeaHub、SmartRooms、智慧屏TV请使用“修改用户”接口。

调试

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

接口原型

表1 接口原型

请求方法

PUT

请求地址

/v1/usg/dcs/corp/device/{sn}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

sn

String

Path

终端SN号,仅可包含数字、字母和下划线。

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。

deptCode

String

Body

部门编码,默认为根部门。

默认值:1

description

String

Body

终端描述。

maxLength:128

minLength:0

email

String

Body

统一邮箱格式。

name

String

Body

终端名称,建议为具体位置。

maxLength:64

minLength:0

phone

String

Body

手机号,必须加上国家码。

例如中国大陆手机为“+86xxxxxxxxxxx”,当填写手机号时 “country”参数必填。

手机号只允许输入纯数字。

说明:

手机号或者邮箱至少填写一个。

prjCodeMode

Integer

Body

投影码生成模式。

  • 0:自动

    该模式下根据消息上报的IP地址内部控制复杂度。私网地址配置成简单模式,公网地址配置成复杂模式。

  • 1:简单
  • 2:复杂

status

Integer

Body

终端状态。

  • 0:正常
  • 1:冻结

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

请求消息示例

PUT /v1/usg/dcs/corp/device/asdasfscasd
Connection: keep-alive
X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF
Content-Type: application/json
Content-Length: 198
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "name": "test",
    "deptCode": "1",
    "email": "******",
    "country": "chinaPR",
    "description": "test",
    "status": 0
}

响应消息示例

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

错误码

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

CURL命令示例

curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF'  -d '{"model": "TE20","name": "test","deptCode": "1","email": "******","country": "chinaPR","description": "test","status": 0}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device/asdasfscasd