查询通知渠道¶

查询当前用户的站内、邮件和 Webhook 通知渠道配置。

GET https://billing.moi.matrixorigin.cn/api/v1/taas/notification-channels

调用前准备¶

准备个人访问令牌。创建和管理方法参阅创建和管理个人访问令牌。

查询范围为当前用户有权访问的数据。

请求示例¶

将示例中的 $MOI_PERSONAL_ACCESS_TOKEN 替换为个人访问令牌。

curl --get "https://billing.moi.matrixorigin.cn/api/v1/taas/notification-channels" \
  -H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"

成功响应¶

返回 HTTP 200，响应包含当前用户的通知渠道配置。

响应示例

{
  "items": [
    {
      "id": "channel_example",
      "user_id": "user_example",
      "channel_key": "in_app",
      "type": "in_app",
      "name": "In-app",
      "enabled": true,
      "readonly": true,
      "priorities": [
        "severe",
        "important",
        "normal"
      ],
      "config_version": 1,
      "created_at": 1788710400,
      "updated_at": 1788710400
    }
  ]
}

字段说明

字段	类型	说明
`items`	array of object	通知渠道列表。
`items[].id`	string	渠道 ID。
`items[].user_id`	string	所属用户 ID。
`items[].channel_key`	string	内置渠道标识；有值时返回。
`items[].type`	string	渠道类型。
`items[].subtype`	string	Webhook 子类型；有值时返回。
`items[].name`	string	渠道名称。
`items[].enabled`	boolean	是否启用。
`items[].readonly`	boolean	是否为只读渠道。
`items[].priorities`	array of string	允许发送的通知优先级。
`items[].target_display`	string	通知目标；邮件渠道返回已保存的邮箱地址，有值时返回。
`items[].config_version`	integer	渠道配置版本。
`items[].created_at`	integer	创建时间，Unix 秒。
`items[].updated_at`	integer	更新时间，Unix 秒。

字段路径中的 [] 表示数组中的每一项。

最后更新于 2026 年 9 月 8 日