DingTalk チャット設定 API の概要 - OOS - Alibaba Cloud - CloudOps Orchestration Service

DingTalk などのプラットフォーム向けにチャット構成の作成、更新、照会、および削除を行います。

操作説明

操作の説明

この API オペレーションは、DingTalk などのインスタントメッセージ (IM) ツールと統合された Chatbot の設定を管理および構成するために使用されます。サポートされる操作には、チャット構成の作成、既存の構成の更新、特定の構成詳細の取得、および不要になった構成の削除が含まれます。この API オペレーションを使用して、さまざまなユーザーまたはユーザーグループに対するきめ細かいアクセスの制御を実装し、関連する操作を実行するための RAM ロールを指定できます。また、管理と分類を容易にするために、各構成にタグを追加することもできます。

この API オペレーションを呼び出す際は、リクエストボディ内の RegionId、ConversationId およびその他のパラメーターが正しいことを確認してください。不正な開示を防ぐため、ClientId や ClientSecret などのセキュリティ上重要なフィールドをハンドルする際は注意が必要です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oos:GetChatConfiguration

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
Name	string	任意	構成名。	チャットOps-qiwei

レスポンスフィールド

フィールド	型	説明	例
	object	成功した応答の詳細。
RequestId	string	リクエスト ID。	4DB0****1234
ChatConfiguration	object	名前、タイプ、RAM ロール、その他のプロパティを含むチャット構成の詳細。	{ "Name": "チャットops", "Type": "DingTalk", "RamRole": "OOSServiceRole", "Configuration": "{\"DingTalkClientId\": \"dingpxlbxp0rgs7uxmtb\", \"DingTalkClientSecret\": \"****\", \"DingTalkTemplateId\": \"381c5aee-f8af-48a4-94be-cce587e42ea4.schema\"}", "ResourceGroupId": "s", "CreatedDate": "2025-12-26T09:53:02+00:00", "UpdatedDate": "2026-01-07T02:14:55+00:00", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnest.com/webhook/\"}", "RequestId": "4DB0**1234" }
Name	string	チャット構成の名前。	チャットops
Type	string	チャット構成のタイプ。有効な値: DingTalk: DingTalk 構成。 WeChat: WeCom 構成。 TODO: この情報は、最近の API 呼び出しログに基づいて AI によって生成されています。この情報の精度を確認してください。	DingTalk
RamRole	string	操作の実行に使用される RAM ロールの名前。	OOSServiceRole
Configuration	string	クライアント ID やシークレットなどの機密情報を含む、JSON 文字列フォーマットのチャット構成内容。	{"DingTalkClientId": "dingpxlbxp0rgs7uxmtb", "DingTalkClientSecret": "******", "DingTalkTemplateId": "381c5aee-f8af-48a4-94be-cce587e42ea4.schema"}
ResourceGroupId	string	リソースが属するリソースグループの ID。	s
CreatedDate	string	チャット構成が作成された時間（ISO 8601 フォーマット）。	2025-12-26T09:53:02+00:00
UpdatedDate	string	チャット構成が最後に更新された時間（ISO 8601 フォーマット）。	2026-01-07T02:14:55+00:00
Outputs	string	Webhook URL などのパラメーターを含む、JSON 文字列フォーマットのチャット構成の出力情報。	{"URL": "https://1407907063606569.appflow.aliyunnest.com/webhook/"}

例

成功レスポンス

JSONJSON

{
  "RequestId": "4DB0****1234",
  "ChatConfiguration": {
    "Name": "チャットops",
    "Type": "DingTalk",
    "RamRole": "OOSServiceRole",
    "Configuration": "{\"DingTalkClientId\": \"dingpxlbxp0rgs7uxmtb\", \"DingTalkClientSecret\": \"******\", \"DingTalkTemplateId\": \"381c5aee-f8af-48a4-94be-cce587e42ea4.schema\"}",
    "ResourceGroupId": "s",
    "CreatedDate": "2025-12-26T09:53:02+00:00",
    "UpdatedDate": "2026-01-07T02:14:55+00:00",
    "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnest.com/webhook/\"}"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。