Search Send Result¶
Query the send result of the message.
When the Send Template Mail or Send Template SMS APIs are successfully invoked, you will receive the return result containing eventId, which can be used to search for the actual send result of the message in this API.
Only eventId results corresponding to this OU can be queried. Results of other OUs cannot be searched.
Request Format¶
POST https://{apigw-address}/notification-center-service/v2.0/search/message
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Required/Optional |
Data Type |
Description |
|---|---|---|---|---|
orgId |
Query |
Required |
String |
The organization ID. How to get the orgId>> |
Request Parameters (Body)¶
Name |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
eventId |
Required |
String |
An eventId that returns the result for the user to query when a mail or SMS request is sent. |
Error Codes
You can refer to the table below to check the specific error codes that this API may return. For the common error codes of Notification Management Service APIs, refer to the Common Error Codes.
Code |
Data Type |
Description |
|---|---|---|
32403 |
permission.denied.message.result |
You are not allowed to view the message record results. |
32404 |
not.exist.message.result |
The message record was not found. |
Samples¶
Request Sample¶
url: https://{apigw-address}/notification-center-service/v2.0/search/message?orgId=yourOrgId
method: POST
requestBody:
{
"eventId": "xxx"
}
Return Sample¶
{"code":0,"msg":"OK","submsg":"","requestId":""}
Abnormal Sample¶
{"code":32600 , "msg":"eventId is not existed or exceed storage time", "submsg":"eventId is not existed or exceed storage time", "data": null, "requestId": null}