查询企业机器人群聊消息用户已读状态

POST

/v1.0/robot/groupMessages/query

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

调用本接口，查询企业机器人群聊消息用户已读状态。

接口功能介绍

调用本接口可用于获取机器人消息发送状态、消息已读成员userId等信息，例如当企业机器人在内部群会话发送群聊消息后，使用本接口，能查询到已读用户的userId。

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	企业内机器人发送消息权限	API Explorer
第三方企业应用	支持	企业内机器人发送消息权限	API Explorer
第三方个人应用	暂不支持	企业内机器人发送消息权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter.param.invalid	参数不合法	参数不合法，请检查参数是否为空
400	invalidParameter.robotCode.notExsit	机器人不存在	机器人不存在，请检查机器人是否在群内
400	invalidParameter.robotCode.missing	缺少robotCode	缺少robotCode
400	invalidParameter.processQueryKey.missing	缺少processQueryKey	缺少processQueryKey
400	invalidParameter.cursor.invalid	无效的nextToken	无效的nextToken，请检查nextToken是否正确
400	invalidParameter.pageSize.invalid	无效的maxResults	maxResults超出上限200
400	invalidParameter.invalid	token对应机器人不存在	token对应机器人不存在，请检查机器人是否在群内
400	invalidParameter.robotCode.invalid	无效的robotCode	无效的robotCode
400	invalid.openConversationId	无效的openConversationId	无效的openConversationId
400	openConversationId.notExisted	openConversationId不能和token同时为空	openConversationId不能和token同时为空
400	invalid.processQueryKey	无效的processQueryKey	无效的processQueryKey
400	bot.stopped	群机器人已经停用	群机器人已经停用
400	template.not.existed	机器人模板不存在	机器人模板不存在
400	template.stopped	机器人模板已经停用	机器人模板已经停用
400	processQueryKey.expireTime	processQueryKey还未生成消息查询数据或已过期	processQueryKey还未生成消息查询数据或已过期，无法查询消息
400	conversation.org.dismatch	会话不属于当前企业	会话不属于当前企业
400	resource.not.found	%s	机器人不存在
400	unauthorized	%s	未授权
400	auth.error	%s	权限不足，不允许操作
500	system.error	未知的系统错误	未知的系统错误

请求参数

Header 参数

Body 参数application/json

示例

{
  "openConversationId" : "String",
  "robotCode" : "String",
  "processQueryKey" : "String",
  "maxResults" : Long,
  "nextToken" : "String"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1.0/robot/groupMessages/query' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "openConversationId" : "String",
  "robotCode" : "String",
  "processQueryKey" : "String",
  "maxResults" : Long,
  "nextToken" : "String"
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "sendStatus": "string",
    "readUserIds": [
        "string"
    ],
    "nextToken": "string",
    "hasMore": true
}

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

查询人与人会话中机器人消息已读列表

批量撤回人与机器人会话中机器人消息

查询企业机器人群聊消息用户已读状态

接口功能介绍#

权限#

错误码#

请求参数

请求示例代码

返回响应

接口功能介绍

权限

错误码