注册设备到钉钉

**
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口可以将设备注册到钉钉上，用于后期的设备管理及业务处理。

接口功能介绍

例如，企业设备上钉应用内的设备列表如下图所示。

调用本接口，新增一条设备信息：设备名称为测试设备，设备号为zw001，型号为默认类型。接口调用成功后，设备列表如下图所示，会新增一条测试设备的设备信息。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	制造业设备信息写权限	API Explorer
第三方企业应用	支持	制造业设备信息写权限	API Explorer
第三方个人应用	暂不支持	制造业设备信息写权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	devicekeyAlreadyExist	30001，设备key已存在	设备key已存在
400	devicenameAlreadyExist	30002，设备名称已存在	设备名称已存在
400	deviceNumLimit	30008，设备数量达到上限	设备数量达到上限
400	userNotExisted	%s	用户信息不存在
500	systemError	100000，系统异常	系统异常

curl --location --request POST 'https://api.dingtalk.com/v1.0/devicemng/customers/devices/registerAndActivate' \ --header 'x-acs-dingtalk-access-token;' \ --header 'Content-Type: application/json' \ --data-raw '{ "deviceCode" : "String", "deviceName" : "String", "introduction" : "String", "typeUuid" : "String", "userIds" : [ "String" ], "roleUuid" : "String", "deviceDetailUrl" : "String", "deviceCallbackUrl" : "String", "deviceCategory" : Integer }'

{ "success": true, "result": { "deviceCode": "string", "deviceUuid": "string", "deviceName": "string", "introduction": "string", "typeUuid": "string", "roleUuid": "string", "deviceDetailUrl": "string", "userIds": [ "string" ] } }

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

deviceCode

string

必需

设备号。说明用户自定义参数，要求企业内每一个设备的设备码必须唯一。

deviceName

string

必需

设备名称。说明用户自定义参数。

introduction

string

设备的简介。

可选

typeUuid

string

设备型号。

可选

userIds

array[string]

可选

设备管理员的userId列表。

roleUuid

string

角色标识。

可选

deviceDetailUrl

string

可选

设备详情链接，最大长度2048字符。

deviceCallbackUrl

string

可选

设备回调链接，最大长度2048字符。

示例

返回响应

🟢200成功

application/json

Body

success

boolean

必需

接口调用是否成功。 true：成功 false：失败

result

object

响应结果。

必需

deviceCode

string

设备号。

必需

deviceUuid

string

钉钉侧设备标识。

必需

deviceName

string

设备名称。

必需

introduction

string

设备的简介。

必需

typeUuid

string

设备型号。

必需

roleUuid

string

角色标识。

必需

deviceDetailUrl

string

设备详情链接。

必需

userIds

array[string]

必需

注册设备到钉钉

接口功能介绍#

权限#

错误码#

请求参数

返回响应

接口功能介绍

权限

错误码