Campaign Object

campaignName  

string, max length: 255, min length: 0

Campaign name.

description  

string, max length: 4096, min length: 0

Detailed description of the campaign.

sender

string

pattern: ^(0|[1-9][0-9]*)$

10DLC phone number used to send SMS messages. Must be 11 digits.

usecase  

string (UUID)

Campaign use case. Use the List Use Cases API to retrieve a list of usecaseName values that can be used in this field.

subUsecases

array of strings (UUID)

Campaign sub use cases. Use the List Use Cases API to retrieve a list of usecaseName values that can be used in this field.

embeddedLink  

boolean, default: false

Whether the message generated by the campaign includes a URL link. Note that public URL shorteners (bityly, tinyurl) are not accepted.

embeddedPhone  

boolean, default: false

Whether the message generated by the campaign includes a phone number (other than the required HELP information contact phone number).

numberPool  

boolean, default: false

Whether the campaign utilizes a pool of phone numbers.

ageGated  

boolean, default: false

Whether the campaign includes any age-gated message content.

directLending  

boolean, default: false

Whether the campaign includes any message content related to direct lending or other loan arrangements.

subscriberOptin  

boolean, default: true

Whether the campaign requires the subscriber to opt-in before messages can be sent to the subscriber.

subscriberOptout  

boolean, default: false

Whether the campaign supports subscriber opt-out keyword(s).

subscriberHelp  

boolean, default: true

Whether the campaign responds to help keyword(s).

affiliateMarketing

boolean, default: false

Whether the message content is controlled by any affiliate marketing other than the brand.

mnoIds

array of strings

List of MNO network IDs for the MNOs the campaign will be submitted to. Default is all MNOs if no value is provided.

messageFlow

string, max length: 2048, min length: 0

Message flow description.

helpMessage

string, max length: 255, min length: 0

Help message for the campaign.

optinMessage

string, max length: 320, min length: 20

Opt-in message shown to subscribers.

optoutMessage  

string, max length: 320, min length: 20

Opt-out message shown to subscribers.

autoRenewal

boolean, default: true

Whether the campaign subscription will automatically renew at the end of the billing cycle.

sample1

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

sample2

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

sample3

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

sample4

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

sample5

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

id  

string (UUID)

Unique ID assigned to the campaign in RocketCOMS.

businessAccountId

string

ID of the RocketCOMS Business Account that the brand belongs to.

cspId

string

Unique ID assigned to the CSP by The Campaign Registry (TCR).

brandId  

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.

billedDate

string (date-time)

Reserved for future use.

endDateTime

string (date-time)

Campaign expiry date and time.

rejectionReason

string

Reason the campaign was rejected.

batchMessageCount

number (integer)

Number of batch messages processed by the campaign.

singleMessageCount

number (integer)

Number of single messages processed by the campaign.