The Campaign object represents details for a campaign.
campaignName
string, max length: 255, min length: 0
Campaign name.
description
string, max length: 4096, min length: 40
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: 40
Message describing how a subscriber can opt-in to the campaign.
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: 20
Message sample. Some campaign tiers require up to 5 message samples.
sample2
string, max length: 1024, min length: 20
Message sample. Some campaign tiers require up to 5 message samples.
sample3
string, max length: 1024, min length: 20
Message sample. Some campaign tiers require up to 5 message samples.
sample4
string, max length: 1024, min length: 20
Message sample. Some campaign tiers require up to 5 message samples.
sample5
string, max length: 1024, min length: 20
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 (UUID)
Unique ID for the brand associated with the campaign.
status
string enum, values: PENDING, ACTIVE, COMPLETED, DECLINED, DELETED
Current status of the campaign. Possible values include:
lastStatusAt
string (date-time)
Date and time the campaign status was last updated.
createdAt
string (date-time)
Date and time the campaign was created.
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.
Campaign Object
{
"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
}
}
© 2023 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.