增加终端

描述

企业管理员通过该接口添加专业会议终端。专业会议终端包括DP300/HUAWEI Bar系列/HUAWEI Board/TE系列。

调试

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

接口原型

表1 接口原型
请求方法	POST
请求地址	/v1/usg/dcs/corp/device
传输协议	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。
deptCode	否	String	Body	部门编码，默认为根部门。默认值：1
description	否	String	Body	终端描述。 maxLength：128 minLength：0
email	否	String	Body	统一邮箱格式。
model	是	String	Body	终端型号，枚举类型。当前支持TE系列和部分第三方硬件终端，具体的终端类型可以通过获取所有终端类型接口查询。
name	是	String	Body	终端名称，可以自定义，建议为具体位置，方便识别。 maxLength：64 minLength：1
phone	否	String	Body	手机号，必须加上国家码，例如中国大陆手机为“+86xxxxxxxxxxx”。当填写手机号时 “country”参数必填。手机号只允许输入纯数字。说明：手机号或者邮箱至少填写一个。
prjCodeMode	否	Integer	Body	投影码生成模式，默认为自动。 0：自动该模式下根据消息上报的IP地址内部控制复杂度。私网地址配置成简单模式，公网地址配置成复杂模式 1：简单 2：复杂
sendNotify	否	string	Body	是否发送邮件和短信通知。 0：不发送不填或者其他值就发送
sn	否	String	Body	终端SN码，仅可包含数字、字母和下划线。
status	否	Integer	Body	终端状态。默认值：0。 0：正常 1：冻结

状态码

表3 状态码说明
HTTP状态码	描述
200	操作成功。
400	参数异常。
401	未鉴权或鉴权失败。
403	权限受限。
500	服务端异常

响应参数

表4 响应参数
参数	类型	描述
account	String	硬终端对应的内置账号。
country	String	手机号所属的国家。
deptCode	String	部门编码。
deptName	String	部门名称。
deptNamePath	String	部门名称路径。
description	String	终端描述。
email	String	邮箱。
model	String	终端型号，枚举类型。当前支持TE系列硬件终端，具体的终端类型可以通过获取所有终端类型接口查询。
name	String	终端名称。
number	String	终端绑定的号码。
phone	String	手机号。
prjCodeMode	Integer	投影码生成模式。 0：自动该模式下根据消息上报的IP地址内部控制复杂度。私网地址配置成简单模式，公网地址配置成复杂模式。 1：简单 2：复杂
sn	String	终端SN号，仅可包含数字、字母和下划线。
status	Integer	终端状态。 0：正常 1：冻结
type	String	终端类型，区分自研和第三方终端。

请求消息示例

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

{
    "model": "TE20",
    "name": "Hangzhou Z5-3-A29",
    "deptCode": "1",
    "phone": "+86**********",
    "email": "****@huawei.com",
    "sn": "asdasfscasd",
    "country": "chinaPR"
}

响应消息示例

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

{
    "name": "Hangzhou Z5-3-A29",
    "type": "TE",
    "model": "TE20",
    "sn": "asdasfscasd",
    "account": "df8bce2178294683bb83a4985fef7165",
    "number": "+991118029589",
    "prjCodeMode": 0,
    "deptCode": "1",
    "deptName": "wangyue",
    "deptNamePath": "wangyue",
    "phone": "+86***********",
    "country": "chinaPR",
    "email": "****@huawei.com",
    "description": null,
    "status": 0
}

错误码

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

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"model": "TE20","name": "test20","deptCode": "1","phone": "+86**********","email": "****@huawei.com","sn": "asdasfscasd","country": "chinaPR"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device

父主题： 专业会议终端管理

上一篇：专业会议终端管理

下一篇：修改终端