社内ボットのグループチャットメッセージ既読状態を照会

本 API を呼び出すことで、ボットメッセージの送信状態や既読ユーザーの userId などの情報を取得できます。たとえば、社内ボットが内部グループチャットでグループチャットメッセージを送信した後、本 API を利用することで、既読ユーザーの userId を照会できます。

リクエスト

基本情報

フィールド	値
HTTP URL	https://api.dingtalk.io/v1.0/robot/groupMessages/query
HTTP Method	POST
サポートされるアプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
必要な権限	permission-qyapi_robot_sendmsg-社内ボットのメッセージ送信権限

リクエストヘッダー

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

リクエストボディ

名前	タイプ	必須	説明
openConversationId	String	いいえ	グループ ID。クライアントサイドの chooseChat でグループチャットの openConversationId を取得できます。ボットによるグループチャットメッセージの送信 API 呼び出し時に使用した openConversationId と一致させる必要があります。
robotCode	String	いいえ	ボットのコード。詳細はボット ID を参照してください。ボットによるグループチャットメッセージの送信 API 呼び出し時に使用した robotCode と一致させる必要があります。
processQueryKey	String	はい	メッセージの一意識別子。ボットによるグループチャットメッセージの送信 API のレスポンスパラメーター processQueryKey フィールドから取得します。
maxResults	Long	いいえ	ページネーション取得の 1 ページあたりの件数。最大値は 200 です。
nextToken	String	いいえ	ページネーションカーソル。空にするとホームから取得を開始します。

リクエスト例

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 {

    /**
     * トークンを使用してアカウント 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();
        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 には 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()
        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 には code と message 属性が含まれており、開発時の問題特定に役立ちます
                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 には 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\OrgGroupQueryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\OrgGroupQueryRequest;
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();
        $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 には 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
  }

  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 には 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 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 には 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.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 には 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
sendStatus	String	メッセージ送信状態: - SUCCESS: 成功 - RECALLED: 送信取消済み - PROCESSING: 処理中
readUserIds	Array of String	メッセージを既読にしたユーザーの userId。
nextToken	String	次回ページネーション取得のカーソル。
hasMore	Boolean	ページネーション取得でメッセージ既読状態を照会できるユーザーがまだ存在するかどうか。

レスポンスボディ例

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

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

エラーコード

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

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.invalid	トークンに対応するボットが存在しません	トークンに対応するボットが存在しません。ボットがグループ内にいるかを確認してください
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	不明なシステムエラー	不明なシステムエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

社内ボットのグループチャットメッセージ既読状態を照会

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード