Skip to main content
Call this API to recall an internal group message sent by an enterprise bot. This is useful for bulk-recalling group chat bot messages that were sent in error.

Request

Basic information

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

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 authorized enterprise for a third-party app API.

Request body

NameTypeRequiredDescription
openConversationIdStringYesThe group ID. Obtain the group chat openConversationId on the client side via chooseChat. This must match the openConversationId used when calling the Send group chat messages with a bot API.
robotCodeStringYesThe code of the bot. See Bot ID for details. This must match the robotCode used when calling the Send group chat messages with a bot API.
processQueryKeysArray of StringYesThe list of message IDs. Obtain these values from the processQueryKey field returned by the Send group chat messages with a bot API.

Request example

HTTP
POST /v1.0/robot/groupMessages/recall HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:e9d6cxxx
Content-Type:application/json

{
  "openConversationId" : "cidfCSxxxx",
  "robotCode" : "dingxxxx",
  "processQueryKeys" : [ "b5fe11095fxxxx" ]
}
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 using 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();
        OrgGroupRecallHeaders orgGroupRecallHeaders = new OrgGroupRecallHeaders();
        orgGroupRecallHeaders.xAcsDingtalkAccessToken = "<your access token>";
        OrgGroupRecallRequest orgGroupRecallRequest = new OrgGroupRecallRequest()
                .setOpenConversationId("cidfCSxxxx")
                .setRobotCode("dingxxxx")
                .setProcessQueryKeys(java.util.Arrays.asList(
                    "b5fe11095fxxxx"
                ));
        try {
            client.orgGroupRecallWithOptions(orgGroupRecallRequest, orgGroupRecallHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message attributes that 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)) {
                // err contains code and message attributes that 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 using 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()
        org_group_recall_headers = dingtalkrobot__1__0_models.OrgGroupRecallHeaders()
        org_group_recall_headers.x_acs_dingtalk_access_token = '<your access token>'
        org_group_recall_request = dingtalkrobot__1__0_models.OrgGroupRecallRequest(
            open_conversation_id='cidfCSxxxx',
            robot_code='dingxxxx',
            process_query_keys=[
                'b5fe11095fxxxx'
            ]
        )
        try:
            client.org_group_recall_with_options(org_group_recall_request, org_group_recall_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        org_group_recall_headers = dingtalkrobot__1__0_models.OrgGroupRecallHeaders()
        org_group_recall_headers.x_acs_dingtalk_access_token = '<your access token>'
        org_group_recall_request = dingtalkrobot__1__0_models.OrgGroupRecallRequest(
            open_conversation_id='cidfCSxxxx',
            robot_code='dingxxxx',
            process_query_keys=[
                'b5fe11095fxxxx'
            ]
        )
        try:
            await client.org_group_recall_with_options_async(org_group_recall_request, org_group_recall_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that 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\OrgGroupRecallHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\OrgGroupRecallRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $orgGroupRecallHeaders = new OrgGroupRecallHeaders([]);
        $orgGroupRecallHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $orgGroupRecallRequest = new OrgGroupRecallRequest([
            "openConversationId" => "cidfCSxxxx",
            "robotCode" => "dingxxxx",
            "processQueryKeys" => [
                "b5fe11095fxxxx"
            ]
        ]);
        try {
            $client->orgGroupRecallWithOptions($orgGroupRecallRequest, $orgGroupRecallHeaders, 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 contains code and message attributes that 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 using 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
  }

  orgGroupRecallHeaders := &dingtalkrobot_1_0.OrgGroupRecallHeaders{}
  orgGroupRecallHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  orgGroupRecallRequest := &dingtalkrobot_1_0.OrgGroupRecallRequest{
    OpenConversationId: tea.String("cidfCSxxxx"),
    RobotCode: tea.String("dingxxxx"),
    ProcessQueryKeys: []*string{tea.String("b5fe11095fxxxx")},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.OrgGroupRecallWithOptions(orgGroupRecallRequest, orgGroupRecallHeaders, &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 contains code and message attributes that 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 using 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 orgGroupRecallHeaders = new $dingtalkrobot_1_0.OrgGroupRecallHeaders({ });
    orgGroupRecallHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let orgGroupRecallRequest = new $dingtalkrobot_1_0.OrgGroupRecallRequest({
      openConversationId: "cidfCSxxxx",
      robotCode: "dingxxxx",
      processQueryKeys: [
        "b5fe11095fxxxx"
      ],
    });
    try {
      await client.orgGroupRecallWithOptions(orgGroupRecallRequest, orgGroupRecallHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes that 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 using 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.OrgGroupRecallHeaders orgGroupRecallHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupRecallHeaders();
            orgGroupRecallHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupRecallRequest orgGroupRecallRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupRecallRequest
            {
                OpenConversationId = "cidfCSxxxx",
                RobotCode = "dingxxxx",
                ProcessQueryKeys = new List<string>
                {
                    "b5fe11095fxxxx"
                },
            };
            try
            {
                client.OrgGroupRecallWithOptions(orgGroupRecallRequest, orgGroupRecallHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes that 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))
                {
                    // err contains code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
successResultArray of StringThe list of message IDs that were successfully recalled. Note No prompt appears in the chat window when a bot message is recalled.
failedResultMap<String, String>The list of message IDs that failed to be recalled, along with the reason for each failure.

Response body example

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

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

Error codes

If the API call returns an error, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400invalid.openConversationId%sInvalid openConversationId. Verify that the openConversationId is correct.
400invalidParameter.robotCode%sInvalid robotCode. Verify that the bot is in the group.
400invalidParameter.processQueryKeys.overMax%sprocessQueryKeys exceeds the maximum limit of 20. Split processQueryKeys into multiple arrays of no more than 20 entries each and call this API in batches.
400not.allowed.robotCode%sUnauthorized robotCode.
400invalidParameter.param.invalid%sInvalid parameter. Verify that no parameter is empty.
400invalidParameter.robotCode.notExsit%sThe bot does not exist. Verify that the bot corresponding to the robotCode is installed in the chat.
400miss.chatbotId%sMissing robotCode.
400invalidParameter.processQueryKey.missing%sMissing processQueryKey.
400invalid.processQueryKey%sInvalid processQueryKey. Verify that the processQueryKey is correct.
400miss.openConversationId%sMissing openConversationId.
400bot.stopped%sThe group bot has been disabled.
400template.not.existed%sThe bot template does not exist.
400template.stopped%sThe bot template has been disabled.
500system.error%sUnknown system error.