Skip to main content

更新 IM 频道接口

启用或停用指定类型的 IM 频道。此接口只修改 enabled，不配置机器人凭据或其他连接参数。

  • Scope：admin.v1.im-channels.manage
  • 权限项：IM 频道管理（im-channels）
  • 权限类型：管理
  • 接口：PATCH/api/openapi/v1/im-channels/{channelId}

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
channelIdpathstring必填渠道 ID"<string>"
enabledbodyboolean必填启用状态false

请求示例

curl --request PATCH \
  --url 'https://example.invalid/api/openapi/v1/im-channels/<channelId>' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": false
}'

响应

200 OK

名称类型必填说明示例
channel_typestring是渠道类型"dingtalk"
enabledboolean是启用状态false
updated_atstring · date-time是更新时间"2026-08-27T10:00:00Z"
{
  "channel_type": "dingtalk",
  "enabled": false,
  "updated_at": "2026-08-27T10:00:00Z"
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}