查询应用通知配置
功能介绍
根据应用ID查询应用通知配置。
调用方法
请参见如何调用API。
URI
GET /v2/projects/{project_id}/applications/{app_id}/messages
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Array of TaskMsgBody objects |
参数解释: 应用通知配置。 |
|
status |
String |
参数解释: 查询日志结果。 取值范围:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 消息通知ID。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
|
app_id |
String |
参数解释: 应用ID。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
|
msg_type |
String |
参数解释: 消息通知类型。 取值范围:
|
|
task_id |
String |
参数解释: 任务ID。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
|
msg_state |
Boolean |
参数解释: 通知开关状态。 取值范围:
|
|
sort_index |
Integer |
参数解释: 消息通知类型下标ID。 取值范围:
|
|
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 |
参数解释: 消息通知级别。 取值范围:
|
|
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。 取值范围: 不涉及。 |
请求示例
根据应用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,表示查询应用通知配置成功。 |
错误码
请参见错误码。