Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/robot/privateChatMessages/batchRecall |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-qyapi_robot_sendmsg-Permission for bots to send messages within your organization |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The 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 enterprise that has authorized a third-party app API. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| openConversationId | String | Yes | The chat ID. The value must be the same as the openConversationId used in the Send a plain message in a one-to-one chat through a bot API or the Create and deliver a card API. |
| robotCode | String | Yes | The bot code. For more information, see Bot ID. The value must be the same as the robotCode used in the Send a plain message in a one-to-one chat through a bot API. |
| processQueryKeys | Array of String | Yes | The message IDs. - For an internal app, obtain the processQueryKey parameter value by calling the Create and deliver a card API or the Send a plain message in a one-to-one chat through a bot API. |
Request example
HTTPPOST /v1.0/robot/privateChatMessages/batchRecall HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:8ca04016xxx
Content-Type:application/json
{
"openConversationId" : "cidfCSpXXXXXXXXXXXchatbotId",
"robotCode" : "dingzxcifuvdfbvegdf",
"processQueryKeys" : [ "b5fe11095f46315d8d30d3f8XXXXXX" ]
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
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 {
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.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();
com.aliyun.dingtalkrobot_1_0.models.BatchRecallPrivateChatHeaders batchRecallPrivateChatHeaders = new com.aliyun.dingtalkrobot_1_0.models.BatchRecallPrivateChatHeaders();
batchRecallPrivateChatHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkrobot_1_0.models.BatchRecallPrivateChatRequest batchRecallPrivateChatRequest = new com.aliyun.dingtalkrobot_1_0.models.BatchRecallPrivateChatRequest()
.setOpenConversationId("cidfCSpXXXXXXXXXXXchatbotId")
.setRobotCode("dingzxcifuvdfbvegdf")
.setProcessQueryKeys(java.util.Arrays.asList(
"b5fe11095f46315d8d30d3f8XXXXXX"
));
try {
client.batchRecallPrivateChatWithOptions(batchRecallPrivateChatRequest, batchRecallPrivateChatHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err contains the code and message attributes that help you troubleshoot issues
}
} 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 the code and message attributes that help you troubleshoot issues
}
}
}
}
# -*- 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_private_chat_headers = dingtalkrobot__1__0_models.BatchRecallPrivateChatHeaders()
batch_recall_private_chat_headers.x_acs_dingtalk_access_token = '<your access token>'
batch_recall_private_chat_request = dingtalkrobot__1__0_models.BatchRecallPrivateChatRequest(
open_conversation_id='cidfCSpXXXXXXXXXXXchatbotId',
robot_code='dingzxcifuvdfbvegdf',
process_query_keys=[
'b5fe11095f46315d8d30d3f8XXXXXX'
]
)
try:
client.batch_recall_private_chat_with_options(batch_recall_private_chat_request, batch_recall_private_chat_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains the code and message attributes that help you troubleshoot issues
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
batch_recall_private_chat_headers = dingtalkrobot__1__0_models.BatchRecallPrivateChatHeaders()
batch_recall_private_chat_headers.x_acs_dingtalk_access_token = '<your access token>'
batch_recall_private_chat_request = dingtalkrobot__1__0_models.BatchRecallPrivateChatRequest(
open_conversation_id='cidfCSpXXXXXXXXXXXchatbotId',
robot_code='dingzxcifuvdfbvegdf',
process_query_keys=[
'b5fe11095f46315d8d30d3f8XXXXXX'
]
)
try:
await client.batch_recall_private_chat_with_options_async(batch_recall_private_chat_request, batch_recall_private_chat_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains the code and message attributes that help you troubleshoot issues
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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\BatchRecallPrivateChatHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\BatchRecallPrivateChatRequest;
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();
$batchRecallPrivateChatHeaders = new BatchRecallPrivateChatHeaders([]);
$batchRecallPrivateChatHeaders->xAcsDingtalkAccessToken = "<your access token>";
$batchRecallPrivateChatRequest = new BatchRecallPrivateChatRequest([
"openConversationId" => "cidfCSpXXXXXXXXXXXchatbotId",
"robotCode" => "dingzxcifuvdfbvegdf",
"processQueryKeys" => [
"b5fe11095f46315d8d30d3f8XXXXXX"
]
]);
try {
$client->batchRecallPrivateChatWithOptions($batchRecallPrivateChatRequest, $batchRecallPrivateChatHeaders, 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 the code and message attributes that help you troubleshoot issues
}
}
}
}
$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/v2/service"
dingtalkrobot_1_0 "github.com/alibabacloud-go/dingtalk/robot_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/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
}
batchRecallPrivateChatHeaders := &dingtalkrobot_1_0.BatchRecallPrivateChatHeaders{}
batchRecallPrivateChatHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
batchRecallPrivateChatRequest := &dingtalkrobot_1_0.BatchRecallPrivateChatRequest{
OpenConversationId: tea.String("cidfCSpXXXXXXXXXXXchatbotId"),
RobotCode: tea.String("dingzxcifuvdfbvegdf"),
ProcessQueryKeys: []*string{tea.String("b5fe11095f46315d8d30d3f8XXXXXX")},
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.BatchRecallPrivateChatWithOptions(batchRecallPrivateChatRequest, batchRecallPrivateChatHeaders, &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 the code and message attributes that help you troubleshoot issues
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// 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 batchRecallPrivateChatHeaders = new $dingtalkrobot_1_0.BatchRecallPrivateChatHeaders({ });
batchRecallPrivateChatHeaders.xAcsDingtalkAccessToken = "<your access token>";
let batchRecallPrivateChatRequest = new $dingtalkrobot_1_0.BatchRecallPrivateChatRequest({
openConversationId: "cidfCSpXXXXXXXXXXXchatbotId",
robotCode: "dingzxcifuvdfbvegdf",
processQueryKeys: [
"b5fe11095f46315d8d30d3f8XXXXXX"
],
});
try {
await client.batchRecallPrivateChatWithOptions(batchRecallPrivateChatRequest, batchRecallPrivateChatHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains the code and message attributes that help you troubleshoot issues
}
}
}
}
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
{
/**
* 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.BatchRecallPrivateChatHeaders batchRecallPrivateChatHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchRecallPrivateChatHeaders();
batchRecallPrivateChatHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchRecallPrivateChatRequest batchRecallPrivateChatRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchRecallPrivateChatRequest
{
OpenConversationId = "cidfCSpXXXXXXXXXXXchatbotId",
RobotCode = "dingzxcifuvdfbvegdf",
ProcessQueryKeys = new List<string>
{
"b5fe11095f46315d8d30d3f8XXXXXX"
},
};
try
{
client.BatchRecallPrivateChatWithOptions(batchRecallPrivateChatRequest, batchRecallPrivateChatHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains the code and message attributes that help you troubleshoot issues
}
}
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 the code and message attributes that help you troubleshoot issues
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| successResult | Array of String | The IDs of the messages that were successfully recalled. |
| failedResult | Map<String, String> | The IDs of the messages that failed to be recalled, along with the reasons for failure. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"successResult" : [ "5fe11095f46315d8d30d3f8XXXXXX" ],
"failedResult" : {
"key" : "SYSTEM_ERROR"
}
}
Error codes
If an error is returned when you call this API, refer to the Global error codes document to find a solution based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | invalid.openConversationId | %s | Invalid openConversationId. Check whether the openConversationId is correct. |
| 400 | invalidParameter.robotCode | %s | Invalid robotCode. Check whether the bot is in the chat. |
| 400 | invalidParameter.processQueryKeys.overMax | %s | The number of processQueryKeys exceeds the upper limit of 20. Split processQueryKeys into multiple arrays, each containing no more than 20 items, and call this API in batches. |
| 400 | not.allowed.robotCode | %s | Unauthorized robotCode. |
| 400 | invalidParameter.param.invalid | %s | Invalid parameter. Check whether the parameter is empty. |
| 400 | invalidParameter.robotCode.notExsit | %s | The bot does not exist. Check whether the bot corresponding to the robotCode is installed in the chat. |
| 400 | miss.chatbotId | %s | robotCode is missing. |
| 400 | invalidParameter.processQueryKey.missing | %s | processQueryKey is missing. |
| 400 | invalid.processQueryKey | %s | Invalid processQueryKey. Check whether the processQueryKey is correct. |
| 400 | miss.openConversationId | %s | openConversationId is missing. |
| 400 | bot.stopped | %s | The group bot has been disabled. |
| 400 | template.not.existed | %s | The bot template does not exist. |
| 400 | template.stopped | %s | The bot template has been disabled. |
| 400 | unauthorized | %s | Unauthorized. The operation is not allowed. |
| 400 | resource.not.found | %s | The bot does not exist. |
| 500 | system.error | %s | Unknown system error. |