Retrieve error information for a campaign batch.
Note If the batch has not been processed, you can correct the errors and update the batch.
GET /v1/batches/{id}/errors
Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding
id REQUIRED
string (UUID)
Unique ID assigned to the campaign batch in RocketCOMS.
verbose
boolean, default: false
Whether to return detailed error information. If set to true, the error line number and a detailed message will be returned.
page
integer (int32), default: 0
Page number to return.
pageSize
integer (int32)
Maximum number of results to return per page.
None
Returns a paginated response with an array of error messages. The following fields are returned.
fileErrors
integer
Number of errors found in the campaign batch file.
content
array
Detailed error information. Returned when verbose is set to true.
line
integer
Line number where the error occurred.
detailMessage
string
Detailed error message.
SAMPLE RESPONSE
{
"status": "0000",
"result": {
"fileErrors": 3,
"content": [
{
"line": 20,
"detailMessage": "string"
},
{...},
{...}
],
"page": 0,
"total": 3,
"pageSize": 10
}
}
RocketCOMs is a powerful SMS marketing platform that empowers businesses with seamless support for multiple brands, intuitive campaign management, real-time analytics, and advanced formatting options for successful text message campaigns.