批量撤回人与机器人会话中机器人消息新版SDK
更新于 2024-02-23
接口功能介绍
撤回单聊消息前，机器人发送了多条消息，如下图所示：
调用接口撤回消息，接口调用成功后，如下图所示：
撤回机器人发送的消息，在聊天框中没有提示。
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
企业内部应用 | 支持 | 企业内机器人发送消息权限 | |
第三方企业应用 | 支持 | 企业内机器人发送消息权限 | |
第三方个人应用 | 暂不支持 | 企业内机器人发送消息权限 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Body参数
名称 | 类型 | 是否必填 | 描述 |
robotCode | String | 是 | 机器人的编码，需要与批量发送人与机器人会话中机器人消息接口中使用的robotCode保持一致。 |
processQueryKeys | Array of String | 是 | 消息唯一标识列表，可通过批量发送人与机器人会话中机器人消息接口获取。 说明
|
返回参数
名称 | 类型 | 描述 |
successResult | Array of String | 撤回成功的消息发送任务ID列表。 |
failedResult | Map<String, String> | 撤回失败的消息发送任务ID列表及对应的失败原因。 |
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
400 | invalidParameter.robotCode | %s | 机器人不存在，请检查企业内是否安装了robotCode对应的机器人 |
400 | invalidParameter.processQueryKeys.overMax | %s | processQueryKeys超过数量上限20，请将processQueryKeys拆分成多个长度不超过20的数组，分批次调用此接口 |
400 | not.allowed.robotCode | %s | 待撤回的消息不是robotCode对应的机器人发出的，无权限撤回消息，请传入正确的robotCode |
400 | invalidParameter.param.invalid | %s | 参数不合法，请检查参数是否为空 |
400 | invalidParameter.processQueryKey.missing | %s | 缺少processQueryKey |
400 | invalid.processQueryKey | %s | 无效的processQueryKey，请检查processQueryKey是否正确 |
400 | robot.processQueryKey.expired | %s | processQueryKey已过期，无法撤回消息 |
400 | notRevoke.all.messages | %s | 消息未能全部撤回 |
500 | system.error | %s | 未知的系统错误 |
