社内ボットによる内部グループメッセージの送信取消

本インターフェースを呼び出すことで、社内ボットによる内部グループメッセージの送信取消を実現できます。グループチャットボットの誤送信メッセージを一括で送信取消するシナリオに適しています。

リクエスト

基本情報

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

リクエストヘッダー

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

リクエストボディ

名前	タイプ	必須	説明
openConversationId	String	はい	グループ ID。クライアントサイドの chooseChat によりグループチャットの openConversationId を取得できます。ボットがグループチャットメッセージを送信インターフェースで使用した openConversationId と一致させる必要があります。
robotCode	String	はい	ボットのコード。ボット ID を参照してください。ボットがグループチャットメッセージを送信インターフェースで使用した robotCode と一致させる必要があります。
processQueryKeys	Array of String	はい	メッセージ ID リスト。ボットがグループチャットメッセージを送信インターフェースの戻りパラメータ processQueryKey フィールドから取得できます。

リクエスト例

HTTP

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

{
  "openConversationId" : "cidfCSxxxx",
  "robotCode" : "dingxxxx",
  "processQueryKeys" : [ "b5fe11095fxxxx" ]
}

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();
        OrgGroupRecallHeaders orgGroupRecallHeaders = new OrgGroupRecallHeaders();
        orgGroupRecallHeaders.xAcsDingtalkAccessToken = "<your access token>";
        OrgGroupRecallRequest orgGroupRecallRequest = new OrgGroupRecallRequest()
                .setOpenConversationId("cidfCSxxxx")
                .setRobotCode("dingxxxx")
                .setProcessQueryKeys(java.util.Arrays.asList(
                    "b5fe11095fxxxx"
                ));
        try {
            client.orgGroupRecallWithOptions(orgGroupRecallRequest, orgGroupRecallHeaders, 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_recall_headers = dingtalkrobot__1__0_models.OrgGroupRecallHeaders()
        org_group_recall_headers.x_acs_dingtalk_access_token = '<your access token>'
        org_group_recall_request = dingtalkrobot__1__0_models.OrgGroupRecallRequest(
            open_conversation_id='cidfCSxxxx',
            robot_code='dingxxxx',
            process_query_keys=[
                'b5fe11095fxxxx'
            ]
        )
        try:
            client.org_group_recall_with_options(org_group_recall_request, org_group_recall_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_recall_headers = dingtalkrobot__1__0_models.OrgGroupRecallHeaders()
        org_group_recall_headers.x_acs_dingtalk_access_token = '<your access token>'
        org_group_recall_request = dingtalkrobot__1__0_models.OrgGroupRecallRequest(
            open_conversation_id='cidfCSxxxx',
            robot_code='dingxxxx',
            process_query_keys=[
                'b5fe11095fxxxx'
            ]
        )
        try:
            await client.org_group_recall_with_options_async(org_group_recall_request, org_group_recall_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\OrgGroupRecallHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\OrgGroupRecallRequest;
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();
        $orgGroupRecallHeaders = new OrgGroupRecallHeaders([]);
        $orgGroupRecallHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $orgGroupRecallRequest = new OrgGroupRecallRequest([
            "openConversationId" => "cidfCSxxxx",
            "robotCode" => "dingxxxx",
            "processQueryKeys" => [
                "b5fe11095fxxxx"
            ]
        ]);
        try {
            $client->orgGroupRecallWithOptions($orgGroupRecallRequest, $orgGroupRecallHeaders, 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
  }

  orgGroupRecallHeaders := &dingtalkrobot_1_0.OrgGroupRecallHeaders{}
  orgGroupRecallHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  orgGroupRecallRequest := &dingtalkrobot_1_0.OrgGroupRecallRequest{
    OpenConversationId: tea.String("cidfCSxxxx"),
    RobotCode: tea.String("dingxxxx"),
    ProcessQueryKeys: []*string{tea.String("b5fe11095fxxxx")},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.OrgGroupRecallWithOptions(orgGroupRecallRequest, orgGroupRecallHeaders, &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 orgGroupRecallHeaders = new $dingtalkrobot_1_0.OrgGroupRecallHeaders({ });
    orgGroupRecallHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let orgGroupRecallRequest = new $dingtalkrobot_1_0.OrgGroupRecallRequest({
      openConversationId: "cidfCSxxxx",
      robotCode: "dingxxxx",
      processQueryKeys: [
        "b5fe11095fxxxx"
      ],
    });
    try {
      await client.orgGroupRecallWithOptions(orgGroupRecallRequest, orgGroupRecallHeaders, 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.OrgGroupRecallHeaders orgGroupRecallHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupRecallHeaders();
            orgGroupRecallHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupRecallRequest orgGroupRecallRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.OrgGroupRecallRequest
            {
                OpenConversationId = "cidfCSxxxx",
                ProcessQueryKeys = new List<string>
                {
                    "b5fe11095fxxxx"
                },
            };
            try
            {
                client.OrgGroupRecallWithOptions(orgGroupRecallRequest, orgGroupRecallHeaders, 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 属性が含まれており、問題の特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
successResult	Array of String	送信取消に成功したメッセージ ID リスト。説明ボットが送信したメッセージを送信取消しても、チャット画面には通知は表示されません。
failedResult	`Map<String, String>`	送信取消に失敗したメッセージ ID リストおよび理由。

レスポンスボディ例

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

{
  "successResult" : [ "b5fe11095fxxxx" ],
  "failedResult" : { }
}

エラーコード

本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決方法を検索できます。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalid.openConversationId	%s	無効な openConversationId です。openConversationId が正しいかご確認ください
400	invalidParameter.robotCode	%s	無効な robotCode です。ボットがグループ内に存在するかご確認ください
400	invalidParameter.processQueryKeys.overMax	%s	processQueryKeys が上限の 20 件を超えています。processQueryKeys を 20 件以下の複数の配列に分割し、本インターフェースを複数回に分けて呼び出してください
400	not.allowed.robotCode	%s	権限付与されていない robotCode です
400	invalidParameter.param.invalid	%s	パラメータが不正です。パラメータが空でないかご確認ください
400	invalidParameter.robotCode.notExsit	%s	ボットが存在しません。チャット内に robotCode に対応するボットがインストールされているかご確認ください
400	miss.chatbotId	%s	robotCode が不足しています
400	invalidParameter.processQueryKey.missing	%s	processQueryKey が不足しています
400	invalid.processQueryKey	%s	無効な processQueryKey です。processQueryKey が正しいかご確認ください
400	miss.openConversationId	%s	openConversationId が不足しています
400	bot.stopped	%s	グループボットはすでに停止されています
400	template.not.existed	%s	ボットテンプレートが存在しません
400	template.stopped	%s	ボットテンプレートはすでに停止されています
500	system.error	%s	不明なシステムエラーです

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

社内ボットによる内部グループメッセージの送信取消

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード