跳转到主要内容
调用本接口,批量发送人与机器人会话(人与机器人单聊)中机器人消息。适用于需要向多个用户(最多20个)批量发送机器人消息的场景,如企业通知、系统告警推送等场景。

接口调用说明

本接口支持企业内部应用机器人,详情参考配置企业机器人

请求

基本信息

字段
HTTP URLhttps://api.dingtalk.io/v1.0/robot/oToMessages/batchSend
HTTP MethodPOST
支持的应用类型appType-企业内部应用 appType-第三方企业应用
权限要求permission-qyapi_robot_sendmsg-企业内机器人发送消息权限

请求头

名称类型是否必填描述
x-acs-dingtalk-access-tokenString调用该接口的访问凭证,通过以下获取: - 企业内部应用,调用获取企业内部应用的accessToken接口获取。 - 第三方企业应用,调用获取第三方应用授权企业的accessToken接口获取。

请求体

名称类型是否必填描述
robotCodeString机器人的编码,该参数必须使用企业内部应用机器人的robotCode,详情参考机器人 ID
userIdsArray of String接收消息的用户userId列表,每次最多传20个,可通过查询用户详情获取部门用户userid列表接口获取。
msgKeyString消息模板key,详情参考企业机器人发送消息的消息类型
msgParamString消息模板参数,消息模板参数,详情参考企业机器人发送消息的消息类型

请求示例

HTTP
POST /v1.0/robot/oToMessages/batchSend HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:asdasdasdasd
Content-Type:application/json

