|PUT||Create a distribution list.|
|GET||Retrieve information about your lists, including the list IDs, names, and parameters.|
|POST||Update the parameters of a list.|
|DELETE||Delete a list.|
|PUT||Create new subscriptions and associate them with existing distribution lists.|
|GET||Lookup the IDs of the created subscriptions, or lookup detailed information for a subscription.|
|GET (Search)||Lookup the IDs for relevant subscriptions by various search conditions, including name, phone number, email address, subscription created date, and more.|
|POST||Update contact information of an existing subscription or associate a subscription to different distribution lists.|
|DELETE||Permanently remove a subscription.|
|Custom Data Field|
|PUT||Create a custom data field.|
|GET||Lookup the IDs of created custom data fields, or lookup detailed information for a specific custom data field.|
|POST||Update the parameters of a custom data field.|
|DELETE||Permanently remove a custom data field.|
|PUT||Send an SMS message to a single mobile number.|
|GET||Retrieve the statistics of a successfully processed message, including the number, delivered and failed messages.|
|PUT||Send a mobile text (SMS, MMS), and/or email message to specific subscription(s) or distribution list(s).|
|GET||Retrieve the statistics of a successfully processed message, including the total number of recipients as well as the count of delivered and failed messages.|
|GET (Scheduled)||Retrieve all scheduled messages.|
|DELETE||Cancel scheduled messages.|
|PUT||Create a mobile keyword and its auto-response message.|
|GET||Lookup general information of existing mobile keywords, or detailed information of a keyword. For general information, keyword_id, keyword, and associated short code information is provided. For detailed information, keyword, auto-response message, associated short code, alternative message, and alternative coupon message are provided.|
|POST||Update a mobile keyword and auto-response message.|
|DELETE||Permanently remove a mobile keyword.|
|PUT||Publish a status update to your feed on various publication targets, such as Facebook and/or Twitter.|
|GET||Retrieve a summary of results for a publication post.|
|GET||Lookup the resource balance of an account, such as domestic and international credits.|
|PUT||Register an organization name.|
|GET||Look up the IDs of created organization names, or look up detailed information for a specific organization name.|
|POST||Set default organization name.|
|DELETE||Permanently remove an organization name.|
|Social Media Account|
|PUT||Register a Facebook account, Facebook page, or Twitter account.|
|GET||Retrieve a Facebook account, Facebook page, or Twitter account.|
|DELETE||Permanently remove a Facebook account, Facebook page, or Twitter account.|
|Email Sender Address|
|PUT||Register an email sender address.|
|GET||Look up the IDs of created email sender addresses, or look up detailed information for a specific email sender address.|
|POST||Set default email sender address.|
|DELETE||Permanently remove an email sender address.|
|GET||Report resource provides status report of a request.|
The first step in integrating messaging into your system is to create a distribution list, which is referred to simply as a "list" in the API, and then develop ways for subscribers to be automatically added to your subscription database.
A list itself is a powerful tool for grouping subscriptions for a purpose. For example, you can group some subscriptions into one list for general marketing promotions and news, and create another list with a select number of those same subscriptions for more exclusive information. Or, for internal communications, separate lists can be created for various departments and teams.
A couple of ways you can organically add new subscriptions is by creating an online sign-up page (OSP) or a mobile keyword, which enables people to directly opt-in to your database. If you have an existing customer management system, you can develop a link between your database and ours that can keep contact details synced. You can also create multiple subscriptions at once with the PUT Subscription API call. Note that you must abide by industry regulations and have the expressed consent of your subscribers to be sent messages through our API.
In the case of an OSP, people can directly submit their contact information, like name, mobile number, and email address, via a web form to receive text-message notifications or email newsletters. Once a person has successfully filled out your OSP, your system could create a new subscription for that person in our database with the PUT Subscription call by providing that person’s contact info. The subscriber’s newly created subscription ID can be sent to you as a PUSH Notification, which you can design to automatically trigger an automated welcome message to be sent to the subscriber through the PUT Message call.
A mobile keyword can act in the same way by automatically adding subscribers when they text in your mobile keyword to your assigned short code number. To create a keyword, use the PUT Keyword call. However, the only personal information that is collected by default is the subscription's mobile phone number. To gather other subscription information, you can set up Inbound Messaging where the subscriber can send a text to another keyword with their personal information, which is then pushed to the Receiving URL you have designated in My Account for PUSH Notifications. From that point, you should develop a way to process and format that information to update that subscription's data in our system through the POST Subscription call.
Now that you've implemented ways to add subscriptions, you can now focus on sending messages to them. Messages can be sent with the PUT Message call to individual subscriptions or lists via any combination of supported channels: SMS or MMS message, or email. Mail merge can be integrated to include the first and/or last name of subscriptions, and the message can be scheduled to go out immediately or at a later date and time.
Our REST API also allows you to register an SNS account and publish a post to multiple social networking platforms, including Facebook and Twitter, simultaneously. A Facebook account, Facebook page, or Twitter account can be registered in your SNS account list with the PUT SNS Account call. A post can be published immediately or scheduled for a specific date and time using the PUT Publication call. Other parameters can also be set, such as privacy level and shared media for Facebook posts (e.g., links, images, or videos).
For every API resource, you can retrieve the content and results of your API requests. Here are the GET calls for the create calls mentioned above.
You can also check the general status of a request with the (GET Status Report)[#get-report] call. All you need to provide is the request ID that is returned in the relevant request response.