15
VERTICURL PTE LTD 1 Verticurl – SMS App Cloud Configuration Guide Table of Contents Verticurl – SMS App Cloud Configuration Guide ..................................................................................................... 1 Pre-Requisites ........................................................................................................................................................... 1 Configure Eloqua user account ..................................................................................................................... 2 Configure SMS delivery report CDO .............................................................................................................. 3 Callback URL setup on SMS Provider Account ............................................................................................. 4 Create SMS account ...................................................................................................................................... 6 Configure an SMS Campaign: .................................................................................................................................. 7 Unique Identifier ........................................................................................................................................... 12 Mobile Phone................................................................................................................................................ 12 Campaign Name ........................................................................................................................................... 12 SMS Account Name ..................................................................................................................................... 12 SMS From ..................................................................................................................................................... 12 Inbound Report Range ................................................................................................................................. 12 SMS Message ............................................................................................................................................... 12 Contact Personalization ............................................................................................................................... 12 CDO Personalization .................................................................................................................................... 13 Suppress Duplicates .................................................................................................................................... 13 Enabled ......................................................................................................................................................... 13 Save .............................................................................................................................................................. 13 Manage SMS Providers: ......................................................................................................................................... 14 Manage Inbound Numbers: .................................................................................................................................... 15 Pre-Requisites

Verticurl – SMS App Cloud Configuration Guide · Verticurl – SMS App Cloud Configuration Guide ... SMS App Cloud Configuration Guide ... Account API & Secret key details

  • Upload
    dotram

  • View
    221

  • Download
    1

Embed Size (px)

Citation preview

VERTICURL PTE LTD 1

Verticurl – SMS App Cloud Configuration Guide

Table of Contents Verticurl – SMS App Cloud Configuration Guide ..................................................................................................... 1 Pre-Requisites ........................................................................................................................................................... 1 Configure Eloqua user account ..................................................................................................................... 2 Configure SMS delivery report CDO .............................................................................................................. 3 Callback URL setup on SMS Provider Account ............................................................................................. 4 Create SMS account ...................................................................................................................................... 6 Configure an SMS Campaign: .................................................................................................................................. 7 Unique Identifier ........................................................................................................................................... 12 Mobile Phone ................................................................................................................................................ 12 Campaign Name ........................................................................................................................................... 12 SMS Account Name ..................................................................................................................................... 12 SMS From ..................................................................................................................................................... 12 Inbound Report Range ................................................................................................................................. 12 SMS Message ............................................................................................................................................... 12 Contact Personalization ............................................................................................................................... 12 CDO Personalization .................................................................................................................................... 13 Suppress Duplicates .................................................................................................................................... 13 Enabled ......................................................................................................................................................... 13 Save .............................................................................................................................................................. 13 Manage SMS Providers: ......................................................................................................................................... 14 Manage Inbound Numbers: .................................................................................................................................... 15

Pre-Requisites

VERTICURL PTE LTD 2

Configure Eloqua user account

Log-in to the SMS app cloud using the below URL. https://cloudservices.verticurl.com/sms/Login.aspx

Go to ‘My Profile’ -> ‘Eloqua Configurations’

Provide the Eloqua Instance login details and click ‘Validate’.

*Note: The Eloqua user login details should have full API access.

VERTICURL PTE LTD 3

Configure SMS delivery report CDOThis Step is optional. If you want to capture the delivery reports in Eloqua, you can create a separateCDO with the below mentioned fields. Otherwise you can download the report directly in this application.[Inbound responses will also be captured within this same CDO]

VERTICURL PTE LTD 4

Callback URL setup on SMS Provider AccountTo collect outbound SMS delivery feedback details and all customer replies on inbound campaign backfrom the SMS provider, it is mandatory to update our callback URL’s on the appropriate account.Below is the setup procedure for Nexmo, it varies based on the provider selection.

Step 1: Login to SMS Provider account. (E.g. Nexmo) Enter Username and Password to login to the below URL: https://dashboard.nexmo.com/sign-in

Step 2: Click on the ‘API Settings’ on the top right corner which will open the ‘Edit’ option to update the callback URL’s.

VERTICURL PTE LTD 5

Step 3: Account API & Secret key details Take note of ‘API Key’ and ‘Secret Key’ on these settings which is needed to create an SMS Account (mentioned in next section) within this cloud app.

Step 4: Update Callback URL’s

Callback URL for Inbound Message: https://cloudservices.verticurl.com/sms/inbound-message.asmx/GetInboundMessage Callback URL for Delivery Receipt: https://cloudservices.verticurl.com/sms/message-status.asmx/GetDeliveryStatusdata

VERTICURL PTE LTD 6

Create SMS account Create an SMS account. Go to ‘My Profile’ -> ‘My SMS Accounts’

SMS Account Name: User choice (This name will appear in the SMS campaign configuration step) SMS Provider: Select the necessary provider (Nexmo, SMSDome, Infobip, EBSL). User Name/API Key: Provide the User Name or API Key based on the SMS Provider Password/Secret Key: Provide the Password or Secret Key based on the SMS Provider

VERTICURL PTE LTD 7

Configure an SMS Campaign:

