Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Applications/ Querying Application Notification Configurations

Updated on 2025-11-28 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Application Notification Configurations

Function

This API is used to query the application notification configuration based on the application ID.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default value N/A
app_id	Yes	String	Definition Application ID. Obtain the application list by calling the API forobtaining the application list. In the response body, result[0].id is the desired application list. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	Array of TaskMsgBody objects	Definition Application notification configuration.
status	String	Definition Log query result. Range success: Logs are queried. error: Query logs failed.

**Table 4** TaskMsgBody
Parameter	Type	Description
id	String	Definition Message notification ID. Range The value contains 32 characters. Only letters and digits are allowed.
app_id	String	Definition Application ID. Range The value contains 32 characters. Only letters and digits are allowed.
msg_type	String	Definition Message notification type. Range email: Email. dingtalk: DingTalk. wechat: WeCom. message: System message. lark: Feishu. webhook: Customized callback network hook.
task_id	String	Definition Task ID. Range The value contains 32 characters. Only letters and digits are allowed.
msg_state	Boolean	Definition Notification switch status. Range true: Enabled. false: Disabled.
sort_index	Integer	Definition Subscript ID of the notification type. Range -1: System message. 0: Email. 1: DingTalk. 2: WeCom. 3: Feishu. 4: Webhook.
send_url	String	Definition Messaging URL. Range N/A
secret_info	String	Definition Key information. Range N/A
wechat_user_ids	Array of strings	Definition WeCom user ID list. Range N/A
at_user_ids	Array of strings	Definition IDs of users mentioned in the Webhook messages. Range N/A
at_mobiles	Array of strings	Definition Mobile numbers mentioned in the Webhook messages. Range N/A
msg_level	String	Definition Notification message level. Range project: Project level. instance: Instance level.
state_switch	Array of MsgSwitchBody objects	Definition Notification switch.
http_headers	Array of strings	Definition Request header of the Webhook message. This parameter is only available when the Webhook message is sent. Range N/A
message_body	String	Definition Request body of the Webhook message. This parameter is available only when the Webhook message is sent. Range N/A
body_switch	Array of MsgSwitchBody objects	Definition Message body structure switch.
ext_params	String	Definition Extended parameter. Range N/A
user_id	String	Definition User ID. Range N/A
create_time	String	Definition Creation time. Format: yyyy-MM-dd HH:mm:ss. Example: 2021-02-25 10:37:27. Range N/A
update_time	String	Definition Update time. Format: yyyy-MM-dd HH:mm:ss. Example: 2021-02-25 10:37:27. Range N/A

**Table 5** MsgSwitchBody
Parameter	Type	Description
name	String	Definition Switch name. Range N/A
open	Boolean	Definition Whether the switch is enabled. Range true: enabled. false: Disabled.
sort	Integer	Definition Sorting value. Range Digits only. By default, the value 0 is reserved for system notifications. When a third-party notification is enabled, it is assigned the next available integer value in ascending order. Each activation increments the counter by 1, creating a sequential mapping of notifications.
receivers	Array of strings	Definition Message recipient list. Range N/A

Example Requests

Query the application notification configuration based on the application ID.

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

Example Responses

Status code: 200

OK indicates that the application notification configuration is queried.

{
  "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"
}