用於建立、更新、查詢及刪除聊天設定,支援釘釘等平台。
介面說明
請求說明
該 API 主要用於管理和設定與釘釘等即時通訊工具整合的聊天機器人設定,包括但不限於建立新的聊天設定、更新現有設定、取得特定設定詳情以及刪除不再需要的設定。透過此 API,可以實現對不同使用者或使用者群組權限的精細化控制,並能夠指定具體的 RAM 角色來執行相關操作。此外,還支援為每個設定新增標籤以便於管理和分類。
特別注意的是,在呼叫此 API 時,需確保提供的 RegionId、ConversationId 以及請求主體中的各項參數準確無誤,尤其是涉及到安全敏感資訊如 ClientId、ClientSecret 等欄位時更應謹慎處理,避免洩露給非授權方。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
oos:CreateChatConfiguration |
create |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
| Name |
string |
否 |
設定名稱。 |
chatops |
| Type |
string |
否 |
聊天平台類型。可能的值:
|
DingTalk |
| RamRole |
string |
否 |
RAM 角色名稱。 |
AliyunOOSDefaultRole |
| Configuration |
string |
否 |
聊天機器人設定資訊,格式為 JSON。 |
("DingTalkTemplateId": "template-123", "DingTalkClientId": "client-123", "DingTalkClientSecret": "secret-123"} |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfmxsn4m4****** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
成功回應的詳細資訊。 |
||
| RequestId |
string |
請求 ID。 |
4DB0****1234 |
| ChatConfiguration |
object |
聊天設定的詳細資訊。 |
{"Name": "TestChatConfig-9be97b40", "CreatedDate": "2025-12-11T13:49:10+00:00", "UpdatedDate": "2025-12-11T13:59:02+00:00"} |
| Name |
string |
聊天設定的名稱。 |
TestChatConfig-9be97b40 |
| CreatedDate |
string |
聊天設定的建立時間。 |
2025-12-11T13:49:10+00:00 |
| UpdatedDate |
string |
聊天設定的最後更新時間。 |
2025-12-11T13:59:02+00:00 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "4DB0****1234",
"ChatConfiguration": {
"Name": "TestChatConfig-9be97b40",
"CreatedDate": "2025-12-11T13:49:10+00:00",
"UpdatedDate": "2025-12-11T13:59:02+00:00"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。