文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 融合项目API/ 批量发送通知
更新时间：2025-07-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量发送通知

功能介绍

批量发送通知

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/notifications/batch-send

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

type

否

String

通知类型

receivers

否

Array of strings

通知接收人

comment_id

否

String

评论ID

inner_text

否

String

通知纯文字内容

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueString object

请求结果

error

ApiError object

错误信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址
表4 ResultValueString

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

String

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表5 ApiError

参数

参数类型

描述

code

String

参数解释

错误编码

取值范围

不涉及

reason

String

参数解释

业务失败的提示内容

取值范围

不涉及

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

post https://{endpoint}/v4/75681cbb7c324e15a9eb8ee74a96a474/notifications/batch-send

{
  "type" : "casecomment",
  "comment_id" : "92e7b6e1d56b4ec9afc017377da29064"
}

响应示例

状态码：200

发送成功返回体

{
  "status" : "success",
  "result" : {
    "value" : "success"
  }
}

状态码

状态码

描述

200

发送成功返回体

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 融合项目API

相关文档