> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Tarik kembali pesan bot dalam obrolan satu lawan satu secara massal

> Panggil API ini untuk menarik kembali pesan bot dalam obrolan satu lawan satu secara massal berdasarkan ID percakapan, kode bot, dan daftar ID pesan — berguna untuk menarik pesan perusahaan yang terkirim keliru.

Panggil API ini untuk menarik kembali pesan bot dalam obrolan satu lawan satu secara massal berdasarkan ID obrolan, kode bot, dan daftar ID pesan. API ini cocok untuk skenario ketika pesan yang dikirim ke organisasi Anda perlu ditarik kembali karena kesalahan.

## Permintaan

### Informasi dasar

| Bidang                      | Value                                                                                                                                    |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| URL HTTP                    | [https://api.dingtalk.io/v1.0/robot/privateChatMessages/batchRecall](https://api.dingtalk.io/v1.0/robot/privateChatMessages/batchRecall) |
| Metode HTTP                 | POST                                                                                                                                     |
| Tipe aplikasi yang didukung | appType-Aplikasi internal　appType-Aplikasi perusahaan pihak ketiga                                                                       |
| Izin yang diperlukan        | permission-qyapi\_robot\_sendmsg-Izin bagi bot untuk mengirim pesan dalam organisasi Anda                                                |

### Header permintaan

| Nama                        | Tipe   | Wajib | Deskripsi                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| --------------------------- | ------ | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Ya    | Kredensial akses untuk memanggil API ini. Dapatkan dengan cara berikut:   - Untuk aplikasi internal, panggil API [Dapatkan access token aplikasi internal](/id/open/development/obtain-the-access-token-of-an-internal-app#). - Untuk aplikasi perusahaan pihak ketiga, panggil API [Dapatkan access token perusahaan yang telah memberikan otorisasi ke aplikasi pihak ketiga](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#). |

### Isi permintaan

| Nama               | Tipe            | Wajib | Deskripsi                                                                                                                                                                                                                                                                                                                                                                        |
| ------------------ | --------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| openConversationId | String          | Ya    | ID obrolan. Nilainya harus sama dengan openConversationId yang digunakan pada API [Kirim pesan teks biasa dalam obrolan satu lawan satu melalui bot](/id/open/development/the-robot-sends-ordinary-messages-in-a-person-to-person-conversation#) atau API [Buat dan kirim kartu](https://open.dingtalk.com/document/development/create-and-deliver-cards#).                      |
| robotCode          | String          | Ya    | Kode bot. Untuk informasi lebih lanjut, lihat [ID Bot](https://open.dingtalk.com/document/development/robot-overview#).  Nilainya harus sama dengan robotCode yang digunakan pada API [Kirim pesan teks biasa dalam obrolan satu lawan satu melalui bot](/id/open/development/the-robot-sends-ordinary-messages-in-a-person-to-person-conversation#).                            |
| processQueryKeys   | Array of String | Ya    | ID pesan.   - Untuk aplikasi internal, dapatkan nilai parameter `processQueryKey` dengan memanggil API [Buat dan kirim kartu](https://open.dingtalk.com/document/development/create-and-deliver-cards#) atau API [Kirim pesan teks biasa dalam obrolan satu lawan satu melalui bot](/id/open/development/the-robot-sends-ordinary-messages-in-a-person-to-person-conversation#). |

### Contoh permintaan

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /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" ]
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 berisi atribut code dan message yang membantu Anda memecahkan masalah
            }

        } 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 berisi atribut code dan message yang membantu Anda memecahkan masalah
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- 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 berisi atribut code dan message yang membantu Anda memecahkan masalah
                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 berisi atribut code dan message yang membantu Anda memecahkan masalah
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?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 berisi atribut code dan message yang membantu Anda memecahkan masalah
            }
        }
    }
}
$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

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 berisi atribut code dan message yang membantu Anda memecahkan masalah
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 berisi atribut code dan message yang membantu Anda memecahkan masalah
      }

    }    
  }

}

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

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 berisi atribut code dan message yang membantu Anda memecahkan masalah
                }
            }
            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 berisi atribut code dan message yang membantu Anda memecahkan masalah
                }
            }
        }

    }
}
```

## Respons

### Isi respons

| Nama          | Tipe                  | Deskripsi                                                         |
| ------------- | --------------------- | ----------------------------------------------------------------- |
| successResult | Array of String       | ID pesan yang berhasil ditarik kembali.                           |
| failedResult  | `Map<String, String>` | ID pesan yang gagal ditarik kembali, beserta alasan kegagalannya. |

### Contoh isi respons

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "successResult" : [ "5fe11095f46315d8d30d3f8XXXXXX" ],
  "failedResult" : {
    "key" : "SYSTEM_ERROR"
  }
}
```

### Kode error

Jika terjadi error saat Anda memanggil API ini, lihat dokumen [Kode error global](/id/open/development/server-api-error-codes-1) untuk menemukan solusi berdasarkan pesan error.

| HttpCode | Kode error                                | Pesan error | Deskripsi                                                                                                                                                                              |
| -------- | ----------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400      | invalid.openConversationId                | %s          | openConversationId tidak valid. Periksa apakah openConversationId sudah benar.                                                                                                         |
| 400      | invalidParameter.robotCode                | %s          | robotCode tidak valid. Periksa apakah bot ada di dalam obrolan.                                                                                                                        |
| 400      | invalidParameter.processQueryKeys.overMax | %s          | Jumlah processQueryKeys melebihi batas maksimum 20. Bagi processQueryKeys menjadi beberapa array, masing-masing berisi tidak lebih dari 20 item, lalu panggil API ini secara bertahap. |
| 400      | not.allowed.robotCode                     | %s          | robotCode tidak diberi otorisasi.                                                                                                                                                      |
| 400      | invalidParameter.param.invalid            | %s          | Parameter tidak valid. Periksa apakah parameter kosong.                                                                                                                                |
| 400      | invalidParameter.robotCode.notExsit       | %s          | Bot tidak ada. Periksa apakah bot yang sesuai dengan robotCode telah dipasang di dalam obrolan.                                                                                        |
| 400      | miss.chatbotId                            | %s          | robotCode tidak ada.                                                                                                                                                                   |
| 400      | invalidParameter.processQueryKey.missing  | %s          | processQueryKey tidak ada.                                                                                                                                                             |
| 400      | invalid.processQueryKey                   | %s          | processQueryKey tidak valid. Periksa apakah processQueryKey sudah benar.                                                                                                               |
| 400      | miss.openConversationId                   | %s          | openConversationId tidak ada.                                                                                                                                                          |
| 400      | bot.stopped                               | %s          | Bot grup telah dinonaktifkan.                                                                                                                                                          |
| 400      | template.not.existed                      | %s          | Templat bot tidak ada.                                                                                                                                                                 |
| 400      | template.stopped                          | %s          | Templat bot telah dinonaktifkan.                                                                                                                                                       |
| 400      | unauthorized                              | %s          | Tidak diberi otorisasi. Operasi tidak diizinkan.                                                                                                                                       |
| 400      | resource.not.found                        | %s          | Bot tidak ada.                                                                                                                                                                         |
| 500      | system.error                              | %s          | Error sistem yang tidak diketahui.                                                                                                                                                     |
