List All Messages for a Batch

List all sent messages for a batch.

Endpoint

GET /v1/batches/{id}/report

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

id REQUIRED

string (UUID)

Unique ID assigned to the batch.

Query Parameters

sortBy

string

Sort the response by any field.

sortDir

string, values: desc, asc

Sort direction.

page

integer (int32), default: 0

Page number to return.

pageSize

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Batch Message objects.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": {
    "content": [
      {
        "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"
      },
      {...},
      {...}
    ],
    "page": 0,
    "total": 100,
    "pageSize": 10
  }
}