注册设备到钉钉新版SDK
更新于 2023-01-18调用本接口可以将设备注册到钉钉上，用于后期的设备管理及业务处理。
接口功能介绍
例如，企业设备上钉应用内的设备列表如下图所示。
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | 制造业设备信息写权限 | API Explorer |
| 第三方企业应用 | 支持 | 制造业设备信息写权限 | API Explorer |
| 第三方个人应用 | 暂不支持 | 制造业设备信息写权限 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Body参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
deviceCode | String | 是 | 设备号。 说明
用户自定义参数，要求企业内每一个设备的设备码必须唯一。 |
deviceName | String | 是 | 设备名称。 说明
用户自定义参数。 |
introduction | String | 否 | 设备的简介。 |
typeUuid | String | 否 | 设备型号。 |
userIds | Array of String | 否 | 设备管理员的userId列表。 |
roleUuid | String | 否 | 角色标识。 |
deviceDetailUrl | String | 否 | 设备详情链接，最大长度2048字符。 |
deviceCallbackUrl | String | 否 | 设备回调链接，最大长度2048字符。 |
deviceCategory | Integer | 否 | 设备分类。
|
返回参数
名称 | 类型 | 描述 |
|---|---|---|
success | Boolean | 接口调用是否成功。
|
result | Object | 响应结果。 |
deviceCode | String | 设备号。 |
deviceUuid | String | 钉钉侧设备标识。 |
deviceName | String | 设备名称。 |
introduction | String | 设备的简介。 |
typeUuid | String | 设备型号。 |
roleUuid | String | 角色标识。 |
deviceDetailUrl | String | 设备详情链接。 |
userIds | Array of String | 设备管理员的userId列表，最大值50。 |
deviceCategory | Integer | 设备分类。
|
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | devicekeyAlreadyExist | 30001，设备key已存在 | 设备key已存在 |
400 | devicenameAlreadyExist | 30002，设备名称已存在 | 设备名称已存在 |
400 | deviceNumLimit | 30008，设备数量达到上限 | 设备数量达到上限 |
400 | userNotExisted | %s | 用户信息不存在 |
500 | systemError | 100000，系统异常 | 系统异常 |
