Query the read status of an enterprise bot's group chat message

Call this API to retrieve information such as the message delivery status and the userIds of users who have read the message. For example, after an enterprise bot sends a group chat message in an internal group chat, you can use this API to query the userIds of users who have read the message.

Request

Basic information

Field	Value
HTTP URL	https://api.dingtalk.io/v1.0/robot/groupMessages/query
HTTP Method	POST
Supported app types	appType-Internal app　appType-Third-party enterprise app
Required permissions	permission-qyapi_robot_sendmsg-Permission for an internal bot to send messages

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 authorized enterprise for a third-party app API.

Request body

Name	Type	Required	Description
openConversationId	String	No	The group ID. Obtain the openConversationId of a group chat through the client-side chooseChat JSAPI. This must be the same as the openConversationId used in the Send a group chat message with a bot API.
robotCode	String	No	The bot code. For more information, see Bot ID. This must be the same as the robotCode used in the Send a group chat message with a bot API.
processQueryKey	String	Yes	The unique identifier of the message. Obtain it from the processQueryKey field in the response of the Send a group chat message with a bot API.
maxResults	Long	No	The number of items per page for the paginated query. The maximum value is 200.
nextToken	String	No	The pagination cursor. Leave it empty to start the query from the first page.

Request example

HTTP

POST /v1.0/robot/groupMessages/query HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:qkopsdangcfoonacviojsdjn
Content-Type:application/json

