
# 根据任务ID获取任务Webhook URL以及开关状态 - ShowTaskWebhookInfo
#### 功能介绍
根据任务ID查询任务第三方消息通知配置，返回第三方消息通知类型、Webhook URL、密钥以及开关状态。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。
#### 授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。
| 授权项                    | 访问级别 | 资源类型（\*为必须） | 条件键                     | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| codeartscheck:task:get | Read | task \*     | -                       | -  | -      |
| codeartscheck:task:get | Read | -           | codeartscheck:ProjectId | -  | -      |
   
#### URI
GET /v4/tasks/{task_id}/task-webhook-info
表1路径参数 
| 参数      | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| task_id | 是    | String | **参数解释:** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制:** 不涉及。 **取值范围:** 长度为\[1\~32\]个字符。 **默认值:** 不涉及。 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表2响应Body参数 
| 参数    | 参数类型                                                                               | 描述                                                                                                                                                                   |
|:---|:---|:---|
| data  | Array of [TaskWebhookInfo] objects | **参数解释:** webhook节点列表。 **取值范围:** 不涉及。           |
| total | Integer                                                                            | **参数解释:** webhook节点列表总数。 **取值范围:** 0-2147483647 |
   
 表3TaskWebhookInfo 
| 参数                 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| id                 | String | **参数解释:** 主键32位UUID或者null。 **取值范围:** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| taskId             | String | **参数解释:** 任务ID。 **取值范围:** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| webhookUrl         | String | **参数解释:** 第三方平台推送消息的url。 **取值范围:** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| status             | String | **参数解释:** 推送消息开关。 **取值范围:** - on：打开消息通知。   - off：关闭消息通知。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| type               | String | **参数解释:** 第三方消息通知类型。 **取值范围:** - wecom：企业微信消息通知。   - dingtalk：钉钉消息通知。   - lark：飞书消息通知。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| reviewResultFilter | String | **参数解释:** 根据门禁结果过滤。 **取值范围:** - 空白字符串：全部。   - success：门禁通过。   - error：门禁不通过。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| now                | String | **参数解释:** 创建时间。 **取值范围:** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| userIds            | String | **参数解释:** 用户ID列表。 **取值范围:** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| notificationMenu   | String | **参数解释:** 需要通知的菜单项。 **取值范围:** - jobResult：检查结果。   - reviewResult：门禁结果。   - issues：问题数。   - linkUrl：跳转链接。   - executor：执行人。   - finishedTime：完成时间。    |
| secret             | String | **参数解释:** webhook加签需要的密钥。 **取值范围:** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   
**状态码：400**
表4响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                  |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。  |
| error_msg  | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 |
   
**状态码：401**
表5响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                  |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。  |
| error_msg  | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 |
   
#### 请求示例
查询任务ID为ac26d65ef4ef45c2986611XXXXXXffa的任务的第三方消息通知配置。
```
GET https://{endpoint}/v4/tasks/ac26d65ef4ef45c2986611XXXXXXffa/task-webhook-info
```
#### 响应示例
**状态码：200**
请求成功!
```
{
  "data" : [ {
    "id" : "1",
    "notificationMenu" : "",
    "now" : "2025-07-22T03:00:53Z",
    "reviewResultFilter" : "",
    "secret" : "",
    "status" : "off",
    "taskId" : "ac26d65ef4ef45c2986611XXXXXXffa",
    "type" : "wecom",
    "userIds" : "",
    "webhookUrl" : ""
  } ],
  "total" : 1
}
```
**状态码：400**
请求异常。
```
{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}
```
**状态码：401**
权限不足。
```
{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}
```
#### 状态码
| 状态码 | 描述    |
|:---|:---|
| 200 | 请求成功! |
| 400 | 请求异常。 |
| 401 | 权限不足。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。
