根据任务ID获取任务Webhook URL以及开关状态 - ShowTaskWebhookInfo
功能介绍
根据任务ID查询任务第三方消息通知配置，返回第三方消息通知类型、Webhook URL、密钥以及开关状态。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartscheck:task:get |
Read |
task * |
- |
- |
- |
|
- |
codeartscheck:ProjectId |
URI
GET /v4/tasks/{task_id}/task-webhook-info
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释: 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制: 不涉及。 取值范围: 字符串长度不少于1，不超过32。 默认值: 不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of TaskWebhookInfo objects |
参数解释: webhoo节点列表 取值范围: 不涉及。 |
|
total |
Integer |
参数解释: 总数 取值范围: 0-2147483647 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 主键32位UUID。 取值范围: 不涉及。 |
|
taskId |
String |
参数解释: 任务ID。 取值范围: 不涉及。 |
|
webhookUrl |
String |
参数解释: 第三方平台推送消息的url。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 推送消息开关。 取值范围:
|
|
type |
String |
参数解释: 第三方消息通知类型。 取值范围:
|
|
reviewResultFilter |
String |
参数解释: 根据门禁结果过滤。 取值范围: 不涉及。 |
|
now |
String |
参数解释: 创建时间。 取值范围: 不涉及。 |
|
userIds |
String |
参数解释: 用户ID列表。 取值范围: 不涉及。 |
|
notificationMenu |
String |
参数解释: 需要通知的菜单项。 取值范围:
|
|
secret |
String |
参数解释: webhook加签需要的密钥。 取值范围: 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
