Query the read list of Bot messages in a one-to-one chat

Call this API to query the read list of Bot messages in a one-to-one chat based on the group ID, Bot code, and message ID. This API applies to scenarios where you need to confirm whether a Bot message has been read during direct message communication between users in your organization.

Request

Basic information

Field	Value
HTTP URL	https://api.dingtalk.io/v1.0/robot/privateChatMessages/query
HTTP Method	POST
Supported app types	appType-Internal app　appType-Third-party enterprise app
Required permissions	permission-qyapi_robot_sendmsg-Permission for Bots in your organization to send messages

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. Obtain it as follows: - For internal apps, call the Obtain the access token of an internal app API. - For third-party enterprise apps, call the Obtain the access token of an authorized organization for a third-party app API.

Request body

Name	Type	Required	Description
openConversationId	String	No	The open conversation ID for the one-to-one chat. Obtain its value by calling Batch install a Mini App into direct message chats and subscribing to Chat management events to get the OpenConversationId.
robotCode	String	No	The Bot code. For details, see Bot ID.
processQueryKey	String	Yes	The message ID. Obtain the `processQueryKey` value by calling the Create and deliver a card API or the Send a plain message via a Bot in a one-to-one chat API.
maxResults	Long	No	The number of items per page in a paginated query.
nextToken	String	No	The encrypted pagination credential returned from the previous query. Leave this empty for the first query.

Request example

HTTP

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

// 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 contains code and message attributes that help diagnose 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 code and message attributes that help diagnose issues
            }

        }        
    }
}

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 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 contains code and message attributes that help diagnose issues
                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 contains code and message attributes that help diagnose issues
                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\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 contains code and message attributes that help diagnose 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
  }

  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 contains code and message attributes that help diagnose issues
    }

  }
  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 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 contains code and message attributes that help diagnose 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.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 contains code and message attributes that help diagnose 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 code and message attributes that help diagnose issues
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
sendStatus	String	The message send status. - SUCCESS: Sent successfully. - RECALLED: Recalled. - PROCESSING: In progress.
readUserIds	Array of String	The list of userIds of users who have read the message.
nextToken	String	The encrypted credential for the next paginated query.
hasMore	Boolean	Indicates whether more results are available for the paginated query.

Response body example

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

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

Error codes

If an error occurs when calling 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	invalidParameter.param.invalid	Invalid parameter	Invalid parameter. Check whether the parameter is empty.
400	invalidParameter.robotCode.notExsit	Bot does not exist	The Bot does not exist. Check whether the Bot is in the group.
400	invalidParameter.robotCode.missing	Missing robotCode	Missing robotCode.
400	invalidParameter.processQueryKey.missing	Missing processQueryKey	Missing processQueryKey.
400	invalidParameter.cursor.invalid	Invalid nextToken	Invalid nextToken. Check whether nextToken is correct.
400	invalidParameter.pageSize.invalid	Invalid maxResults	maxResults exceeds the upper limit of 200.
400	invalidParameter.robotCode.invalid	Invalid robotCode	Invalid robotCode.
400	invalid.openConversationId	Invalid openConversationId	Invalid openConversationId.
400	openConversationId.notExisted	openConversationId is empty	openConversationId is empty.
400	invalid.processQueryKey	Invalid processQueryKey	Invalid processQueryKey.
400	bot.stopped	The Group bot has been disabled	The Group bot has been disabled.
400	template.not.existed	Bot template does not exist	The Bot template does not exist.
400	template.stopped	Bot template has been disabled	The Bot template has been disabled.
400	processQueryKey.expireTime	processQueryKey has not yet generated message query data or has expired	processQueryKey has not yet generated message query data or has expired. The message cannot be queried.
400	conversation.org.dismatch	The chat does not belong to the current organization	The chat does not belong to the current organization.
400	resource.not.found	%s	The Bot does not exist.
400	unauthorized	%s	Unauthorized.
400	auth.error	%s	Insufficient permissions. The operation is not allowed.
500	system.error	Unknown system error	Unknown system error.

​Request

​Basic information

​Request headers

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes