创建两人群

POST

/v2.0/im/interconnections/couples/groups

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

调用本接口创建钉钉客联两人群，两人群同时具备单聊的效果和群聊的功能，可替代单聊场景。

接口使用说明

调用本接口可实现将钉外账号与钉内账号作为群成员，创建一个两人群。具有以下几个特征：

以当前两人作为群成员，只会创建一个两人群。

在两人群中，当群成员只有初始创建的两个账号时，群名称和群头像均显示对方账号，仿单聊会话显示效果。

在两人群中，可以添加第三方用户进群，聊天记录保留，会话恢复群聊显示效果。

在两人群中，可以使用群机器人。

在两人群中，可以使用群工具栏。

说明

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

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

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	general.parameterError	输入参数有误，请检查是否超出最大值或传参规则不正确	输入参数有误，请检查是否超出最大值或传参规则不正确
400	aim.nonexist	您尚未开通钉钉客联服务，请联系钉钉官方客服咨询开通	您尚未开通钉钉客联服务，请联系钉钉官方客服咨询开通
400	client.nonexist	钉外账号不存在，请检查	钉外账号不存在，请检查
400	service.nonexist	钉内账号不存在，请检查	钉内账号不存在，请检查
400	template.nonexist	群模板不存在，请检查	群模板不存在，请检查
400	general.enumError	入参枚举有误，请检查	入参枚举有误，请检查
400	request.duplicate	重复请求，请稍后重试	重复请求，请稍后重试
400	group.memberIllegal	两人群人数有误，请确保人数有且只有两人	两人群人数有误，请确保人数有且只有两人
400	group.memberParamIllegal	群成员参数设置有误，请检查	群成员参数设置有误，请检查
500	group.create.error	创建群失败	创建群失败
500	system.error	系统异常	系统异常

请求参数

Header 参数

Body 参数application/json

示例

{
  "groupTemplateId" : "String",
  "users" : [ {
    "appUserId" : "String",
    "userId" : "String",
    "groupOwner" : Boolean
  } ],
  "operatorId" : "String"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v2.0/im/interconnections/couples/groups' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "groupTemplateId" : "String",
  "users" : [ {
    "appUserId" : "String",
    "userId" : "String",
    "groupOwner" : Boolean
  } ],
  "operatorId" : "String"
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "openConversationId": "string",
    "conversationId": "string",
    "appUserIds": [
        "string"
    ],
    "userIds": [
        "string"
    ]
}

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

创建普通群

创建钉外账号

创建两人群

接口使用说明#

权限#

错误码#

请求参数

请求示例代码

返回响应

接口使用说明

权限

错误码