{
  "robotCode" : "dingxxxxxx",
  "userIds" : [ "manager1234" ],
  "msgKey" : "sampleMarkdown",
  "msgParam" : "{\"text\": \"hello text\",\"title\": \"hello title\"}"
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkrobot_1_0.*;
import com.aliyun.dingtalkrobot_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkrobot_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkrobot_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkrobot_1_0.Client client = Sample.createClient();
        BatchSendOTOHeaders batchSendOTOHeaders = new BatchSendOTOHeaders();
        batchSendOTOHeaders.xAcsDingtalkAccessToken = "<your access token>";
        BatchSendOTORequest batchSendOTORequest = new BatchSendOTORequest()
                .setRobotCode("dingxxxxxx")
                .setUserIds(java.util.Arrays.asList(
                    "manager1234"
                ))
                .setMsgKey("sampleMarkdown")
                .setMsgParam("{\"text\": \"hello text\",\"title\": \"hello title\"}");
        try {
            client.batchSendOTOWithOptions(batchSendOTORequest, batchSendOTOHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err 中含有 code 和 message 属性,可帮助开发定位问题
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err 中含有 code 和 message 属性,可帮助开发定位问题
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.robot_1_0.client import Client as dingtalkrobot_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.robot_1_0 import models as dingtalkrobot__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkrobot_1_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkrobot_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        batch_send_otoheaders = dingtalkrobot__1__0_models.BatchSendOTOHeaders()
        batch_send_otoheaders.x_acs_dingtalk_access_token = '<your access token>'
        batch_send_otorequest = dingtalkrobot__1__0_models.BatchSendOTORequest(
            robot_code='dingxxxxxx',
            user_ids=[
                'manager1234'
            ],
            msg_key='sampleMarkdown',
            msg_param='{"text": "hello text","title": "hello title"}'
        )
        try:
            client.batch_send_otowith_options(batch_send_otorequest, batch_send_otoheaders, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性,可帮助开发定位问题
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        batch_send_otoheaders = dingtalkrobot__1__0_models.BatchSendOTOHeaders()
        batch_send_otoheaders.x_acs_dingtalk_access_token = '<your access token>'
        batch_send_otorequest = dingtalkrobot__1__0_models.BatchSendOTORequest(
            robot_code='dingxxxxxx',
            user_ids=[
                'manager1234'
            ],
            msg_key='sampleMarkdown',
            msg_param='{"text": "hello text","title": "hello title"}'
        )
        try:
            await client.batch_send_otowith_options_async(batch_send_otorequest, batch_send_otoheaders, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性,可帮助开发定位问题
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\BatchSendOTOHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\BatchSendOTORequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $batchSendOTOHeaders = new BatchSendOTOHeaders([]);
        $batchSendOTOHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $batchSendOTORequest = new BatchSendOTORequest([
            "robotCode" => "dingxxxxxx",
            "userIds" => [
                "manager1234"
            ],
            "msgKey" => "sampleMarkdown",
            "msgParam" => "{\"text\": \"hello text\",\"title\": \"hello title\"}"
        ]);
        try {
            $client->batchSendOTOWithOptions($batchSendOTORequest, $batchSendOTOHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err 中含有 code 和 message 属性,可帮助开发定位问题
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/service"
  dingtalkrobot_1_0  "github.com/alibabacloud-go/dingtalk/robot_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * 使用 Token 初始化账号Client
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkrobot_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkrobot_1_0.Client{}
  _result, _err = dingtalkrobot_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  batchSendOTOHeaders := &dingtalkrobot_1_0.BatchSendOTOHeaders{}
  batchSendOTOHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  batchSendOTORequest := &dingtalkrobot_1_0.BatchSendOTORequest{
    RobotCode: tea.String("dingxxxxxx"),
    UserIds: []*string{tea.String("manager1234")},
    MsgKey: tea.String("sampleMarkdown"),
    MsgParam: tea.String("{\"text\": \"hello text\",\"title\": \"hello title\"}"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.BatchSendOTOWithOptions(batchSendOTORequest, batchSendOTOHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err 中含有 code 和 message 属性,可帮助开发定位问题
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkrobot_1_0, * as $dingtalkrobot_1_0 from '@alicloud/dingtalk/robot_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * 使用 Token 初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkrobot_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkrobot_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let batchSendOTOHeaders = new $dingtalkrobot_1_0.BatchSendOTOHeaders({ });
    batchSendOTOHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let batchSendOTORequest = new $dingtalkrobot_1_0.BatchSendOTORequest({
      robotCode: "dingxxxxxx",
      userIds: [
        "manager1234"
      ],
      msgKey: "sampleMarkdown",
      msgParam: "{\"text\": \"hello text\",\"title\": \"hello title\"}",
    });
    try {
      await client.batchSendOTOWithOptions(batchSendOTORequest, batchSendOTOHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 中含有 code 和 message 属性,可帮助开发定位问题
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /**
         * 使用 Token 初始化账号Client
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkrobot_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkrobot_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchSendOTOHeaders batchSendOTOHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchSendOTOHeaders();
            batchSendOTOHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchSendOTORequest batchSendOTORequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchSendOTORequest
            {
                RobotCode = "dingxxxxxx",
                UserIds = new List<string>
                {
                    "manager1234"
                },
                MsgKey = "sampleMarkdown",
                MsgParam = "{\"text\": \"hello text\",\"title\": \"hello title\"}",
            };
            try
            {
                client.BatchSendOTOWithOptions(batchSendOTORequest, batchSendOTOHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性,可帮助开发定位问题
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性,可帮助开发定位问题
                }
            }
        }

    }
}
C
// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkrobot__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkrobot_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkrobot_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkrobot_1_0::Client> client = make_shared<Alibabacloud_Dingtalkrobot_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkrobot_1_0::BatchSendOTOHeaders> batchSendOTOHeaders = make_shared<Alibabacloud_Dingtalkrobot_1_0::BatchSendOTOHeaders>();
  batchSendOTOHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkrobot_1_0::BatchSendOTORequest> batchSendOTORequest = make_shared<Alibabacloud_Dingtalkrobot_1_0::BatchSendOTORequest>(map<string, boost::any>({
    {"robotCode", boost::any(string("dingxxxxxx"))},
    {"userIds", boost::any(vector<string>({
      "manager1234"
    }))},
    {"msgKey", boost::any(string("sampleMarkdown"))},
    {"msgParam", boost::any(string("{"text": "hello text","title": "hello title"}"))}
  }));
  try {
    client->batchSendOTOWithOptions(batchSendOTORequest, batchSendOTOHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err 中含有 code 和 message 属性,可帮助开发定位问题
    }
  }
}

响应

响应体

名称类型描述
processQueryKeyString消息id,可用于批量查询人与机器人会话机器人消息是否已读批量撤回人与机器人会话中机器人消息接口,查询消息是否已读和撤回消息。
invalidStaffIdListArray of String无效的用户userId列表。
flowControlledStaffIdListArray of String被限流的userId列表。

响应体示例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "processQueryKey" : "zcxxczasdafasd",
  "invalidStaffIdList" : [ "manage25231" ],
  "flowControlledStaffIdList" : [ "manage25232" ]
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
HttpCode错误码错误信息说明
400invalidParameter.robotCode.empty%s机器人robotCode无效
400invalidParameter.userIds.empty%s用户userId列表为空
400invalidParameter.userIds.overMax%s用户userId列表超过最大限制100,请将userId拆分成多个长度不超过100的数组,分批次调用此接口
400invalidParameter.msgKey.empty%smsgKey为空
400invalidParameter.msgKey.invalid%smsgKey无效,请传入正确的msgKey
400invalidParameter.msgParam.invalid%smsgParam格式非法,必须是json格式
400invalidParameter.param.invalid%s参数不合法,请检查是否有参数为空
400invalidParameter.msg.unsupport%s不支持的消息类型
400invalidParameter.msgParam.tooLong%s消息内容太长消息内容太长,请缩减内容长度
400invalidParameter.robotCode.notExsit%s机器人不存在,请检查企业内是否安装了robotCode对应的机器人
400invalidParameter.msgBody.invalid%s消息体必须是JSON格式
400invalidParameter.userId.empty%s缺少staffId
400invalidParameter.token.invalid%s无授权的token
400invalidParameter.robotCode.invalid%s无效的robotCode
400token.notExisted%sTOKEN不存在
400template.not.existed%s机器人模板不存在,请检查robotCode是否正确
400template.stopped%s机器人模板已经停用,请检查机器人状态
400miss.param.text%s消息内容不合法,需要text属性
400miss.param.contentOfText%s消息内容不合法,需要text->content属性
400miss.param.link%s消息内容不合法,需要link属性
400miss.param.textOfLink%s消息内容不合法,需要link->text属性
400miss.param.titleOfLink%s消息内容不合法,需要link->title属性
400miss.param.messageUrlOfLink%s消息内容不合法,需要link->messageUrl属性
400miss.param.markdown%s消息内容不合法,需要markdown属性
400miss.param.markdownTotitle%s消息内容不合法,需要markdown->text属性
400miss.param.markdownTotext%s消息内容不合法,需要markdown->text属性
400miss.param.actionCard%s消息内容不合法,需要actionCard属性
400miss.param.actionCardTotitle%s消息内容不合法,需要actionCard->title属性
400miss.param.actionCardTotext%s消息内容不合法,需要actionCard->text属性
400miss.param.actionCardTosingleTitle%s消息内容不合法,需要actionCard->singleTitle属性
400miss.param.actionCardTosingleUrl%s消息内容不合法,需要actionCard->singleURL属性
400miss.param.actionCardTobtns%s消息内容不合法,需要actionCard->btns属性
400miss.param.actionCardTobtnsTotitle%s消息内容不合法,需要actionCard->btns->title属性
400miss.param.actionCardTobtnsToactionUrl%s消息内容不合法,需要actionCard->btns->actionURL属性
400invalid.param.actionCardTobtnOrientation%s消息内容不合法,错误的actionCard->btnOrientation
400invalid.param.actionCardTocanForward%s消息内容不合法,错误的actionCard->canForward
400miss.param.feedCard%s消息内容不合法,需要feedCard属性
400miss.param.feedCardTolinks%s消息内容不合法,需要feedCard->links属性
400miss.param.feedCardTolinksTotitle%s消息内容不合法,需要feedCard->links->title属性
400miss.param.feedCardTolinksTomessageUrl%s消息内容不合法,需要feedCard->links->messageURL属性
400miss.param.feedCardTolinksTopicUrl%s消息内容不合法,需要feedCard->links->picURL属性
400miss.param.photo%s消息内容不合法,需要photo属性
400miss.param.photoTophotoUrl%s消息内容不合法,需要photo->photoURL属性
400miss.param.image%s消息内容不合法,需要image属性
400miss.param.imageTopicUrl%s消息内容不合法,需要image->picURL属性
400miss.param.beautifulCard%s消息内容不合法,需要beautifulCard属性
400miss.param.beautifulCardToimage%s消息内容不合法,需要beautifulCard->image属性
400miss.param.beautifulCardTotitle%s消息内容不合法,需要beautifulCard->title属性
400miss.param.beautifulCardToactionUrl%s消息内容不合法,需要beautifulCard->actionUrl属性
400miss.param.beautifulCardTointroduction%s消息内容不合法,需要beautifulCard->introduction属性
400send.byToken.tooFast%s用TOKEN发送限流错误,请稍后再试
400send.too.fast%s发送消息频率过快,请稍后再试
400send.forbidden%s此机器人禁止发送消息
400ip.not.match%sIP不匹配,无权限使用此机器人发送消息
400keywords.not.match%s机器人发送消息的关键词不匹配
400sign.not.match%s签名不匹配,无权限发送消息
400contain.unsafe.url%s含有不安全的外链
400contain.notAllowed.text%s含有不合适的文本
400contain.notAllowed.picture%s含有不合适的图片
400contain.notAllowed.content%s含有不合适的内容
400illegal.receivers%s接收者名单不合法
400receivers.exceed%s接收者名单超限
400illegal.excludes%s不接收者名单不合法
400too.many.group%s发送频繁限流
400too.many.people%s发送频繁限流
400bot.forbidden.sendMessage%s账户被禁言
400session.notExisted%ssession不存在
400session.expired%ssession已过期
400staffId.notExisted%sstaffId不存在
400chatbotId.notAllow.sendOTO%s不允许主动发单聊,请检查机器人状态是否已启用
400robot.oto.notExist%s没有有效的机器人单聊会话
400sendMessage.model.notMatch%s无匹配的消息模型
400miss.param.file%s消息内容不合法,需要file属性
400miss.param.video%s消息内容不合法,需要video->videoMediaId属性
400miss.param.audio%s消息内容不合法,需要audio属性
500system.error%s未知的系统错误