创建钉外账号

POST

/v1.0/im/interconnections

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

调用本接口创建钉外用户帐号，并且可以建立与钉内用户帐号的关联关系，方便后续建群等操作。

接口使用说明

在互通场景中，需要有钉外账号，通过该接口创建钉外账号

调用本接口成功创建账号并建立关联关系后，效果如下图所示。

说明

调用本接口之前，需要开通钉钉互联应用：

企业内部应用，请参考如何开通钉钉客联。

第三方企业应用，请参考如何开通钉钉客联。

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉钉客联基础数据读写权限	API Explorer
第三方企业应用	支持	钉钉客联基础数据读写权限	API Explorer
第三方个人应用	暂不支持	钉钉客联基础数据读写权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	general.parameterError	输入参数有误，请检查是否缺少必要参数或内容不正确	输入参数有误，请检查是否缺少必要参数或内容不正确
400	aim.nonexist	您尚未开通钉钉客联服务，请联系钉钉官方客服咨询开通	您尚未开通钉钉客联服务，请联系钉钉官方客服咨询开通
400	client.add.error	创建钉外账号及关联关系失败	创建钉外账号及关联关系失败
400	general.signatureError	参数签名失败，请检查	参数签名失败，请检查
400	client.nameIllegal	用户名称中包含不合规内容，请检查	用户名称中包含不合规内容，请检查
500	system.error	系统异常	系统异常

请求参数

Header 参数

Body 参数application/json

示例

{
  "interconnections" : [ {
    "appUserId" : "String",
    "appUserName" : "String",
    "appUserAvatarMediaType" : Integer,
    "appUserAvatar" : "String",
    "appUserDynamics" : "String",
    "appUserMobile" : "String",
    "userId" : "String",
    "channelCode" : "String"
  } ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1.0/im/interconnections' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "interconnections" : [ {
    "appUserId" : "String",
    "appUserName" : "String",
    "appUserAvatarMediaType" : Integer,
    "appUserAvatar" : "String",
    "appUserDynamics" : "String",
    "appUserMobile" : "String",
    "userId" : "String",
    "channelCode" : "String"
  } ]
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "results": [
        {
            "appUserId": "string",
            "userId": "string",
            "message": "string"
        }
    ]
}

修改于 2025-09-08 06:28:05

创建两人群

批量查询跨钉两人群列表

创建钉外账号

接口使用说明#

权限#

错误码#

请求参数

请求示例代码

返回响应

接口使用说明

权限

错误码