文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 根据任务id获取任务WebhookUrl以及开关状态
更新时间：2025-09-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据任务id获取任务WebhookUrl以及开关状态

功能介绍

根据任务id获取任务WebhookUrl以及开关状态

调用方法

请参见如何调用API。

URI

GET /v4/tasks/{task_id}/task-webhook-info

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释:

任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

data

Array of TaskWebhookInfo objects

参数解释:

webhoo节点列表

取值范围:

不涉及

total

Integer

参数解释:

总数

取值范围:

0-2147483647
表3 TaskWebhookInfo

参数

参数类型

描述

id

String

参数解释:

主键32位UUID

取值范围:

不涉及

taskId

String

参数解释:

任务id

取值范围:

不涉及

webhookUrl

String

参数解释:

第三方平台推送消息的url。

取值范围:

不涉及

status

String

参数解释:

推送消息开关,off表示关,on表示开

取值范围:

on,off

type

String

参数解释:

第三方类型,比如：钉钉、企业微信等

取值范围:

不涉及

reviewResultFilter

String

参数解释:

根据门禁结果过滤

取值范围:

不涉及

now

String

参数解释:

创建时间

取值范围:

不涉及

userIds

String

参数解释:

用户id列表

取值范围:

不涉及

notificationMenu

String

参数解释:

需要通知的菜单项

取值范围:

不涉及

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

Request succeeded!

{
  "data" : [ {
    "id" : "1",
    "notificationMenu" : "",
    "now" : "2025-07-22T03:00:53Z",
    "reviewResultFilter" : "",
    "secret" : "",
    "status" : "off",
    "taskId" : "ac26d65ef4ef45c2986611XXXXXXffa",
    "type" : "wecom",
    "userIds" : "",
    "webhookUrl" : ""
  } ],
  "total" : 1
}

状态码：400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙，请稍后再试"
}

状态码：401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 任务管理

相关文档