Search Send Result¶
在成功调用 Send Template Mail 和 Send Template SMS 两个接口时,用户收到的返回结果中包含 eventId,该参数可用于在本接口中搜索消息的实际发送结果。
请求格式¶
POST https://{apigw-address}/notification-center-service/v2.0/search/message
仅能查询本 OU 应用的 eventId 对应结果,其他应用或 OU 的结果无权查找。
请求参数 (URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
组织ID。 如何获取orgId信息>> |
请求参数 (Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
eventId |
必需 |
String |
发送邮件或短信请求时返回供用户查询结果的eventId |
错误码 ¶
代码 |
错误信息 |
描述 |
---|---|---|
32403 |
permission.denied.message.result |
无权查看该消息记录结果 |
32404 |
not.exist.message.result |
未找到该消息记录 |
示例¶
请求示例¶
url: https://{apigw-address}/notification-center-service/v2.0/search/message?orgId=yourOrgId
method: POST
requestBody:
{
"eventId": "xxx"
}
返回示例¶
{"code":0,"msg":"OK","submsg":"","requestId":""}
异常示例¶
{"code":32600 , "msg":"eventId is not existed or exceed storage time", "submsg":"eventId is not existed or exceed storage time", "data": null, "requestId": null}