List all Batches

Retrieve all batch files. Use any combination of the query parameters to filter the results (value must be an exact match). Use sortBy and sortDir to sort the results, and use page and recordsPerPage to limit the number of results returned.

Endpoint

GET /v1/batches

Authorization Header

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

Query Parameters

startDateFrom

string, format: YYYY-MM-DD

Date to start processing the batch messages. This filter will return batches where the start date is on or after this date. Can be used in conjunction with startDateTo to specify a date range.

startDateTo

string, format: YYYY-MM-DD

Date to start processing the batch messages. This filter will return batches where the start date is on or before this date. Can be used in conjunction with startDateFrom to specify a date range.

endDateFrom

string, format: YYYY-MM-DD

Date to stop processing the batch messages. This filter will return batches where the end date is on or after this date. Can be used in conjunction with endDateTo to specify a date range.

endDateTo

string, format: YYYY-MM-DD

Date to stop processing the batch messages. This filter will return batches where the end date is on or before this date. Can be used in conjunction with endDateFrom to specify a date range.

campaignId

string (UUID)

Unique ID assigned to the campaign.

status

string enum, values: COMPLETED, UPLOADING, ERROR, PENDING, IN_PROCESS

Current status of the batch.

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 objects.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": {
    "content": [
      {
        "id": "32df8770-ee48-46e7-a8c7-9ec478883076",
        "campaignId": "05ee2300-51cd-4021-b28d-11597cf9a175",
        "description": "Spring Sale",
        "externalId": "a7896",
        "startDate": "2022-04-25",
        "endDate": "2022-04-25",
        "startTime": "02:00:00",
        "endTime": "04:00:00",
        "status": "DELIVERED",
        "createdAt": "2022-04-24T16:51:03.419Z",
        "updatedAt": "2022-04-24T16:51:03.419Z",
        "finishedAt": "2022-04-25T04:00:03.419Z"
      },
      {...},
      {...}
    ],
    "page": 0,
    "total": 100,
    "pageSize": 10
  }
}