Skip to main content
Call this API to batch query the read status of bot messages sent in one-on-one chats between users and bots. This is useful for internal communication scenarios where you need to confirm whether a message has been read within 24 hours.

API call description

  • You can query the read status for up to 20 recipients of a single one-on-one chat message at a time.
  • If you send an HTTP request directly, URL-encode the processQueryKey parameter first, and then append the encoded value to the URL.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/robot/oToMessages/readStatus
HTTP MethodGET
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-qyapi_robot_sendmsg-Permission to send messages from bots within your organization

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call 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.

Query parameters

NameTypeRequiredDescription
robotCodeStringYesThe bot code. For details, see Bot ID.
processQueryKeyStringYesThe unique identifier of the message. You can obtain it from the processQueryKey field returned by the Batch send bot messages in one-on-one chats API. You can query the read status using processQueryKey within 24 hours after the message is sent. Queries are not supported after 24 hours.

Request example

HTTP
GET /v1.0/robot/oToMessages/readStatus?robotCode=dingzxcifuvdfbvegdf&processQueryKey=xxxxxxxxxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxxxxx
Content-Type:application/json
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 using 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();
        BatchOTOQueryHeaders batchOTOQueryHeaders = new BatchOTOQueryHeaders();
        batchOTOQueryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        BatchOTOQueryRequest batchOTOQueryRequest = new BatchOTOQueryRequest()
                .setRobotCode("dingzxcifuvdfbvegdf")
                .setProcessQueryKey("xxxxxxxxxxxxx");
        try {
            client.batchOTOQueryWithOptions(batchOTOQueryRequest, batchOTOQueryHeaders, 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 using 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_otoquery_headers = dingtalkrobot__1__0_models.BatchOTOQueryHeaders()
        batch_otoquery_headers.x_acs_dingtalk_access_token = '<your access token>'
        batch_otoquery_request = dingtalkrobot__1__0_models.BatchOTOQueryRequest(
            robot_code='dingzxcifuvdfbvegdf',
            process_query_key='xxxxxxxxxxxxx'
        )
        try:
            client.batch_otoquery_with_options(batch_otoquery_request, batch_otoquery_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()
        batch_otoquery_headers = dingtalkrobot__1__0_models.BatchOTOQueryHeaders()
        batch_otoquery_headers.x_acs_dingtalk_access_token = '<your access token>'
        batch_otoquery_request = dingtalkrobot__1__0_models.BatchOTOQueryRequest(
            robot_code='dingzxcifuvdfbvegdf',
            process_query_key='xxxxxxxxxxxxx'
        )
        try:
            await client.batch_otoquery_with_options_async(batch_otoquery_request, batch_otoquery_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\BatchOTOQueryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\BatchOTOQueryRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client using 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();
        $batchOTOQueryHeaders = new BatchOTOQueryHeaders([]);
        $batchOTOQueryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $batchOTOQueryRequest = new BatchOTOQueryRequest([
            "robotCode" => "dingzxcifuvdfbvegdf",
            "processQueryKey" => "xxxxxxxxxxxxx"
        ]);
        try {
            $client->batchOTOQueryWithOptions($batchOTOQueryRequest, $batchOTOQueryHeaders, 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));
Go
// 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 using 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
  }

  batchOTOQueryHeaders := &dingtalkrobot_1_0.BatchOTOQueryHeaders{}
  batchOTOQueryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  batchOTOQueryRequest := &dingtalkrobot_1_0.BatchOTOQueryRequest{
    RobotCode: tea.String("dingzxcifuvdfbvegdf"),
    ProcessQueryKey: tea.String("xxxxxxxxxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.BatchOTOQueryWithOptions(batchOTOQueryRequest, batchOTOQueryHeaders, &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 using 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 batchOTOQueryHeaders = new $dingtalkrobot_1_0.BatchOTOQueryHeaders({ });
    batchOTOQueryHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let batchOTOQueryRequest = new $dingtalkrobot_1_0.BatchOTOQueryRequest({
      robotCode: "dingzxcifuvdfbvegdf",
      processQueryKey: "xxxxxxxxxxxxx",
    });
    try {
      await client.batchOTOQueryWithOptions(batchOTOQueryRequest, batchOTOQueryHeaders, 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));
C#
// 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 using 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.BatchOTOQueryHeaders batchOTOQueryHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchOTOQueryHeaders();
            batchOTOQueryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchOTOQueryRequest batchOTOQueryRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.BatchOTOQueryRequest
            {
                RobotCode = "dingzxcifuvdfbvegdf",
                ProcessQueryKey = "xxxxxxxxxxxxx",
            };
            try
            {
                client.BatchOTOQueryWithOptions(batchOTOQueryRequest, batchOTOQueryHeaders, 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
                }
            }
        }

    }
}
C
// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkrobot__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkrobot_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkrobot_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkrobot_1_0::Client> client = make_shared<Alibabacloud_Dingtalkrobot_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkrobot_1_0::BatchOTOQueryHeaders> batchOTOQueryHeaders = make_shared<Alibabacloud_Dingtalkrobot_1_0::BatchOTOQueryHeaders>();
  batchOTOQueryHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkrobot_1_0::BatchOTOQueryRequest> batchOTOQueryRequest = make_shared<Alibabacloud_Dingtalkrobot_1_0::BatchOTOQueryRequest>(map<string, boost::any>({
    {"robotCode", boost::any(string("dingzxcifuvdfbvegdf"))},
    {"processQueryKey", boost::any(string("xxxxxxxxxxxxx"))}
  }));
  try {
    client->batchOTOQueryWithOptions(batchOTOQueryRequest, batchOTOQueryHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err contains code and message attributes that help you locate the issue
    }
  }
}

Response

Response body

NameTypeDescription
sendStatusStringThe message sending status: - SUCCESS: The message was sent successfully. - RECALLED: The message has been recalled. - PROCESSING: The message is being processed.
messageReadInfoListArrayThe read status of the message.
nameStringThe name of the message recipient.
userIdStringThe userId of the message recipient.
readStatusStringThe read status: - READ: Read. - UNREAD: Unread.
readTimestampLongNot supported at this time.

Response body example

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

{
  "sendStatus" : "SUCESS",
  "messageReadInfoList" : [ {
    "name" : "John Smith",
    "userId" : "201382020",
    "readStatus" : "READ"
  } ]
}

Error codes

If an error occurs when you call this API, look up the error message in the Global error codes document for the solution.
HttpCodeError codeError messageDescription
400invalidParameter.robotCode.empty%sThe bot robotCode is invalid.
400invalidParameter.param.invalid%sInvalid parameter. Check whether the parameter is empty.
400invalidParameter.robotCode.notExsit%sThe bot does not exist.
400unknown.send.result%sUnknown send result.
400invalidParameter.robotCode.missing%sThe robotCode is missing.
400invalidParameter.processQueryKey.missing%sThe processQueryKey is missing.
400invalidParameter.robotCode.invalid%sThe bot does not exist. Check whether the bot corresponding to robotCode is installed in your organization.
400invalid.processQueryKey%sInvalid processQueryKey. Check whether the processQueryKey is correct.
400template.not.existed%sThe bot template does not exist.
400template.stopped%sThe bot template has been disabled.
400processQueryKey.expireTime%sThe processQueryKey has not yet generated message query data or has expired. The message cannot be queried.
500system.error%sThe system is busy. Try again later.