Design / About the RocketCOMS APIs
About the RocketCOMS APIs
About the APIs
The RocketCOMS APIs make it easy to create, launch, and manage SMS marketing campaigns. With the APIs, you can register your brands and campaigns with The Campaign Registry (TCR), create and launch SMS marketing campaigns, track campaign responses, and view campaign statistics.
Our API categories are described in the following sections.
Account APIs
Create and manage RocketCOMS Portal users with the Manager role.
These APIs can be used to:
- Create, update, and remove Manager users. (Only Admin Portal users can create and remove Manager users.)
- Retrieve details for a Manager user.
- Retrieve a list of Manager users.
Authentication APIs
Authenticate RocketCOMS Portal users.
These APIs can be used to:
- Confirm that a user has been registered successfully with the Portal.
- Obtain an access token when a user logs into the Portal.
- Refresh a user’s access token.
- Remove an access token when a user logs out of the Portal.
- Send an email with a reset password link to a user.
- Reset a user’s password.
- Change a user’s password.
Brand APIs
A brand is the company the end-user (the mobile subscriber) believes to be sending the SMS messages, and is responsible for the messaging content in a campaign.
These APIs can be used to:
- Create and register a brand with TCR.
- Determine if a brand is qualified to run a campaign for a specific use case.
- Determine if a brand is qualified to run a campaign for all use cases.
- Update a brand.
- Retrieve details for a brand.
- Retrieve a list of registered brands.
- Remove a brand.
Campaign APIs
A campaign is a targeted effort to send SMS messages to mobile subscribers for promotional or informational purposes, and is typically referred to as an SMS marketing campaign.
These APIs can be used to:
- Create and register a campaign with TCR.
- Update a campaign.
- Retrieve details for a campaign.
- Retrieve a list of registered campaigns.
- Retrieve all reply messages for a campaign.
- Download a CSV file containing the reply messages for a campaign.
- Retrieve a list of opt-out messages for a campaign.
- Remove a campaign.
Message APIs
Send and retrieve SMS messages.
These APIs can be used to:
- Send a single outgoing message for a campaign.
- Retrieve details for a single outgoing message for a campaign.
- Search sent messages across campaigns.
Batch APIs
Batch files can be used to provide the message content and recipient phone numbers for a campaign.
These APIs can be used to:
- Upload a CSV batch file for a campaign containing the recipient phone numbers and message content.
- Retrieve details for a batch.
- Retrieve a list of the sent messages for a batch.
- Download a CSV file containing the sent messages for a batch.
- Retrieve a list of all batch files.
Collection APIs
Retrieve values used in the creation of new brands and campaigns. These values are defined by The Campaign Registry (TCR).
These APIs can be used to:
- Retrieve a list of brand entity types.
- Retrieve a list of brand relationships.
- Retrieve a list of verticals.
- Retrieve a list of use cases.
