企业机器人撤回内部群消息

调用本接口可用于实现企业机器人撤回内部群消息，适用于批量撤回群聊机器人消息发送错误的场景。

请求

基本信息

字段	值
HTTP URL	https://api.dingtalk.io/v1.0/robot/groupMessages/recall
HTTP Method	POST
支持的应用类型	appType-企业内部应用　appType-第三方企业应用
权限要求	permission-qyapi_robot_sendmsg-企业内机器人发送消息权限

请求头

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

请求体

名称	类型	是否必填	描述
openConversationId	String	是	群ID，可通过客户端 chooseChat获取群会话 openConversationId。需要与机器人发送群聊消息接口时使用的openConversationId一致。
robotCode	String	是	机器人的编码，可参考机器人 ID。需要与机器人发送群聊消息接口时使用的robotCode一致。
processQueryKeys	Array of String	是	消息ID列表，可通过机器人发送群聊消息接口返回参数processQueryKey字段中获取。

请求示例

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 {

    /**
     * 使用 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();
        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 中含有 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()
        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 中含有 code 和 message 属性，可帮助开发定位问题
                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 中含有 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\OrgGroupRecallHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\OrgGroupRecallRequest;
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();
        $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 中含有 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));

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

  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 中含有 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 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 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

Client.main(process.argv.slice(2));

// 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.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 中含有 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 属性，可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称	类型	描述
successResult	Array of String	撤回成功的消息ID列表。说明撤回机器人发送的消息，在聊天框中没有提示。
failedResult	`Map<String, String>`	撤回失败的消息ID列表及原因。

响应体示例

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

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

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

HttpCode	错误码	错误信息	说明
400	invalid.openConversationId	%s	无效的openConversationId，请检查openConversationId是否正确
400	invalidParameter.robotCode	%s	无效的robotCode，请检查机器人是否在群内
400	invalidParameter.processQueryKeys.overMax	%s	processQueryKeys超过数量上限20，请将processQueryKeys拆分成多个长度不超过20的数组，分批次调用此接口
400	not.allowed.robotCode	%s	未被授权的robotCode
400	invalidParameter.param.invalid	%s	参数不合法，请检查参数是否为空
400	invalidParameter.robotCode.notExsit	%s	机器人不存在，请检查会话内是否安装了robotCode对应的机器人
400	miss.chatbotId	%s	缺少robotCode
400	invalidParameter.processQueryKey.missing	%s	缺少processQueryKey
400	invalid.processQueryKey	%s	无效的processQueryKey，请检查processQueryKey是否正确
400	miss.openConversationId	%s	缺少openConversationId
400	bot.stopped	%s	群机器人已经停用
400	template.not.existed	%s	机器人模板不存在
400	template.stopped	%s	机器人模板已经停用
500	system.error	%s	未知的系统错误

API 调用指南

认证与授权

通讯录管理

日程

音视频

AI 表格

文档/文件

即时通信

企业机器人撤回内部群消息

请求

基本信息

请求头

请求体

请求示例

响应

响应体

响应体示例

错误码

​请求

​基本信息

​请求头

​请求体

​请求示例

​响应

​响应体

​响应体示例

​错误码

请求

基本信息

请求头

请求体

请求示例

响应

响应体

响应体示例

错误码