全部产品
Search
文档中心

:GetChatConfiguration - 查看对话配置

更新时间:Jan 07, 2026

用于创建、更新、查询和删除聊天配置,支持钉钉等平台。

接口说明

请求说明

该 API 主要用于管理和配置与钉钉等即时通讯工具集成的聊天机器人设置,包括但不限于创建新的聊天配置、更新现有配置、获取特定配置详情以及删除不再需要的配置。通过此 API,可以实现对不同用户或用户组权限的精细化控制,并能够指定具体的 RAM 角色来执行相关操作。此外,还支持为每个配置添加标签以便于管理和分类。

特别注意的是,在调用此 API 时,需确保提供的RegionIdConversationId以及请求体中的各项参数准确无误,尤其是涉及到安全敏感信息如ClientIdClientSecret等字段时更应谨慎处理,避免泄露给非授权方。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

Name

string

配置名称。

chatOps-qiwei

返回参数

名称

类型

描述

示例值

object

成功响应的详细信息

RequestId

string

请求 ID。

4DB0****1234

ChatConfiguration

object

聊天配置的详细信息,包含名称、类型、RAM 角色等属性。

{ "Name": "chatops", "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

聊天配置的名称。

chatops

Type

string

聊天配置的类型。取值:

  • DingTalk:钉钉配置。

  • WeChat:企业微信配置。

TODO:该信息由 AI 根据 API 近期调用日志生成,请确认正确性!

DingTalk

RamRole

string

用于执行操作的 RAM 角色名称。

OOSServiceRole

Configuration

string

具体的聊天配置内容,格式为 JSON 字符串,包含客户端 ID、密钥等敏感信息。

{"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 地址等参数,格式为 JSON 字符串。

{"URL": "https://1407907063606569.appflow.aliyunnest.com/webhook/"}

示例

正常返回示例

JSON格式

{
  "RequestId": "4DB0****1234",
  "ChatConfiguration": {
    "Name": "chatops",
    "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/\"}"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情