External Web Service Campaign

The External Web Service Campaign receives the user's MO and calls a third party Web Service to retrieve the desired information to deliver the user an MT message.

This allows businesses to integrate our messaging solutions to existing enterprise systems or websites. This is a common situation for businesses that already operate a comprehensive website where users can access the necessary information in real-time.

The Call

External Web Service Campaigns will always deliver the following information as a Web Parameter:

  1. mobile: The user's mobile number.

  2. mo: The user's MO message.

  3. ts: The MO origination timestamp in milliseconds

  4. shortcode: The shortcode where the MO was received.

Parameter Structure

The following gives insight into how the Call and parameters are defined:

Configured URL = green

Configured Parameters = blue

http://third.party.url?fixedparam1=fixedvalue1&fixedparam2=fixedvalue2

Call Example:

  • http://third.party.url?mobile=13057763416&mo=Hello&ts=1456847686174&shortcode=67213

The Response

The third-party Web Service must respond back with the following XML:

<?xml version="1.0" encoding="UTF-8"?> 
<message> 
    <text></text> 
</message> 

Response Example:

<?xml version="1.0" encoding="UTF-8"?> 
<message> 
  <text>This is a simple static message</text> 
</message> 

Reporting

Reports for Web Service Campaigns are similar to Keyword Campaign Reporting:

  • Opt-in history

  • Carrier distribution

  • Full MO log

    • includes Mobile numbers, MO texts, and timestamps

External Web Service Example

To give more insight into how our Web Services can work, consider the following Use Case:

An Airline wants to provide On-Demand flight status information to its customers. The user can simply text their flight number to the configured Shortcode and they will receive the latest flight status information as a response.

Sample Callhttp://www.airline.com/textservice/mobile=18131234567&mo=Flight%20Status&ts=1456847686174&shortcode=67213

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<message>
  <text>Airline name flight number YLL3212 is on time and is expected to land at 12:00 today.</text>
</message>

In order to have access to “External Web Service” menu please click on Menu in the upper left corner > Interactive campaigns > External Webservice

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.