CreateAgentIMChannel - 创建智能体 IM 渠道-智能体构建和治理平台 AgentCore-阿里云帮助中心

为指定智能体创建 IM 渠道，并绑定可公开访问的 ServiceEndpoint。

接口说明

为指定智能体创建 IM 渠道，并绑定可公开访问的 ServiceEndpoint。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

agentcore:CreateAgentIMChannel

create

*AgentIMChannel

acs:agentcore:{#regionId}:{#accountId}:workspace/{#workspaceId}/agent/{#agentId}/imChannel/*

无

请求语法

POST /workspaces/{workspaceId}/agents/{agentId}/im-channels HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
workspaceId	string	是	工作空间 ID。	ws-1
agentId	string	是	智能体 ID。	agent-1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求体。
channelConfig	object	否	渠道行为配置。
showThinking	boolean	否	是否在 IM 消息中展示思考过程，默认值为 false。
showToolCalls	boolean	否	是否在 IM 消息中展示工具调用过程，默认值为 false。
channelType	string	是	IM 渠道类型。枚举值：DINGTALK（钉钉）、FEISHU（飞书）、WECOM（企业微信）。枚举值： FEISHU : 飞书 WECOM : 企业微信 DINGTALK : 钉钉	DINGTALK
credential	object	是	渠道凭据，必须全量传入且字段值为非空字符串。钉钉使用 clientID 和 clientSecret，飞书使用 appId 和 appSecret，企业微信使用 botId 和 secret。
	string	否	渠道凭据字段值。	credential-value
enabled	boolean	否	是否启用该 IM 渠道。创建时默认值为 true。
serviceEndpointId	string	是	绑定的 ServiceEndpoint ID。该端点必须属于指定智能体及其当前版本，并已就绪且具有公网地址。	se-1
clientToken	string	否	预留幂等令牌，本期后端不提供持久化幂等保证。	client-token-1

请求参数的具体含义和取值要求见下方参数说明。

返回参数

名称	类型	描述	示例值
	object	创建智能体 IM 渠道的成功响应。
code	string	业务状态码。成功时为 SUCCESS。	SUCCESS
data	object	创建后的 IM 渠道信息。
agentId	string	智能体 ID。	agent-1
channelConfig	object	渠道行为配置。
showThinking	boolean	是否在 IM 消息中展示思考过程，默认值为 false。
showToolCalls	boolean	是否在 IM 消息中展示工具调用过程，默认值为 false。
channelType	string	IM 渠道类型。枚举值：DINGTALK（钉钉）、FEISHU（飞书）、WECOM（企业微信）。枚举值： FEISHU : 飞书 WECOM : 企业微信 DINGTALK : 钉钉	DINGTALK
createTime	string	创建时间，RFC 3339 格式。	2026-01-01T00:00:00Z
credentialSummary	object	渠道凭据摘要，仅返回非敏感字段和已配置的 Secret 字段名，不返回 Secret 值。
configuredSecretFields	array	已配置的 Secret 字段名列表，不包含 Secret 值。
	string	已配置的 Secret 字段名。	clientSecret
nonSecretFields	object	非敏感凭据字段及其值。
	string	非敏感凭据字段值。	ding-app-id
enabled	boolean	是否启用该 IM 渠道。创建时默认值为 true。
endpointUrl	string	绑定的 ServiceEndpoint 公网访问地址。	https://agent.example.com
imChannelId	string	IM 渠道 ID。	imc-1
serviceEndpointId	string	绑定的 ServiceEndpoint ID。该端点必须属于指定智能体及其当前版本，并已就绪且具有公网地址。	se-1
status	string	IM 渠道状态。枚举值：CREATING（创建中）、READY（就绪）、UPDATING（更新中）、FAILED（失败）、DELETING（删除中）、DELETE_FAILED（删除失败）。枚举值： READY : 就绪 FAILED : 失败 DELETING : 删除中 UPDATING : 更新中 CREATING : 创建中 DELETE_FAILED : 删除失败	READY
statusReason	string	IM 渠道当前状态的原因说明。	AppFlow 创建失败
updateTime	string	更新时间，RFC 3339 格式。	2026-01-01T00:00:00Z
workspaceId	string	工作空间 ID。	ws-1
httpStatusCode	integer	HTTP 状态码。成功时为 200。	200
message	string	请求处理结果消息。	success
requestId	string	请求 ID。	1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx
success	boolean	请求是否成功。

成功响应的字段含义见下方响应参数说明。

示例

正常返回示例

JSON格式

{
  "code": "SUCCESS",
  "data": {
    "agentId": "agent-1",
    "channelConfig": {
      "showThinking": true,
      "showToolCalls": true
    },
    "channelType": "DINGTALK",
    "createTime": "2026-01-01T00:00:00Z",
    "credentialSummary": {
      "configuredSecretFields": [
        "clientSecret"
      ],
      "nonSecretFields": {
        "key": "ding-app-id"
      }
    },
    "enabled": true,
    "endpointUrl": "https://agent.example.com",
    "imChannelId": "imc-1",
    "serviceEndpointId": "se-1",
    "status": "READY",
    "statusReason": "AppFlow 创建失败",
    "updateTime": "2026-01-01T00:00:00Z",
    "workspaceId": "ws-1"
  },
  "httpStatusCode": 200,
  "message": "success",
  "requestId": "1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "success": true
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	An Agent IM Channel parameter is invalid.
400	AgentIMChannelInvalidConfig	The IM channel configuration is invalid.
400	AgentIMChannelInvalidCredential	The IM channel credential is invalid.
502	AgentIMChannelUpstreamError	The upstream IM channel service request failed.
409	AgentIMChannelAlreadyExists	An IM channel of the specified type already exists for this agent.
409	AgentIMChannelEndpointMismatch	The ServiceEndpoint cannot be bound to the specified agent.

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

变更历史

更多信息，参考变更详情。