获取钉钉客联H5会话地址

POST

/v1.0/im/conversations/urls

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

调用本接口，获取钉钉客联H5会话地址，钉外账号可通过该地址打开会话列表或群会话。

接口使用说明

创建钉钉客联互通群后，钉内账号可通过钉钉客户端打开对应的群会话，钉外账号需要通过H5会话地址打开对应的群会话。

说明

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

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

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

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	aim.nonexist	您尚未开通钉钉客联服务，请联系钉钉官方客服咨询开通	您尚未开通钉钉客联服务，请联系钉钉官方客服咨询开通
400	client.nonexist	钉外账号不存在，请检查	钉外账号不存在，请检查
400	service.nonexist	钉内账号不存在，请检查	钉内账号不存在，请检查
400	channel.nonexist	渠道不存在，请检查	渠道不存在，请检查
400	group.qrcode.nonexist	群会话不存在，请检查	群会话不存在，请检查
500	system.error	系统异常	系统异常

请求参数

Header 参数

Body 参数application/json

示例

{
  "appUserId" : "String",
  "userId" : "String",
  "openConversationId" : "String",
  "channelCode" : "String"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1.0/im/conversations/urls' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "appUserId" : "String",
  "userId" : "String",
  "openConversationId" : "String",
  "channelCode" : "String"
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "url": "string"
}

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

批量查询跨钉两人群列表

查询钉外账号未读消息数

获取钉钉客联H5会话地址

接口使用说明#

权限#

错误码#

请求参数

请求示例代码

返回响应

接口使用说明

权限

错误码