{
  "openConversationId" : "cid6KeBBL****5x7EeiodoA==",
  "robotCode" : "dingue****yn0pjqd",
  "processQueryKey" : "Kna29Ra5p*****DzgfxZLapw55G7x0Q=",
  "maxResults" : 50,
  "nextToken" : "50"
}

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 {

    /**
     * Initialize the account Client with a Token
     * @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();
        OrgGroupQueryHeaders orgGroupQueryHeaders = new OrgGroupQueryHeaders();
        orgGroupQueryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        OrgGroupQueryRequest orgGroupQueryRequest = new OrgGroupQueryRequest()
                .setOpenConversationId("cid6KeBBLoveMJOGXoYKF5x7EeiodoA==")
                .setRobotCode("dingue4kfzdxbyn0pjqd")
                .setProcessQueryKey("Kna29Ra5pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=")
                .setMaxResults(50L)
                .setNextToken("50");
        try {
            client.orgGroupQueryWithOptions(orgGroupQueryRequest, orgGroupQueryHeaders, new 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 you locate the issue
            }

        } 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 you locate the issue
            }

        }        
    }
}

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()
        org_group_query_headers = dingtalkrobot__1__0_models.OrgGroupQueryHeaders()
        org_group_query_headers.x_acs_dingtalk_access_token = '<your access token>'
        org_group_query_request = dingtalkrobot__1__0_models.OrgGroupQueryRequest(
            open_conversation_id='cid6KeBBLoveMJOGXoYKF5x7EeiodoA==',
            robot_code='dingue4kfzdxbyn0pjqd',
            process_query_key='Kna29Ra5pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=',
            max_results=50,
            next_token='50'
        )
        try:
            client.org_group_query_with_options(org_group_query_request, org_group_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 you locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        org_group_query_headers = dingtalkrobot__1__0_models.OrgGroupQueryHeaders()
        org_group_query_headers.x_acs_dingtalk_access_token = '<your access token>'
        org_group_query_request = dingtalkrobot__1__0_models.OrgGroupQueryRequest(
            open_conversation_id='cid6KeBBLoveMJOGXoYKF5x7EeiodoA==',
            robot_code='dingue4kfzdxbyn0pjqd',
            process_query_key='Kna29Ra5pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=',
            max_results=50,
            next_token='50'
        )
        try:
            await client.org_group_query_with_options_async(org_group_query_request, org_group_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 you locate the issue
                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\OrgGroupQueryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\OrgGroupQueryRequest;
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();
        $orgGroupQueryHeaders = new OrgGroupQueryHeaders([]);
        $orgGroupQueryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $orgGroupQueryRequest = new OrgGroupQueryRequest([
            "openConversationId" => "cid6KeBBLoveMJOGXoYKF5x7EeiodoA==",
            "robotCode" => "dingue4kfzdxbyn0pjqd",
            "processQueryKey" => "Kna29Ra5pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=",
            "maxResults" => 50,
            "nextToken" => "50"
        ]);
        try {
            $client->orgGroupQueryWithOptions($orgGroupQueryRequest, $orgGroupQueryHeaders, 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 you locate the issue
            }
        }
    }
}
$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"
)

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

  orgGroupQueryHeaders := &dingtalkrobot_1_0.OrgGroupQueryHeaders{}
  orgGroupQueryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  orgGroupQueryRequest := &dingtalkrobot_1_0.OrgGroupQueryRequest{
    OpenConversationId: tea.String("cid6KeBBLoveMJOGXoYKF5x7EeiodoA=="),
    RobotCode: tea.String("dingue4kfzdxbyn0pjqd"),
    ProcessQueryKey: tea.String("Kna29Ra5pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q="),
    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.OrgGroupQueryWithOptions(orgGroupQueryRequest, orgGroupQueryHeaders, &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 you locate the issue
    }

  }
  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 orgGroupQueryHeaders = new $dingtalkrobot_1_0.OrgGroupQueryHeaders({ });
    orgGroupQueryHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let orgGroupQueryRequest = new $dingtalkrobot_1_0.OrgGroupQueryRequest({
      openConversationId: "cid6KeBBLoveMJOGXoYKF5x7EeiodoA==",
      robotCode: "dingue4kfzdxbyn0pjqd",
      processQueryKey: "Kna29Ra5pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=",
      maxResults: 50,
      nextToken: "50",
    });
    try {
      await client.orgGroupQueryWithOptions(orgGroupQueryRequest, orgGroupQueryHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes that help you locate the issue
      }

    }    
  }

}

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.OrgGroupQueryHeaders orgGroupQueryHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupQueryHeaders();
            orgGroupQueryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupQueryRequest orgGroupQueryRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupQueryRequest
            {
                OpenConversationId = "cid6KeBBLoveMJOGXoYKF5x7EeiodoA==",
                RobotCode = "dingue4kfzdxbyn0pjqd",
                ProcessQueryKey = "Kna29Ra5pdJznx1ghavbumkQKwDzgfxZLapw55G7x0Q=",
                MaxResults = 50,
                NextToken = "50",
            };
            try
            {
                client.OrgGroupQueryWithOptions(orgGroupQueryRequest, orgGroupQueryHeaders, 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 you locate the issue
                }
            }
            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 you locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
sendStatus	String	The message delivery status: - SUCCESS: delivered successfully. - RECALLED: recalled. - PROCESSING: in progress.
readUserIds	Array of String	The userIds of users who have read the message.
nextToken	String	The cursor for the next paginated query.
hasMore	Boolean	Indicates whether more users are available for querying the read status in the paginated query.

Response body example

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

{
  "sendStatus" : "SUCCESS",
  "readUserIds" : [ "manager1234" ],
  "nextToken" : "Kna29Ra5pdJ****mkQKwDzgfxZLapw55G7x0Q=",
  "hasMore" : true
}

Error codes

If an error is returned when you call this API, look up the solution in the Global error codes document 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	The bot does not exist	The bot does not exist. Check whether the bot is in the group.
400	invalidParameter.robotCode.missing	robotCode is missing	robotCode is missing.
400	invalidParameter.processQueryKey.missing	processQueryKey is missing	processQueryKey is missing.
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.invalid	The bot corresponding to the token does not exist	The bot corresponding to the token does not exist. Check whether the bot is in the group.
400	invalidParameter.robotCode.invalid	Invalid robotCode	Invalid robotCode.
400	invalid.openConversationId	Invalid openConversationId	Invalid openConversationId.
400	openConversationId.notExisted	openConversationId and token cannot both be empty	openConversationId and token cannot both be 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	The bot template does not exist	The bot template does not exist.
400	template.stopped	The bot template has been disabled	The bot template has been disabled.
400	processQueryKey.expireTime	processQueryKey has not generated message query data yet or has expired	processQueryKey has not generated message query data yet 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.

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

Query the read status of an enterprise bot's group chat message

Request

Basic information

Request header

Request body

Request example

Response

Response body

Response body example

Error codes

​Request

​Basic information

​Request header

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes

Request

Basic information

Request header

Request body

Request example

Response

Response body

Response body example

Error codes