ncloud_sens_list_brandmessage_requests
Retrieve Brand Message delivery requests by request ID, time window, recipient, or status to audit and monitor send results.
Instructions
List Brand Message delivery requests (GET /brandmessage/v2/services/{serviceId}/messages). Requires requestId, or requestStartTime+requestEndTime (≤31 days), or completeStartTime+completeEndTime (≤24 h); plusFriendId is required unless requestId is given. An empty HTTP 404 reply means no matching records (observed live with an unknown requestId).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Filter by recipient number (digits only) | |
| pageSize | No | Items per page (1-100, default 20) | |
| messageId | No | Filter by message ID | |
| nextToken | No | Page token from the previous response | |
| requestId | No | Request ID from the send response. One of requestId, requestStartTime+requestEndTime, completeStartTime+completeEndTime is required | |
| serviceId | No | Biz Message service ID in NRN form (e.g. ncp:kkobizmsg:kr:1********2:myproject). Defaults to NCLOUD_SENS_BRANDMESSAGE_SERVICE_ID (or NCLOUD_SENS_ALIMTALK_SERVICE_ID) / NCLOUD_SENS_SERVICE_ID. Find it with ncloud_sens_list_projects (kkoBizMsgService.serviceId). A 'Forbidden' reply means the project does not have this channel enabled. | |
| plusFriendId | No | Channel ID (required when requestId is not given) | |
| templateCode | No | Filter by template code | |
| requestEndTime | No | Window end by request time (SMS: within 30 days, Alimtalk/Brand: within 31 days of start) | |
| completeEndTime | No | Window end by completion time (within 24 hours of start) | |
| requestStartTime | No | Window start by request time 'YYYY-MM-DD HH:mm:ss' | |
| completeStartTime | No | Window start by completion time 'YYYY-MM-DD HH:mm:ss' | |
| messageStatusName | No | Filter by delivery result | |
| requestStatusName | No | Filter by request result |