用於建立、更新、查詢和刪除聊天配置,支援DingTalk等平台。
介面說明
請求說明
該 API 主要用於管理和配置與DingTalk等即時通訊工具整合的聊天機器人設定,包括但不限於建立新的聊天配置、更新現有配置、擷取特定配置詳情以及刪除不再需要的配置。通過此 API,可以實現對不同使用者或使用者組許可權的精細化控制,並能夠指定具體的 RAM 角色來執行相關操作。此外,還支援為每個配置添加標籤以便於管理和分類。
特別注意的是,在調用此 API 時,需確保提供的RegionId、ConversationId以及請求體中的各項參數準確無誤,尤其是涉及到安全敏感資訊如ClientId、ClientSecret等欄位時更應謹慎處理,避免泄露給非授權方。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
否 |
查詢憑證(Token),取值為上一次 API 呼叫返回的 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 |
聊天配置類型。取值:
TODO:該資訊由 AI 根據 API 近期調用日誌產生,請確認正確性! |
|
| Outputs |
string |
輸出資訊,包含 Webhook URL 和加密金鑰。 |
{"URL": "https://1407907063606569.appflow.aliyunnes", "AesKey": "UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF"} |
樣本
正常返回樣本
JSON格式
{
"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\"}"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。