DingTalk などのプラットフォームのチャット構成を作成、更新、取得、削除します。
操作説明
説明
この API を使用して、DingTalk などのインスタントメッセージ (IM) ツールとの連携のためのチャットボット設定を管理します。チャット構成の作成、更新、取得、削除が可能です。さまざまなユーザーまたはユーザーグループに対して詳細な権限コントロールを実装し、操作を実行するための Resource Access Management (RAM) ロールを指定できます。また、管理と分類を容易にするために、各構成にタグを追加することもできます。
この API を呼び出す際は、RegionId、ConversationId、およびリクエストボディ内のすべてのパラメーターが正しいことを確認してください。ClientId や ClientSecret フィールドなどの機密情報は、不正アクセスを防ぐために慎重に取り扱う必要があります。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-hangzhou |
| Filters |
array<object> |
任意 |
チャット構成をフィルターするための条件のリスト。 |
[{"Name": "status", "Value": "inactive"}, {"Name": "type", "Value": "private"}] |
|
object |
任意 |
名前と値を含むフィルター条件。 |
{"Name": "status", "Value": "inactive"} |
|
| Name |
string |
任意 |
フィルター条件の名前。 |
status |
| Value |
string |
任意 |
フィルター条件の値。 |
inactive |
| MaxResults |
integer |
任意 |
ページングクエリで各ページに返すエントリ数。 |
10 |
| NextToken |
string |
任意 |
次のページの結果を取得するためのトークン。このパラメーターを、前の応答から返された `NextToken` の値に設定します。 |
AQEBARoBBgEAAgIBBQ== |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
成功した応答の詳細。 |
||
| RequestId |
string |
リクエスト ID。 |
4DB0****1234 |
| ChatConfigurations |
array<object> |
チャット構成のリスト。 |
[{"Name": "test-wechat", "CreatedDate": "2025-12-10T10:09:32+00:00", "UpdatedDate": "2025-12-28T13:59:48+00:00", "RamRole": "OOSServiceRole", "Type": "WeChat", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\"}]} |
|
object |
チャット構成の詳細。 |
{"Name": "test-wechat", "CreatedDate": "2025-12-10T10:09:32+00:00", "UpdatedDate": "2025-12-28T13:59:48+00:00", "RamRole": "OOSServiceRole", "Type": "WeChat", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\"}"} |
|
| Name |
string |
チャット構成の名前。 |
test-wechat |
| CreatedDate |
string |
チャット構成が作成された時間。 |
2025-12-10T10:09:32+00:00 |
| UpdatedDate |
string |
チャット構成が最後に更新された時間。 |
2025-12-28T13:59:48+00:00 |
| RamRole |
string |
操作の実行に使用される RAM ロールの名前。 |
OOSServiceRole |
| Type |
string |
チャット構成のタイプ。有効値:
注意:この情報は、最近の API 呼び出しログに基づいて AI によって生成されました。正確性を確認してください! |
|
| Outputs |
string |
Webhook URL と AES キーを含む出力情報。 |
{"URL": "https://1407907063606569.appflow.aliyunnes", "AesKey": "UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF"} |
例
成功レスポンス
JSONJSON
{
"RequestId": "4DB0****1234",
"ChatConfigurations": [
{
"Name": "test-wechat",
"CreatedDate": "2025-12-10T10:09:32+00:00",
"UpdatedDate": "2025-12-28T13:59:48+00:00",
"RamRole": "OOSServiceRole",
"Type": "WeChat",
"Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\", \"AesKey\": \"UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF\"}"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。