Skip to main content
Use this API to batch recall Bot messages in one-on-one chats between users and Bots. Submit business fields such as robotCode and processQueryKeys via a POST request. This API applies to scenarios where an organization needs to recall notification messages sent in error within 24 hours.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/robot/otoMessages/batchRecall
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-qyapi_robot_sendmsg-Permission for Bots in your organization to send messages

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an organization authorized to a third-party app API.

Request body

NameTypeRequiredDescription
robotCodeStringYesThe code of the Bot. For details, see Bot ID. This must match the robotCode used when calling the Bot sends group chat messages API.
processQueryKeysArray of StringYesThe list of unique message identifiers. Obtain them via the Batch send Bot messages in one-on-one chats API. - Up to 20 entries per call. - You can recall a message via its processQueryKey within 24 hours after sending. Messages cannot be recalled after 24 hours.

Request example

HTTP
POST /v1.0/robot/otoMessages/batchRecall HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:8ca04016xxx
Content-Type:application/json

{
  "robotCode" : "dingXXXXXX",
  "processQueryKeys" : [ "b5fe1xxx" ]
}
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 {

    /**
     * Initialize the account Client with a Token
     * @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();
        BatchRecallOTOHeaders batchRecallOTOHeaders = new BatchRecallOTOHeaders();
        batchRecallOTOHeaders.xAcsDingtalkAccessToken = "<your access token>";
        BatchRecallOTORequest batchRecallOTORequest = new BatchRecallOTORequest()
                .setRobotCode("dingXXXXXX")
                .setProcessQueryKeys(java.util.Arrays.asList(
                    "b5fe1xxx"
                ));
        try {
            client.batchRecallOTOWithOptions(batchRecallOTORequest, batchRecallOTOHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err object contains code and message properties to help locate the issue
            }

        } 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)) {
                // The err object contains code and message properties to help locate the issue
            }

        }        
    }
}
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:
        """
        Initialize the account Client with a Token
        @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_recall_otoheaders = dingtalkrobot__1__0_models.BatchRecallOTOHeaders()
        batch_recall_otoheaders.x_acs_dingtalk_access_token = '<your access token>'
        batch_recall_otorequest = dingtalkrobot__1__0_models.BatchRecallOTORequest(
            robot_code='dingXXXXXX',
            process_query_keys=[
                'b5fe1xxx'
            ]
        )
        try:
            client.batch_recall_otowith_options(batch_recall_otorequest, batch_recall_otoheaders, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        batch_recall_otoheaders = dingtalkrobot__1__0_models.BatchRecallOTOHeaders()
        batch_recall_otoheaders.x_acs_dingtalk_access_token = '<your access token>'
        batch_recall_otorequest = dingtalkrobot__1__0_models.BatchRecallOTORequest(
            robot_code='dingXXXXXX',
            process_query_keys=[
                'b5fe1xxx'
            ]
        )
        try:
            await client.batch_recall_otowith_options_async(batch_recall_otorequest, batch_recall_otoheaders, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message properties to help locate the issue
                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\BatchRecallOTOHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\BatchRecallOTORequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a Token
     * @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();
        $batchRecallOTOHeaders = new BatchRecallOTOHeaders([]);
        $batchRecallOTOHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $batchRecallOTORequest = new BatchRecallOTORequest([
            "robotCode" => "dingXXXXXX",
            "processQueryKeys" => [
                "b5fe1xxx"
            ]
        ]);
        try {
            $client->batchRecallOTOWithOptions($batchRecallOTORequest, $batchRecallOTOHeaders, 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)) {
                // The err object contains code and message properties to help locate the issue
            }
        }
    }
}
$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"
)

/**
 * Initialize the account Client with a Token
 * @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
  }

  batchRecallOTOHeaders := &dingtalkrobot_1_0.BatchRecallOTOHeaders{}
  batchRecallOTOHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  batchRecallOTORequest := &dingtalkrobot_1_0.BatchRecallOTORequest{
    RobotCode: tea.String("dingXXXXXX"),
    ProcessQueryKeys: []*string{tea.String("b5fe1xxx")},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.BatchRecallOTOWithOptions(batchRecallOTORequest, batchRecallOTOHeaders, &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)) {
      // The err object contains code and message properties to help locate the issue
    }

  }
  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 {

  /**
   * Initialize the account Client with a Token
   * @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 batchRecallOTOHeaders = new $dingtalkrobot_1_0.BatchRecallOTOHeaders({ });
    batchRecallOTOHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let batchRecallOTORequest = new $dingtalkrobot_1_0.BatchRecallOTORequest({
      robotCode: "dingXXXXXX",
      processQueryKeys: [
        "b5fe1xxx"
      ],
    });
    try {
      await client.batchRecallOTOWithOptions(batchRecallOTORequest, batchRecallOTOHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err object contains code and message properties to help locate the issue
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client with a Token
         * @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.BatchRecallOTOHeaders batchRecallOTOHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchRecallOTOHeaders();
            batchRecallOTOHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchRecallOTORequest batchRecallOTORequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchRecallOTORequest
            {
                RobotCode = "dingXXXXXX",
                ProcessQueryKeys = new List<string>
                {
                    "b5fe1xxx"
                },
            };
            try
            {
                client.BatchRecallOTOWithOptions(batchRecallOTORequest, batchRecallOTOHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object contains code and message properties to help locate the issue
                }
            }
            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))
                {
                    // The err object contains code and message properties to help locate the issue
                }
            }
        }

    }
}
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::BatchRecallOTOHeaders> batchRecallOTOHeaders = make_shared<Alibabacloud_Dingtalkrobot_1_0::BatchRecallOTOHeaders>();
  batchRecallOTOHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkrobot_1_0::BatchRecallOTORequest> batchRecallOTORequest = make_shared<Alibabacloud_Dingtalkrobot_1_0::BatchRecallOTORequest>(map<string, boost::any>({
    {"robotCode", boost::any(string("dingXXXXXX"))},
    {"processQueryKeys", boost::any(vector<string>({
      "b5fe1xxx"
    }))}
  }));
  try {
    client->batchRecallOTOWithOptions(batchRecallOTORequest, batchRecallOTOHeaders, 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)) {
      // The err object contains code and message properties to help locate the issue
    }
  }
}

Response

Response body

NameTypeDescription
successResultArray of StringThe list of message-sending task IDs that were successfully recalled. Note When a message sent by a Bot is recalled, no notice appears in the chat.
failedResultMap<String, String>The list of message-sending task IDs that failed to be recalled, along with the corresponding failure reasons.

Response body example

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

{
  "successResult" : [ "b5fe1xxx" ],
  "failedResult" : { }
}

Error codes

If calling this API returns an error, find solutions in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400invalidParameter.robotCode%sThe Bot does not exist. Check whether the Bot corresponding to robotCode is installed in your organization.
400invalidParameter.processQueryKeys.overMax%sThe number of processQueryKeys exceeds the upper limit of 20. Split processQueryKeys into multiple arrays of no more than 20 entries each and call this API in batches.
400not.allowed.robotCode%sThe message to be recalled was not sent by the Bot corresponding to robotCode. You do not have permission to recall the message. Pass in the correct robotCode.
400invalidParameter.param.invalid%sInvalid parameter. Check whether the parameter is empty.
400invalidParameter.processQueryKey.missing%sprocessQueryKey is missing.
400invalid.processQueryKey%sInvalid processQueryKey. Check whether processQueryKey is correct.
400robot.processQueryKey.expired%sprocessQueryKey has expired. The message cannot be recalled.
400notRevoke.all.messages%sNot all messages were recalled.
500system.error%sUnknown system error.