批量注册与激活设备

POST

/v1.0/devicemng/customers/devices/registrationActivations/batch

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

调用本接口批量注册与激活设备。

接口功能介绍

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

调用本接口，注册以下两个设备：

设备名称为测试设备，设备号为zw001，型号为默认类型。

设备名称为测试设备1，设备号为device_1234，型号为默认类型。

接口调用成功后，设备列表如下图所示，新增了两条设备信息。

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	deviceNumLimit	300002，设备数量达到上限	设备数量达到上限
400	devicekeyAlreadyExist	300001，设备key已经存在	设备key已经存在
500	systemError	100000，系统异常	系统异常

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

{
    "successItems": [
        {
            "errorCode": "string",
            "errorMsg": "string",
            "result": {
                "deviceCallbackUrl": "string",
                "deviceCode": "string",
                "deviceDetailUrl": "string",
                "deviceName": "string",
                "groupUuid": "string",
                "icon": "string",
                "introduction": "string",
                "roleUuid": "string",
                "userIds": [
                    "string"
                ],
                "status": 0,
                "typeUuid": "string",
                "uuid": "string",
                "deviceCategory": 0
            },
            "success": true
        }
    ],
    "success": true,
    "failItems": [
        {
            "errorCode": "string",
            "errorMsg": "string",
            "result": {
                "deviceCallbackUrl": "string",
                "deviceCode": "string",
                "deviceDetailUrl": "string",
                "deviceName": "string",
                "groupUuid": "string",
                "icon": "string",
                "introduction": "string",
                "roleUuid": "string",
                "userIds": [
                    "string"
                ],
                "status": 0,
                "typeUuid": "string",
                "uuid": "string",
                "deviceCategory": 0
            },
            "success": true
        }
    ]
}

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

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

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

Body 参数application/json

registerAndActivateVOS

array [object {9}]

可选

批量注册的设备信息列表，最大值100。

deviceCode

string

必需

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

deviceDetailUrl

string

可选

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

deviceCallbackUrl

string

可选

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

deviceName

string

必需

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

groupUuid

string

可选

分组标识，该参数需要在群内咨询。企业内部应用，请参考设备上钉咨询群。第三方企业应用，请参考设备上钉咨询群。

introduction

string

设备的简介。

可选

roleUuid

string

可选

角色标识，该参数需要在群内咨询。企业内部应用，请参考设备上钉咨询群。第三方企业应用，请参考设备上钉咨询群。

typeUuid

string

可选

设备型号，该参数需要在群内咨询。企业内部应用，请参考设备上钉咨询群。第三方企业应用，请参考设备上钉咨询群。

userIds

array[string]

可选

设备管理员的userId列表，最大值50。

示例

返回响应

🟢200成功

application/json

Body

successItems

array [object {4}]

必需

注册成功的设备列表。

errorCode

string

可选

错误码。说明注册成功，不返回该字段。

errorMsg

string

可选

错误信息。说明注册成功，不返回该字段。

result

object

设备信息。

可选

success

boolean

可选

设备注册是否成功。 true：成功 false：失败

success

boolean

必需

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

failItems

array [object {4}]

必需

注册失败的设备列表。

errorCode

string

错误码。

可选

errorMsg

string

错误信息。

可选

result

object

设备信息。

可选

success

boolean

可选

设备注册是否成功。 true：成功 false：失败

修改于 2024-01-23 02:40:57

批量注册与激活设备

接口功能介绍#

权限#

错误码#

请求参数

返回响应

接口功能介绍

权限

错误码