查询钉外账号未读消息数

POST

/v1.0/im/interconnections/unReadMsgs/query

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

调用该接口，查询钉外账号未读消息的数量。

接口使用说明

可指定钉外账号标识查询所有该钉外账号所在群的未读消息数量。

可指定钉外账号标识和群会话openConversationId查询钉外账号在指定的群内未读消息数量。

说明

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

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

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

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	general.parameterError	输入参数有误，请检查是否缺少必要参数或内容不正确	输入参数有误，请检查是否缺少必要参数或内容不正确
400	group.nonexist	群不存在，请检查	群不存在，请检查
400	group.notReady	群会话仍在创建中，请稍后重试	群会话仍在创建中，请稍后重试
500	system.error	系统异常	系统异常

请求参数

Header 参数

Body 参数application/json

示例

{
  "appUserId" : "String",
  "openConversationIds" : [ "String" ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1.0/im/interconnections/unReadMsgs/query' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "appUserId" : "String",
  "openConversationIds" : [ "String" ]
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "unReadCount": 0,
    "unReadItems": [
        {
            "openConversationId": "string",
            "unReadCount": 0
        }
    ]
}

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

获取钉钉客联H5会话地址

添加互通群成员

查询钉外账号未读消息数

接口使用说明#

权限#

错误码#

请求参数

请求示例代码

返回响应

接口使用说明

权限

错误码