> ## 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.

# Kueri daftar pembaca pesan Bot dalam obrolan satu lawan satu

> Panggil API ini untuk mengueri daftar pembaca pesan Bot dalam obrolan satu lawan satu berdasarkan ID grup, kode Bot, dan ID pesan — cocok untuk memastikan pesan Bot sudah dibaca dalam komunikasi obrolan pribadi.

Panggil API ini untuk mengueri daftar pembaca pesan Bot dalam obrolan satu lawan satu berdasarkan ID grup, kode Bot, dan ID pesan. API ini berlaku untuk skenario ketika Anda perlu memastikan apakah sebuah pesan Bot sudah dibaca selama komunikasi pesan langsung antaranggota di dalam organisasi Anda.

## Permintaan

### Informasi dasar

| Bidang                      | Nilai                                                                                                                        |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| URL HTTP                    | [https://api.dingtalk.io/v1.0/robot/privateChatMessages/query](https://api.dingtalk.io/v1.0/robot/privateChatMessages/query) |
| 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 dalam organisasi Anda untuk mengirim pesan                                    |

### 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 [Mendapatkan access token aplikasi internal](/id/open/development/obtain-the-access-token-of-an-internal-app#). - Untuk aplikasi perusahaan pihak ketiga, panggil API [Mendapatkan access token organisasi resmi untuk 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 | Tidak | ID percakapan terbuka untuk obrolan satu lawan satu. Dapatkan nilainya dengan memanggil [Menginstal Mini App secara massal ke obrolan pesan langsung](https://open.dingtalk.com/document/development/batch-chat-session#) dan berlangganan [Peristiwa manajemen obrolan](https://open.dingtalk.com/document/development/org-event-overview#260a4e7084gs2) untuk memperoleh OpenConversationId. |
| robotCode          | String | Tidak | Kode Bot. Untuk detailnya, lihat [ID Bot](https://open.dingtalk.com/document/development/robot-overview#).                                                                                                                                                                                                                                                                                     |
| processQueryKey    | String | Ya    | ID pesan. Dapatkan nilai `processQueryKey` dengan memanggil API [Membuat dan mengirim kartu](https://open.dingtalk.com/document/development/create-and-deliver-cards#) atau API [Mengirim pesan teks biasa melalui Bot dalam obrolan satu lawan satu](/id/open/development/the-robot-sends-ordinary-messages-in-a-person-to-person-conversation#).                                             |
| maxResults         | Long   | Tidak | Jumlah item per halaman dalam kueri berpaginasi.                                                                                                                                                                                                                                                                                                                                               |
| nextToken          | String | Tidak | Kredensial paginasi terenkripsi yang dikembalikan dari kueri sebelumnya. Kosongkan bidang ini untuk kueri pertama.                                                                                                                                                                                                                                                                             |

### Contoh permintaan

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/robot/privateChatMessages/query HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:8ca04016xxx
Content-Type:application/json

{
  "openConversationId" : "cid6KeBBLo******7EeiodoA==",
  "robotCode" : "ding******dxbyn0pjqd",
  "processQueryKey" : "Kna******pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=",
  "maxResults" : 50,
  "nextToken" : "50"
}
```

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.PrivateChatQueryHeaders privateChatQueryHeaders = new com.aliyun.dingtalkrobot_1_0.models.PrivateChatQueryHeaders();
        privateChatQueryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrobot_1_0.models.PrivateChatQueryRequest privateChatQueryRequest = new com.aliyun.dingtalkrobot_1_0.models.PrivateChatQueryRequest()
                .setOpenConversationId("cid6KeBBLo******7EeiodoA==")
                .setRobotCode("ding******dxbyn0pjqd")
                .setProcessQueryKey("Kna******pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=")
                .setMaxResults(50L)
                .setNextToken("50");
        try {
            client.privateChatQueryWithOptions(privateChatQueryRequest, privateChatQueryHeaders, 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 mendiagnosis 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 mendiagnosis 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()
        private_chat_query_headers = dingtalkrobot__1__0_models.PrivateChatQueryHeaders()
        private_chat_query_headers.x_acs_dingtalk_access_token = '<your access token>'
        private_chat_query_request = dingtalkrobot__1__0_models.PrivateChatQueryRequest(
            open_conversation_id='cid6KeBBLo******7EeiodoA==',
            robot_code='ding******dxbyn0pjqd',
            process_query_key='Kna******pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=',
            max_results=50,
            next_token='50'
        )
        try:
            client.private_chat_query_with_options(private_chat_query_request, private_chat_query_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 mendiagnosis masalah
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        private_chat_query_headers = dingtalkrobot__1__0_models.PrivateChatQueryHeaders()
        private_chat_query_headers.x_acs_dingtalk_access_token = '<your access token>'
        private_chat_query_request = dingtalkrobot__1__0_models.PrivateChatQueryRequest(
            open_conversation_id='cid6KeBBLo******7EeiodoA==',
            robot_code='ding******dxbyn0pjqd',
            process_query_key='Kna******pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=',
            max_results=50,
            next_token='50'
        )
        try:
            await client.private_chat_query_with_options_async(private_chat_query_request, private_chat_query_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 mendiagnosis 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\PrivateChatQueryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\PrivateChatQueryRequest;
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();
        $privateChatQueryHeaders = new PrivateChatQueryHeaders([]);
        $privateChatQueryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $privateChatQueryRequest = new PrivateChatQueryRequest([
            "openConversationId" => "cid6KeBBLo******7EeiodoA==",
            "robotCode" => "ding******dxbyn0pjqd",
            "processQueryKey" => "Kna******pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=",
            "maxResults" => 50,
            "nextToken" => "50"
        ]);
        try {
            $client->privateChatQueryWithOptions($privateChatQueryRequest, $privateChatQueryHeaders, 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 mendiagnosis 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
  }

  privateChatQueryHeaders := &dingtalkrobot_1_0.PrivateChatQueryHeaders{}
  privateChatQueryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  privateChatQueryRequest := &dingtalkrobot_1_0.PrivateChatQueryRequest{
    OpenConversationId: tea.String("cid6KeBBLo******7EeiodoA=="),
    RobotCode: tea.String("ding******dxbyn0pjqd"),
    ProcessQueryKey: tea.String("Kna******pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q="),
    MaxResults: tea.Int64(50),
    NextToken: tea.String("50"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.PrivateChatQueryWithOptions(privateChatQueryRequest, privateChatQueryHeaders, &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 mendiagnosis 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 privateChatQueryHeaders = new $dingtalkrobot_1_0.PrivateChatQueryHeaders({ });
    privateChatQueryHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let privateChatQueryRequest = new $dingtalkrobot_1_0.PrivateChatQueryRequest({
      openConversationId: "cid6KeBBLo******7EeiodoA==",
      robotCode: "ding******dxbyn0pjqd",
      processQueryKey: "Kna******pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=",
      maxResults: 50,
      nextToken: "50",
    });
    try {
      await client.privateChatQueryWithOptions(privateChatQueryRequest, privateChatQueryHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err berisi atribut code dan message yang membantu mendiagnosis 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.PrivateChatQueryHeaders privateChatQueryHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.PrivateChatQueryHeaders();
            privateChatQueryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.PrivateChatQueryRequest privateChatQueryRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.PrivateChatQueryRequest
            {
                OpenConversationId = "cid6KeBBLo******7EeiodoA==",
                RobotCode = "ding******dxbyn0pjqd",
                ProcessQueryKey = "Kna******pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=",
                MaxResults = 50,
                NextToken = "50",
            };
            try
            {
                client.PrivateChatQueryWithOptions(privateChatQueryRequest, privateChatQueryHeaders, 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 mendiagnosis 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 mendiagnosis masalah
                }
            }
        }

    }
}
```

## Respons

### Isi respons

| Nama        | Tipe            | Deskripsi                                                                                                            |
| ----------- | --------------- | -------------------------------------------------------------------------------------------------------------------- |
| sendStatus  | String          | Status pengiriman pesan.   - SUCCESS: Berhasil terkirim. - RECALLED: Ditarik kembali. - PROCESSING: Sedang diproses. |
| readUserIds | Array of String | Daftar userId pengguna yang telah membaca pesan.                                                                     |
| nextToken   | String          | Kredensial terenkripsi untuk kueri berpaginasi berikutnya.                                                           |
| hasMore     | Boolean         | Menunjukkan apakah masih ada hasil lain yang tersedia untuk kueri berpaginasi.                                       |

### Contoh isi respons

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

{
  "sendStatus" : "SUCCESS",
  "readUserIds" : [ "123xxxx" ],
  "nextToken" : "Kna29******znx1ghavbumkQKwDzgfxZLapw55G7x0Q=",
  "hasMore" : true
}
```

### Kode error

Jika terjadi error saat 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      | invalidParameter.param.invalid           | Invalid parameter                                                       | Parameter tidak valid. Periksa apakah parameter kosong.                                                |
| 400      | invalidParameter.robotCode.notExsit      | Bot does not exist                                                      | Bot tidak ada. Periksa apakah Bot berada di dalam grup.                                                |
| 400      | invalidParameter.robotCode.missing       | Missing robotCode                                                       | robotCode tidak ada.                                                                                   |
| 400      | invalidParameter.processQueryKey.missing | Missing processQueryKey                                                 | processQueryKey tidak ada.                                                                             |
| 400      | invalidParameter.cursor.invalid          | Invalid nextToken                                                       | nextToken tidak valid. Periksa apakah nextToken sudah benar.                                           |
| 400      | invalidParameter.pageSize.invalid        | Invalid maxResults                                                      | maxResults melebihi batas maksimum 200.                                                                |
| 400      | invalidParameter.robotCode.invalid       | Invalid robotCode                                                       | robotCode tidak valid.                                                                                 |
| 400      | invalid.openConversationId               | Invalid openConversationId                                              | openConversationId tidak valid.                                                                        |
| 400      | openConversationId.notExisted            | openConversationId is empty                                             | openConversationId kosong.                                                                             |
| 400      | invalid.processQueryKey                  | Invalid processQueryKey                                                 | processQueryKey tidak valid.                                                                           |
| 400      | bot.stopped                              | The Group bot has been disabled                                         | Bot grup telah dinonaktifkan.                                                                          |
| 400      | template.not.existed                     | Bot template does not exist                                             | Templat Bot tidak ada.                                                                                 |
| 400      | template.stopped                         | Bot template has been disabled                                          | Templat Bot telah dinonaktifkan.                                                                       |
| 400      | processQueryKey.expireTime               | processQueryKey has not yet generated message query data or has expired | processQueryKey belum menghasilkan data kueri pesan atau telah kedaluwarsa. Pesan tidak dapat dikueri. |
| 400      | conversation.org.dismatch                | The chat does not belong to the current organization                    | Obrolan tidak termasuk dalam organisasi saat ini.                                                      |
| 400      | resource.not.found                       | %s                                                                      | Bot tidak ada.                                                                                         |
| 400      | unauthorized                             | %s                                                                      | Tidak diizinkan.                                                                                       |
| 400      | auth.error                               | %s                                                                      | Izin tidak memadai. Operasi tidak diizinkan.                                                           |
| 500      | system.error                             | Unknown system error                                                    | Error sistem tidak diketahui.                                                                          |