a. Create new Campaign and Click on the Action tab option in the left side of the action list.

a. Check if SMS Cloud App listed among the Cloud Applications and proceed with the following steps

• Select appropriate target segment members to send SMS. • Drag & drop the Cloud App step. • Include a ‘wait step’ after the SMS Cloud App step.

VERTICURL PTE LTD 8

b. Double click on the Campaign Canvas “Actions” for pop up window and select the ‘Verticurl SMS

Sender’ app. c. When the editor icon in the pop up window is clicked , options to configure the SMS Cloud App will

appear.

VERTICURL PTE LTD 9

d. After clicking configure, it will directly take us to the configuration screen without asking the login

credentials. This is because our setup uses the ‘VID’ given to every user’s as an authentication token and makes the process much simple. If we want to access the cloud app outside of Eloqua then you need to use the given login credential.

VERTICURL PTE LTD 10

e. Check “Suppress duplicates” option if the duplicate “Phone number” needs to be removed or stop

contacts entering the cloud app step multiple times. f. Checking Enable step field will enable this specific campaign and allow the program members into

the app Cloud. g. Click on Save after updating the details and a confirmation message “Configuration registered

successfully” appears at the top of the screen if all mandatory details are filled.

The Same Campaign name can be used to retrieve the SMS Status report from the Delivery Reports Section

Choose the CDO field and click “Insert” to add personalized field in the message (E.g. Field merge “496.Email_Address1.FirstName(2610)” in SMS Message).

It shows warning when the message contains some Unicode characters

VERTICURL PTE LTD 11

Note: To add a website link in the SMS message, follow the below text format which will automatically interpreted as hyperlink by the mobile device. e.g. www.verticurl.com

VERTICURL PTE LTD 12

Unique Identifier Select the ‘Unique’ contact field. E.g. Email Address Mobile Phone Mobile Phone can be selected from either Contact or a specific CDO. If you select CDO Option, then you need to do below three steps.

1. Select the appropriate CDO where the mobile number exists for this campaign. 2. Select the Unique Field which is used to connect Contacts (E.g. Email Address). 3. Select the ‘Mobile’ number field.

Campaign Name This ‘Campaign Name’ field is used for internal SMS delivery reporting. Once the campaign is deployed, within this application you can access the delivery reports using this campaign name. (It is not necessary to use the same name as your Eloqua campaign name) SMS Account Name Within your app cloud user account, you can configure multiple SMS accounts for providers based on your requirement. Under this account, the ‘User Name’ & ‘Password’ details of the SMS vendor will be stored. SMS From To receive SMS responses from customers, select the ‘Inbound’ option and choose corresponding number which has been purchased in the Nexmo account. Inbound Report Range Select the Inbound report start & end date range (it will be mostly campaign start & end date). Responses captured within this period for this inbound number will be tied against a campaign while running the inbound reports. SMS Message Enter the actual SMS text message of this campaign. SMS messages can be personalized based on both ‘Contact’, ‘CDO’ fields using the following fields. Contact Personalization Select the required ‘Contact’ field and click ‘Insert’ which you want to be merged within the SMS message.

VERTICURL PTE LTD 13

CDO Personalization To insert a CDO field merge, again we need to follow three steps.

1. Select the appropriate CDO where the mobile number exists for this campaign. 2. Select the Unique Field which is used to connect Contacts (E.g. Email Address). 3. Select the required CDO field that needs to be merged in to the message.

[‘CDO’ & ‘Contact Unique Field’ will be populated automatically if you used the CDO Mobile number feature] Suppress Duplicates If Suppress Duplicates option is checked, the Cloud App checks for duplicates of same Mobile number and blocks the duplicate contact number. It ensures that SMS message is sent only once to a Mobile number.

Enabled Finally, make sure this checkbox is checked. This field decides whether this SMS campaign is currently active. Otherwise the SMS will not be sent if the campaign is enabled and this is unchecked. Save Click the ‘Save’ button and you will see a ‘Successfully Configured’ message at the top of the configuration screen. We can also ensure this campaign creation status by going to ‘Home -> Campaigns’. There you can see the newly created campaign listed on top.

VERTICURL PTE LTD 14

Manage SMS Providers:

Once logged in to the application, go to ‘My Profile’ -> ‘My SMS Accounts’ where you can create & manage multiple SMS vendor’s account details.

Multiple SMS provider accounts can be created by selecting different providers. From the above screen you can see Nexmo, SMS Dome, EBSL, Infobip are the SMS providers which are currently integrated with our SMS cloud app.

In case of Verticurl integrating a new SMS vendor, they will be avialable here for the users to create a new internal SMS provier account within the application. While configuring an SMS campaign, this internal ‘SMS Account Name’ will be listed for the selection.

VERTICURL PTE LTD 15

Manage Inbound Numbers:

Once you have purchased multiple inbound numbers within a Nexmo account, all those numbers will be retrieved while configuring an SMS campaign. In the below configuration, we need to select the ‘SMS From’ selection as ‘Inbound’ which will show a dropdown below contains list of all the available inbound numbers. Here, we can select the necessary numbers for this campaign. And again this procedure varies based on the SMS provider selection.