ListChatConfigurations - 查看对话配置列表

更新时间:
复制为 MD 格式

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

接口说明

请求说明

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

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

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

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

聊天配置类型。取值:

  • WeChat:企业微信。

  • DingTalk:钉钉。

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

WeChat

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\"}"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情