Retrieve a Campaign

Retrieve a registered campaign. This retrieves the campaign details and status.

Endpoint

GET /v1/campaigns/{id}

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 campaign in RocketCOMS.

Request Body

None

Returns

Returns the campaign details and status. For details, see the Campaign object.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": {
    "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
  }
}