Search Send Result¶
查询消息发送结果。
在成功调用 Send Template Mail 或 Send Template SMS 后,API 返回结果中包含 eventId
。你可以使用 eventId
在本接口中查询消息的实际发送结果。
仅支持查询与你使用的应用服务账号相同 OU 下 eventId 对应结果,其它 OU 的结果无权查找。
请求格式¶
POST https://{apigw-address}/notification-center-service/v2.0/search/message
请求参数 (URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
组织 ID。 如何获取 orgId 信息 >> |
请求参数 (Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
eventId |
必需 |
String |
消息通知 event ID,你可以通过 event ID 查询本次消息推送的实际结果。 |
错误码 ¶
你可以通过下表查询本 API 可能返回的特定错误码。有关通知管理服务 API 的通用错误码,参见 通用错误码。
代码 |
错误信息 |
描述 |
---|---|---|
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}