The Campaign Manager is a web based tool that's available via HTTPS. To log into the Campaign Manager please go to:

https://production.me.syniverse.com/starwoods

and enter your User/Password credentials:

The Home Screen is the first page displayed after you log in to your account. The layout of the Home Screen varies depending on the role assigned to the account you are using. Every MMC screen is divided in 5 main elements:

Clicking on the Main Menu Button will slide the Main Menu Panel from the left of the screen. In the Main Menu Panel you will see a brief header with the available shortcodes and the Main Menu options. When navigating the Main Menu you will find options preceded by a < sign. Those options are sub menus that group additional options. So for example if you wish to set up an External Web Service campaign, you would click on Interactive Campaign and then External Web Service.

Return to the Home Screen by clicking on the Home Icon found in the Admin Menu on any screen.

The Starwood instance contains several workspaces, with 3 workspaces serving as the main path for most of the MT traffic for different countries. SW_HI and SW_LO handle all MT/MO traffic for U.S. and Canada. For other countries, MT traffic is sent using Templates through REST API on the SW_China workspace, which in turn delegates the MT to the corresponding workspace using the country code according to the table below:

All MT Templates reside on the three main workspaces. MO traffic, registration API and subscription list information for members of countries other than US and Canada is handled by each country's workspace based on the mapping previously described. Main workspace IDs can be seen below:

Starwood applications leverage External Web Service campaigns to process interactions from both employees and customers, handling registration confirmations, opt-outs and other events. This is achieved by adding Extended Attributes to these campaigns, in order to both customize parameter names added to the callback URL and to update certain user's information on its Subscription List. Extended Attributes are added on the bottom of the campaign creation page:

To add a new Attribute, add a new key value pair to the table by clicking the Add button. Remove Extended Attributes by clicking the Bin icon on the Tasks column. When finished, store the campaign settings bu clicking the Save button.

Optin campaigns take the yes keyword in each workspace (in the corresponding language), and update the user's customer_optin_status on its subscription list. These options are set on the advanced options tab of the creation page, displayed by clicking on the Show Advanced Options label:

Select the list to be updated by the campaign in the Update Subscription List box. All members in each workspace are saved on its main list.

When the Starwood application registers users, it adds callbackurl parameter to them on the subscription list, when this parameter exists, and the registration is valid and unexpired (based on the user's timestamp parameter on the subscription list) the campaign will issue the callback to the URL stored on the callbackurl parameter. To enable this behavior check the User URL checkbox:

Here's the breakdown of the remaining Extended Attributes employed on these campaigns:

To Optin a user, the campaign sets its customer_optin_status parameter to 1 on the subscription list, and updates the customer_optin_timestamp value with the date of the update.

OptOut campaigns receive Stop keywords in each workspace, and only set the customer_optin_status to 0 and update the customer_optin_timestamp of users in the subscription list. OptOut campaigns issue callbacks only to the URL present in the campaign, they do not use the User URL option. You can check all relevant user parameters on the Subscription Lists interface:

The Starwood application needs to receive events for every type of interaction users make through MOs. Each workspace has a Default Callback Campaign that will process any MOs containing invalid keywords, using the User URL behavior to trigger callbacks from registered users, and sending an MT response otherwise. These campaigns will always be active in each workspace.

Keyword campaigns are the most common SMS marketing campaign type. A keyword campaign is designed to reply to an end user when the end user texts in a specific keyword or phrase to a shortcode or longcode.

In the case of Starwood keyword campaigns are configured to reply Help messages.

We want to set up a keyword campaign in the 13054957665 longcode that will receive the word demo or DEMO and will respond with the message Thanks for your message!. To do this we click on the Main Menu Button, click on Campaign and select the Keywords option. We will see the following screen:

Click on Create New and fill in the required information. Here's the breakdown of the required fields:

The following options can be modified if you click the Show advanced options link

Use the Keywords section to map the expected input from the user with the appropriate response. Grouping several terms in the same keyword lets you answer several inputs with the same response text, but also simplifies reporting. When reports are generated all the inputs that match a certain keyword are grouped using the Campaign interprets field. So in this example:

users that send demo or DEMO will receive the same message (Thanks for your message! in this example), but they also will be grouped as demo in the reports. Now, click on Save if you wish to save but not activate the campaign (if you wish to activate it later) or click Activate to save it and make it available to your users. Let's try sending a message to the longcode and see the system's response:

If we want to add a new term to our Keywords campaign we would select the View All Existing Keywords button in the toolbar:

Then select the campaign you wish to modify:

And add a new keyword to the campaign. In this case we are going to create an info keyword that responds Today's secret code is 887B:

Click on Save and let's test it from the handset:

To view the live results of your campaign select the campaign from the Keywords main screen and click on the View Campaign Results button on the toolbar:

You will be presented with today's traffic for the campaign. If you wish to see the traffic for any other period of time use the Starts on and Ends on controls and click Search.

The template will have the text of a message as a response to a REST API, that text may have parameters, which will help to personalize the message. In order to personalize the message we’ll use placeholders {x} that will have the field’s name with the information that must be placed in the message. Placeholder names must be written exactly as they will appear on the jSON body of the REST API request e.g. {name}, {place}, {date}, {city}

To create a Template we need to click Menu then go to Utils and template:

The main Templates screen shows all the templates that are currently configured and active. Each ID is unique for each template. From here we can edit, delete or create a new Template

In order to create a new Template we have to click in New:

Fill in the name and the text that you want sent through the REST API. You may also store placeholders for future use apart from text by typing them on the placeholders input section and adding them to the list by clicking the left arrow. The Language field is optional and allows you to assign a language to your template to improve reporting. The I want to use URL Shortener option allows automatic shortening of all URLs contained in the template text. You may now Save your template:

We have our new Template active and ready to be used in the REST API call identified by ID or Name: