The Batch Message object represents details for a campaign message that is part of a batch of messages.
id
string (UUID)
RocketCOMS internal system ID.
batchId
string (UUID)
Unique ID for the batch.
campaignId
string
Unique ID for the campaign.
destinationNumber
integer
Destination phone number.
messageText
string
Content of the message.
destinationFormat
integer (int32), values: 0, 1
default: 0
Destination number format. Possible values are:
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).
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"
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.