人とボットのチャットにおけるボットメッセージの既読状態を一括照会

本 API を呼び出すことで、人とボットのチャットにおけるボットメッセージの既読状態を一括照会できます。社内コミュニケーションにおいて、24 時間以内にメッセージが既読かどうかを確認する必要があるシーンに適しています。

API 呼び出し説明

1 回のリクエストで、1 件の個別チャットメッセージにつき最大 20 名の受信者の既読データを照会できます。
直接 HTTP リクエストを発行する場合、まず processQueryKey パラメータを URLEncoding でエスケープし、エスケープ後の processQueryKey を URL に組み込んでください。

リクエスト

基本情報

フィールド	値
HTTP URL	https://api.dingtalk.io/v1.0/robot/oToMessages/readStatus
HTTP Method	GET
対応アプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
必要な権限	permission-qyapi_robot_sendmsg-社内ボットメッセージ送信権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	必須	本 API を呼び出すためのアクセス認証情報です。以下の方法で取得します。 - 社内アプリの場合は、社内アプリのアクセストークン取得 API を呼び出して取得します。 - サードパーティアプリの場合は、サードパーティアプリが権限付与された企業のアクセストークン取得 API を呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
robotCode	String	必須	ボットのコードです。詳細はボット ID を参照してください。
processQueryKey	String	必須	メッセージの一意の識別子です。人とボットのチャットでボットメッセージを一括送信 API のレスポンスパラメータ `processQueryKey` フィールドから取得できます。メッセージ送信から 24 時間以内であれば processQueryKey を使って既読状態を照会できます。24 時間を超えると照会できません。

リクエスト例

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 {

    /**
     * トークンを使ってアカウント Client を初期化
     * @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 には code と message の属性が含まれ、問題の特定に役立ちます
            }

        } 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 には code と message の属性が含まれ、問題の特定に役立ちます
            }

        }        
    }
}

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:
        """
        トークンを使ってアカウント Client を初期化
        @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 には code と message の属性が含まれ、問題の特定に役立ちます
                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 には code と message の属性が含まれ、問題の特定に役立ちます
                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 {

    /**
     * トークンを使ってアカウント Client を初期化
     * @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 には code と message の属性が含まれ、問題の特定に役立ちます
            }
        }
    }
}
$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"
)

/**
 * トークンを使ってアカウント Client を初期化
 * @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 には code と message の属性が含まれ、問題の特定に役立ちます
    }

  }
  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 {

  /**
   * トークンを使ってアカウント Client を初期化
   * @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 には code と message の属性が含まれ、問題の特定に役立ちます
      }

    }    
  }

}

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 
    {

        /**
         * トークンを使ってアカウント Client を初期化
         * @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 には code と message の属性が含まれ、問題の特定に役立ちます
                }
            }
            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 には code と message の属性が含まれ、問題の特定に役立ちます
                }
            }
        }

    }
}

// 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 には code と message の属性が含まれ、問題の特定に役立ちます
    }
  }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
sendStatus	String	メッセージ送信ステータス。 - SUCCESS：成功 - RECALLED：送信取消済み - PROCESSING：処理中
messageReadInfoList	Array	メッセージの既読状況。
name	String	メッセージ受信者の名前。
userId	String	メッセージ受信者の userId。
readStatus	String	既読ステータス。 - READ：既読 - UNREAD：未読
readTimestamp	Long	現在未対応。

レスポンスボディ例

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

{
  "sendStatus" : "SUCESS",
  "messageReadInfoList" : [ {
    "name" : "山田太郎",
    "userId" : "201382020",
    "readStatus" : "READ"
  } ]
}

エラーコード

本 API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決方法を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidParameter.robotCode.empty	%s	ボットの robotCode が無効です
400	invalidParameter.param.invalid	%s	パラメータが不正です。パラメータが空でないか確認してください
400	invalidParameter.robotCode.notExsit	%s	ボットが存在しません
400	unknown.send.result	%s	不明な送信結果です
400	invalidParameter.robotCode.missing	%s	robotCode が指定されていません
400	invalidParameter.processQueryKey.missing	%s	processQueryKey が指定されていません
400	invalidParameter.robotCode.invalid	%s	ボットが存在しません。robotCode に対応するボットが社内にインストールされているか確認してください
400	invalid.processQueryKey	%s	processQueryKey が無効です。processQueryKey が正しいか確認してください
400	template.not.existed	%s	ボットテンプレートが存在しません
400	template.stopped	%s	ボットテンプレートは既に停止されています
400	processQueryKey.expireTime	%s	processQueryKey のメッセージ照会データがまだ生成されていないか、既に期限切れのため照会できません
500	system.error	%s	システムが混雑しています。後で再試行してください

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

人とボットのチャットにおけるボットメッセージの既読状態を一括照会

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード