更新时间:2025-11-17 GMT+08:00
分享

查询应用通知配置

功能介绍

根据应用ID查询应用通知配置。

调用方法

请参见如何调用API

URI

GET /v2/projects/{project_id}/applications/{app_id}/messages

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

app_id

String

参数解释

应用ID。通过调用获取应用列表接口获取(响应体result[0].id的值)。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

Array of TaskMsgBody objects

参数解释

应用通知配置。

status

String

参数解释

查询日志结果。

取值范围

  • success: 查询日志成功。

  • error: 查询日志失败。

表4 TaskMsgBody

参数

参数类型

描述

id

String

参数解释

消息通知ID。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

app_id

String

参数解释

应用ID。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

msg_type

String

参数解释

消息通知类型。

取值范围

  • email: 电子邮件。

  • dingtalk: 钉钉。

  • wechat: 企业微信。

  • message: 站内信。

  • lark: 飞书。

  • webhook: 自定义回调网络钩子。

task_id

String

参数解释

任务ID。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

msg_state

Boolean

参数解释

通知开关状态。

取值范围

  • true: 已启用。

  • false: 未启用。

sort_index

Integer

参数解释

消息通知类型下标ID。

取值范围

  • -1: 站内信。

  • 0: 电子邮件。

  • 1: 钉钉。

  • 2: 企业微信。

  • 3: 飞书。

  • 4: webhook。

send_url

String

参数解释

消息发送url。

取值范围

不涉及。

secret_info

String

参数解释

密钥信息。

取值范围

不涉及。

wechat_user_ids

Array of strings

参数解释

企业微信的用户ID列表。

取值范围

不涉及。

at_user_ids

Array of strings

参数解释

webhook消息@的用户ID列表。

取值范围

不涉及。

at_mobiles

Array of strings

参数解释

webhook消息@的手机号列表。

取值范围

不涉及。

msg_level

String

参数解释

消息通知级别。

取值范围

  • project: 项目级。

  • instance: 实例级。

state_switch

Array of MsgSwitchBody objects

参数解释

消息通知开关。

http_headers

Array of strings

参数解释

webhook消息请求头,仅在webhook消息时存在该响应值。

取值范围

不涉及。

message_body

String

参数解释

webhook消息请求体,仅在webhook消息时存在该响应值。

取值范围

不涉及。

body_switch

Array of MsgSwitchBody objects

参数解释

消息体结构开关。

ext_params

String

参数解释

扩展参数。

取值范围

不涉及。

user_id

String

参数解释

用户ID。

取值范围

不涉及。

create_time

String

参数解释

创建时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。

取值范围

不涉及。

update_time

String

参数解释

更新时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。

取值范围

不涉及。

表5 MsgSwitchBody

参数

参数类型

描述

name

String

参数解释

开关名称。

取值范围

不涉及。

open

Boolean

参数解释

开关是否打开。

取值范围

  • true:开关打开。

  • false:开关关闭。

sort

Integer

参数解释

排序值。

取值范围

只能是数字。系统通知默认0;第三方通知从0开始,每多一个开关递增1。

receivers

Array of strings

参数解释

消息接收人列表。

取值范围

不涉及。

请求示例

根据应用ID查询应用通知配置。

https://{endpoint}/v2/projects/7e6caf3cd9a64d5b8ea451e38221892e/applications/325395b98fd341c1bc7ed01c5211421e/messages

响应示例

状态码:200

OK,表示查询应用通知配置成功。

{
  "result" : [ {
    "id" : "ffff49b38041413d99e1a3dddfc95e8e",
    "app_id" : "325395b98fd341c1bc7ed01c5211421e",
    "msg_type" : "email",
    "task_id" : "70c80124aea547d092d50747a06ec858",
    "msg_state" : true,
    "sort_index" : -1,
    "send_url" : "123@xx.com",
    "secret_info" : "xxxx",
    "wechat_user_ids" : [ ],
    "at_user_ids" : [ ],
    "at_mobiles" : [ ],
    "msg_level" : "instance",
    "state_switch" : [ {
      "name" : "success",
      "open" : true,
      "sort" : 0,
      "receivers" : null
    }, {
      "name" : "failure",
      "open" : true,
      "sort" : 0,
      "receivers" : null
    }, {
      "name" : "update",
      "open" : true,
      "sort" : 0,
      "receivers" : null
    }, {
      "name" : "delete",
      "open" : true,
      "sort" : 0,
      "receivers" : null
    } ],
    "http_headers" : [ ],
    "message_body" : "body",
    "body_switch" : [ {
      "name" : "projectName",
      "open" : true,
      "sort" : 5,
      "receivers" : null
    } ],
    "ext_params" : null,
    "user_id" : "6fd072f3dd1f49b897f1e11d34ab5972",
    "create_time" : "2025-08-23 12:06:03",
    "update_time" : "2025-08-23 12:06:03"
  } ],
  "status" : "success"
}

状态码

状态码

描述

200

OK,表示查询应用通知配置成功。

错误码

请参见错误码

相关文档