List All Campaigns

Retrieve all registered campaigns. 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/campaigns

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

campaignName

string, max length: 255, min length: 0

Campaign name.

brandId REQUIRED

string, max length: 60, min length: 36

Unique ID for the brand associated with the campaign.

status

string enum, values: ACTIVE, DECLINED, DELETED, PENDING, COMPLETED

Current status of the campaign. Possible values include:

ACTIVE The campaign has been successfully registered with TCR. Batches can be created for the campaign.
DECLINED The campaign has failed the TCR registration process.
DELETED The campaign has been deleted.
PENDING The campaign is currently going through the TCR registration process.
COMPLETED The campaign is complete.

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

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": {
    "content": [
      {
        "campaignName": "Spring Campaign",
        "description": "string",
        "sender": "12345678912",
        "usecase": "MARKETING",
        "subUsecases": [
          ""
        ],
        "embeddedLink": false,
        "embeddedPhone": false,
        "numberPool": false,
        "ageGated": false,
        "directLending": false,
        "subscriberOptin": true,
        "subscriberOptout": true,
        "subscriberHelp": true,
        "affiliateMarketing": "false",
        "mnoIds": [
          "10017"
        ],
        "messageFlow": "string",
        "helpMessage": "Contact us at 1-800-123-1234 for assistance. To unsubscribe, reply STOP.",
        "optinMessage": "To receive messages about upcoming events, reply YES.",
        "optoutMessage": "To unsubscribe, reply STOP.",
        "autoRenewal": true,
        "sample1": "string",
        "sample2": "string",
        "sample3": "string",
        "sample4": "string",
        "sample5": "string",
        "id": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
        "businessAccountId": "67b25a5e-f90a-4491-9ee4-291ff290c1fe",
        "cspId": "4e0c15a5-d798-46ff-8c50-2b30bd597abf",
        "brandId": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
        "status": "ACTIVE",
        "lastStatusAt": "2022-04-23T22:52:52.590Z",
        "createdAt": "2022-04-23T22:52:52.590Z",
        "billedDate": "2022-04-23T22:52:52.590Z",
        "endDateTime": "2022-04-23T22:52:52.590Z",
        "rejectionReason": "string",
        "batchMessageCount": 1000,
        "singleMessageCount": 200
      },
      {...},
      {...}
    ],
    "page": 0,
    "total": 100,
    "pageSize": 10
  }
}