文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 融合项目API/ 批量发送通知 - BatchSendNotifications
更新时间:2025-12-27 GMT+08:00
分享

批量发送通知 - BatchSendNotifications

功能介绍

此接口用于邮件提醒查看用例评论更新,同页面 测试 -> 测试用例 -> 用例详情页新增用例评论

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

type

String

参数解释:

通知类型

约束限制:

不涉及

取值范围:

  • casecomment,用例评论。

默认取值:

不涉及

receivers

Array of strings

通知接收人

comment_id

String

评论ID

inner_text

String

通知纯文字内容

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

value

String

参数解释:

调用此接口的返回

取值范围:

  • success,表示接口调用成功。

  • failed,表示接口调用失败。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

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

{
  "type" : "casecomment",
  "receivers" : [ "0a5377049000d29b1f20c014ab703e63" ],
  "comment_id" : "92e7b6e1d56b4ec9afc017377da29064",
  "inner_text" : "hello world!"
}

响应示例

状态码:200

OK

{
  "value" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档