批量发送人与机器人会话中机器人消息
POST
/v1.0/robot/oToMessages/batchSend
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。
接口功能介绍
权限
| 应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | 企业内机器人发送消息权限 | API Explorer |
| 第三方企业应用 | 支持 | 企业内机器人发送消息权限 | API Explorer |
| 第三方个人应用 | 暂不支持 | 企业内机器人发送消息权限 | 暂不支持 |
错误码
| HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | invalidParameter.robotCode.empty | %s | 机器人robotCode无效 |
| 400 | invalidParameter.userIds.empty | %s | 用户userId列表为空 |
| 400 | invalidParameter.userIds.overMax | %s | 用户userId列表超过最大限制100,请将userId拆分成多个长度不超过100的数组，分批次调用此接口 |
| 400 | invalidParameter.msgKey.empty | %s | msgKey为空 |
| 400 | invalidParameter.msgKey.invalid | %s | msgKey无效，请传入正确的msgKey |
| 400 | invalidParameter.msgParam.invalid | %s | msgParam格式非法，必须是json格式 |
| 400 | invalidParameter.param.invalid | %s | 参数不合法，请检查是否有参数为空 |
| 400 | invalidParameter.msg.unsupport | %s | 不支持的消息类型 |
| 400 | invalidParameter.msgParam.tooLong | %s | 消息内容太长消息内容太长，请缩减内容长度 |
| 400 | invalidParameter.robotCode.notExsit | %s | 机器人不存在，请检查企业内是否安装了robotCode对应的机器人 |
| 400 | invalidParameter.msgBody.invalid | %s | 消息体必须是JSON格式 |
| 400 | invalidParameter.userId.empty | %s | 缺少staffId |
| 400 | invalidParameter.token.invalid | %s | 无授权的token |
| 400 | invalidParameter.robotCode.invalid | %s | 无效的robotCode |
| 400 | token.notExisted | %s | TOKEN不存在 |
| 400 | template.not.existed | %s | 机器人模板不存在，请检查robotCode是否正确 |
| 400 | template.stopped | %s | 机器人模板已经停用，请检查机器人状态 |
| 400 | miss.param.text | %s | 消息内容不合法，需要text属性 |
| 400 | miss.param.contentOfText | %s | 消息内容不合法，需要text->content属性 |
| 400 | miss.param.link | %s | 消息内容不合法，需要link属性 |
| 400 | miss.param.textOfLink | %s | 消息内容不合法，需要link->text属性 |
| 400 | miss.param.titleOfLink | %s | 消息内容不合法，需要link->title属性 |
| 400 | miss.param.messageUrlOfLink | %s | 消息内容不合法，需要link->messageUrl属性 |
| 400 | miss.param.markdown | %s | 消息内容不合法，需要markdown属性 |
| 400 | miss.param.markdownTotitle | %s | 消息内容不合法，需要markdown->text属性 |
| 400 | miss.param.markdownTotext | %s | 消息内容不合法，需要markdown->text属性 |
| 400 | miss.param.actionCard | %s | 消息内容不合法，需要actionCard属性 |
| 400 | miss.param.actionCardTotitle | %s | 消息内容不合法，需要actionCard->title属性 |
| 400 | miss.param.actionCardTotext | %s | 消息内容不合法，需要actionCard->text属性 |
| 400 | miss.param.actionCardTosingleTitle | %s | 消息内容不合法，需要actionCard->singleTitle属性 |
| 400 | miss.param.actionCardTosingleUrl | %s | 消息内容不合法，需要actionCard->singleURL属性 |
| 400 | miss.param.actionCardTobtns | %s | 消息内容不合法，需要actionCard->btns属性 |
| 400 | miss.param.actionCardTobtnsTotitle | %s | 消息内容不合法，需要actionCard->btns->title属性 |
| 400 | miss.param.actionCardTobtnsToactionUrl | %s | 消息内容不合法，需要actionCard->btns->actionURL属性 |
| 400 | invalid.param.actionCardTobtnOrientation | %s | 消息内容不合法，错误的actionCard->btnOrientation |
| 400 | invalid.param.actionCardTocanForward | %s | 消息内容不合法，错误的actionCard->canForward |
| 400 | miss.param.feedCard | %s | 消息内容不合法，需要feedCard属性 |
| 400 | miss.param.feedCardTolinks | %s | 消息内容不合法，需要feedCard->links属性 |
| 400 | miss.param.feedCardTolinksTotitle | %s | 消息内容不合法，需要feedCard->links->title属性 |
| 400 | miss.param.feedCardTolinksTomessageUrl | %s | 消息内容不合法，需要feedCard->links->messageURL属性 |
| 400 | miss.param.feedCardTolinksTopicUrl | %s | 消息内容不合法，需要feedCard->links->picURL属性 |
| 400 | miss.param.photo | %s | 消息内容不合法，需要photo属性 |
| 400 | miss.param.photoTophotoUrl | %s | 消息内容不合法，需要photo->photoURL属性 |
| 400 | miss.param.image | %s | 消息内容不合法，需要image属性 |
| 400 | miss.param.imageTopicUrl | %s | 消息内容不合法，需要image->picURL属性 |
| 400 | miss.param.beautifulCard | %s | 消息内容不合法，需要beautifulCard属性 |
| 400 | miss.param.beautifulCardToimage | %s | 消息内容不合法，需要beautifulCard->image属性 |
| 400 | miss.param.beautifulCardTotitle | %s | 消息内容不合法，需要beautifulCard->title属性 |
| 400 | miss.param.beautifulCardToactionUrl | %s | 消息内容不合法，需要beautifulCard->actionUrl属性 |
| 400 | miss.param.beautifulCardTointroduction | %s | 消息内容不合法，需要beautifulCard->introduction属性 |
| 400 | send.byToken.tooFast | %s | 用TOKEN发送限流错误，请稍后再试 |
| 400 | send.too.fast | %s | 发送消息频率过快，请稍后再试 |
| 400 | send.forbidden | %s | 此机器人禁止发送消息 |
| 400 | ip.not.match | %s | IP不匹配，无权限使用此机器人发送消息 |
| 400 | keywords.not.match | %s | 机器人发送消息的关键词不匹配 |
| 400 | sign.not.match | %s | 签名不匹配，无权限发送消息 |
| 400 | contain.unsafe.url | %s | 含有不安全的外链 |
| 400 | contain.notAllowed.text | %s | 含有不合适的文本 |
| 400 | contain.notAllowed.picture | %s | 含有不合适的图片 |
| 400 | contain.notAllowed.content | %s | 含有不合适的内容 |
| 400 | illegal.receivers | %s | 接收者名单不合法 |
| 400 | receivers.exceed | %s | 接收者名单超限 |
| 400 | illegal.excludes | %s | 不接收者名单不合法 |
| 400 | too.many.group | %s | 发送频繁限流 |
| 400 | too.many.people | %s | 发送频繁限流 |
| 400 | bot.forbidden.sendMessage | %s | 帐户被禁言 |
| 400 | session.notExisted | %s | session不存在 |
| 400 | session.expired | %s | session已过期 |
| 400 | staffId.notExisted | %s | staffId不存在 |
| 400 | chatbotId.notAllow.sendOTO | %s | 不允许主动发单聊，请检查机器人状态是否已启用 |
| 400 | robot.oto.notExist | %s | 没有有效的机器人单聊会话 |
| 400 | sendMessage.model.notMatch | %s | 无匹配的消息模型 |
| 400 | miss.param.file | %s | 消息内容不合法，需要file属性 |
| 400 | miss.param.video | %s | 消息内容不合法，需要video->videoMediaId属性 |
| 400 | miss.param.audio | %s | 消息内容不合法，需要audio属性 |
| 500 | system.error | %s | 未知的系统错误 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.dingtalk.com/v1.0/robot/oToMessages/batchSend' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
"robotCode" : "String",
"userIds" : [ "String" ],
"msgKey" : "String",
"msgParam" : "String"
}'响应示例响应示例
{
"processQueryKey": "string",
"invalidStaffIdList": [
"string"
],
"flowControlledStaffIdList": [
"string"
]
}请求参数
Header 参数
x-acs-dingtalk-access-token
string
必需
Body 参数application/json
返回响应
扫码加入交流群修改于 2024-01-09 10:04:48