> ## 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. # 個別チャットにおけるボットメッセージの既読リストを取得 > 企業メンバー間の個別チャットでボットメッセージの既読状態を確認できます 本インターフェースを呼び出すと、グループ ID、ボットコード、メッセージ ID をもとに、個別チャットにおけるボットメッセージの既読リスト情報を取得できます。企業メンバー間の個別チャットで、ボットメッセージが既読かどうかを確認する必要があるシーンに適しています。 ## リクエスト ### 基本情報 | フィールド | 値 | | ------------ | ---------------------------------------------------------------------------------------------------------------------------- | | HTTP URL | [https://api.dingtalk.io/v1.0/robot/privateChatMessages/query](https://api.dingtalk.io/v1.0/robot/privateChatMessages/query) | | HTTP Method | POST | | サポートするアプリタイプ | appType-社内アプリ　appType-サードパーティ社内アプリ | | 必要な権限 | permission-qyapi\_robot\_sendmsg-社内ボットによるメッセージ送信権限 | ### リクエストヘッダー | 名前 | タイプ | 必須 | 説明 | | --------------------------- | ------ | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | はい | 本インターフェース呼び出し用のアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合、[社内アプリの accessToken を取得](/ja/open/development/obtain-the-access-token-of-an-internal-app#)インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合、[サードパーティアプリが認可された企業の accessToken を取得](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#)インターフェースを呼び出して取得します。 | ### リクエストボディ | 名前 | タイプ | 必須 | 説明 | | ------------------ | ------ | --- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | openConversationId | String | いいえ | 個別チャットのオープン会話 ID。[酷アプリを個別チャットへ一括インストール](https://open.dingtalk.com/document/development/batch-chat-session#)を利用し、[会話管理](https://open.dingtalk.com/document/development/org-event-overview#260a4e7084gs2)イベントを購読することで OpenConversationId パラメータの値を取得できます。 | | robotCode | String | いいえ | ボットのコード。詳細は [ボット ID](https://open.dingtalk.com/document/development/robot-overview#) を参照してください。 | | processQueryKey | String | はい | メッセージ ID。[カードの作成と配信](https://open.dingtalk.com/document/development/create-and-deliver-cards#)インターフェース、または [個別チャットでボットが通常メッセージを送信](/ja/open/development/the-robot-sends-ordinary-messages-in-a-person-to-person-conversation#)インターフェースを呼び出すことで、`processQueryKey` パラメータの値を取得できます。 | | maxResults | Long | いいえ | ページング検索における 1 ページあたりの件数。 | | nextToken | String | いいえ | 前回のクエリ後に返される、暗号化されたページング認証情報。初回クエリでは指定不要です。 | ### リクエスト例 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 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 = ""; 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 properties that help 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 properties that help locate the issue } } } } ``` 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 = '' 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 properties that help locate the issue 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 = '' 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 properties that help locate the issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} 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 = ""; $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 properties that help 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 ```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("") 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 properties that help locate the issue } } 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 { let client = Client.createClient(); let privateChatQueryHeaders = new $dingtalkrobot_1_0.PrivateChatQueryHeaders({ }); privateChatQueryHeaders.xAcsDingtalkAccessToken = ""; 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 properties that help locate the issue } } } } 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 = ""; 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 properties that help locate the issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err contains code and message properties that help locate the issue } } } } } ``` ## レスポンス ### レスポンスボディ | 名前 | タイプ | 説明 | | ----------- | --------------- | --------------------------------------------------------------- | | sendStatus | String | メッセージ送信ステータス。 - SUCCESS：成功 - RECALLED：送信取消済み - PROCESSING：処理中 | | readUserIds | Array of String | メッセージを既読にしたメンバーの userId リスト。 | | nextToken | String | 次回のページング検索用の暗号化された認証情報。 | | hasMore | Boolean | ページング検索でさらに情報があるかどうか。 | ### レスポンスボディ例 ```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 } ``` ### エラーコード 本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとに [グローバルエラーコード](/ja/open/development/server-api-error-codes-1) ドキュメントから解決方法を検索してください。 | HttpCode | エラーコード | エラーメッセージ | 説明 | | -------- | ---------------------------------------- | ---------------------------------------- | ------------------------------------------------------- | | 400 | invalidParameter.param.invalid | パラメータが不正です | パラメータが不正です。パラメータが空でないかご確認ください | | 400 | invalidParameter.robotCode.notExsit | ボットが存在しません | ボットが存在しません。ボットがグループ内にあるかご確認ください | | 400 | invalidParameter.robotCode.missing | robotCode が不足しています | robotCode が不足しています | | 400 | invalidParameter.processQueryKey.missing | processQueryKey が不足しています | processQueryKey が不足しています | | 400 | invalidParameter.cursor.invalid | 無効な nextToken | 無効な nextToken です。nextToken が正しいかご確認ください | | 400 | invalidParameter.pageSize.invalid | 無効な maxResults | maxResults が上限の 200 を超えています | | 400 | invalidParameter.robotCode.invalid | 無効な robotCode | 無効な robotCode です | | 400 | invalid.openConversationId | 無効な openConversationId | 無効な openConversationId です | | 400 | openConversationId.notExisted | openConversationId が空です | openConversationId が空です | | 400 | invalid.processQueryKey | 無効な processQueryKey | 無効な processQueryKey です | | 400 | bot.stopped | グループボットが停止されています | グループボットが停止されています | | 400 | template.not.existed | ボットテンプレートが存在しません | ボットテンプレートが存在しません | | 400 | template.stopped | ボットテンプレートが停止されています | ボットテンプレートが停止されています | | 400 | processQueryKey.expireTime | processQueryKey のメッセージ検索データが未生成または期限切れです | processQueryKey のメッセージ検索データが未生成または期限切れのため、メッセージを検索できません | | 400 | conversation.org.dismatch | チャットが現在の企業に属していません | チャットが現在の企業に属していません | | 400 | resource.not.found | %s | ボットが存在しません | | 400 | unauthorized | %s | 権限付与されていません | | 400 | auth.error | %s | 権限不足のため操作が許可されません | | 500 | system.error | 未知のシステムエラー | 未知のシステムエラー |