- Introduction
- Authentication
- Sorting and Pagination
- Errors
- Authentication APIs
- User Authentication APIs
- Account APIs
- Custom Placeholder APIs
- Brand APIs
- Campaign APIs
- Campaign Batch APIs
- Create a Campaign Batch
- Retrieve Errors for a Campaign Batch
- Update a Campaign Batch
- Download Original Campaign Batch CSV File
- Retrieve a Campaign Batch
- List All Campaign Batches
- List All Messages for a Processed Campaign Batch
- Download All Messages for a Processed Campaign Batch
- Remove a Campaign Batch
- Campaign Batch Object
- Campaign Batch Message Object
- Campaign Subscription APIs
- Recipient APIs
- Recipient Batch APIs
- Recipient List APIs
- Keyword Filtering APIs
- Message Template APIs
- Message APIs
- Collection APIs
- Insights APIs
Campaign Batch Message Object
The Campaign Batch Message object represents details for a message that is part of a campaign batch.
Attributes
id
string (UUID)
RocketCOMS internal system ID.
batchId
string (UUID)
Unique ID assigned to the batch in RocketCOMS.
campaignId
string
Unique ID assigned to the campaign in RocketCOMS.
destinationNumber
integer
Destination phone number.
messageText
string
Content of the message.
destinationFormat
integer (int32), values: 0, 1
default value: 0
Destination number format. Possible values are:
- 0 Phone number does not include a country code.
- 1 Phone number includes a country code. Required for international messaging.
additionalData
string
Notes about the batch.
status
string enum, values: PENDING, INVALID-INPUT, IN-PROCESS, DELIVERED, FAILED, LENGTH-ERROR
Message status.
createdAt
string (date-time)
Date and time the message was created.
retrievedAt
string (date-time)
Date and time the message was retrieved from the Direct Connect Aggregator (DCA).
sentAt
string (date-time)
Date and time the message was sent.
confirmedAt
string (date-time)
Date and time the message was confirmed by the Direct Connect Aggregator (DCA).
Campaign Batch Message Object
{
"id": "265ac585-c9ef-4216-9c67-160aefdb6a3d",
"batchId": "32df8770-ee48-46e7-a8c7-9ec478883076",
"campaignId": "05ee2300-51cd-4021-b28d-11597cf9a175",
"destinationNumber": 5555551234,
"messageText": "Spring Sale Starts Today",
"destinationFormat": 0,
"additionalData": "",
"status": "DELIVERED",
"createdAt": "2022-04-24T01:51:03.419Z",
"retrievedAt": "2022-04-25T16:51:03.419Z",
"sentAt": "2022-04-24T02:51:03.419Z",
"confirmedAt": "2022-04-24T03:51:03.419Z"
}