Application Integration Guide

With

Corporate Messaging Platform

Prepared By: Technology Division

Document Version: 1.0.1
 Axiata (Bangladesh) Limited
 
TABLE OF CONTENTS

1 INTRODUCTION ................................................................................................................................... 3
2 FUNCTIONAL OVERVIEW................................................................................................................. 4
2.1 ALL OPERATIONS............................................................................................................................... 4
2.2 RETURN VALUE .................................................................................................................................. 4
2.3 OPERATION SPECIFICATIONS.............................................................................................................. 5
2.3.1 SendTextMessage ......................................................................................................................... 5
2.3.2 SendWAPPush .............................................................................................................................. 6
2.3.3 GetMessageStatus......................................................................................................................... 7

Corporate Messaging Platform 2

 Axiata (Bangladesh) Limited
 
1 INTRODUCTION
Corporate Messaging Platform (CMP) is designed to offer you a convenient way of sending and
receiving messages and initiating and managing bulk jobs and campaigns. You have option to
manage your contacts and bulk lists. You can view reports and statistics in different angles and
generate reports.

CMP comes with comes with web service to enable the design of external applications and
services to send SMS. This interface supports the transmission of SMS and WAP. Client
applications can request for sending messages and can request message status.

CMP Web Service uses Microsoft Internet Information Server to provide the underlying HTTP
server functionality. The following web methods are currently permitted:

ƒ HTTP GET
ƒ HTTP POST
ƒ HTTP SOAP

This user manual briefly describes how to use this portal.

Reference:
ƒ Service overview: http://cmp.robi.com.bd/WS/CMPWebService.asmx
ƒ Service WSDL: http://cmp.robi.com.bd/WS/CMPWebService.asmx?WSDL

Corporate Messaging Platform 3

 Axiata (Bangladesh) Limited
 
2 FUNCTIONAL OVERVIEW

2.1 ALL OPERATIONS

Corporate Messaging Platform Web Service is responsible to handle the submission of
messages from 3rd party. The following methods/functions are available:

Method Description
SendTextMessage To send SMS text messages
SendWAPPush To send WAP push
GetMessageStatus To retrieve the status of a sent message

2.2 RETURN VALUE

For any request to CMP web service, it response with a class ServiceClass which contains
the following public fields:

Method Type Description

Unique message reference number
e.g.: 22940
MessageId Number
This reference number need to be used for any future
purpose i.e. for calling GetMessageStatus
Message status
Possible values:
-1: Error occurred
Status Number 0: Pending
1: Successfully transmitted
2: Processing

To retrieve the current status of a sent message

StatusText String e.g.: Error occurred or Pending or Successfully
transmitted.
Error code
e.g.: -1, -2, 0, 1041, 1042 etc.
ErrorCode Number
Here a nonzero value means error occurred. A zero
value means no error.
Error description
It contains description of error.
ErrorText String
For example:
Error while submitting to SMSC, Invalid originator etc.
SMSCount Number Number of SMS e.g.: 1, 2, 3 etc

Corporate Messaging Platform 4

 Axiata (Bangladesh) Limited
 
2.3 OPERATION SPECIFICATIONS

2.3.1 SendTextMessage
Description:
This function sends a text message via CMP web service.

Signature:
ServiceClass SendTextMessage(String Username, String Password, String
From, String To, String Message)

Parameters:

Input fields Type Description

Username String Username that is used for login
Password String Password
From String Originator mobile number
To String Destination mobile number
Message String Message text

Samples:

9 HTTP GET:
http://cmp.robi.com.bd/WS/CMPWebService.asmx/SendTextMessage?Username=testu
ser&Password=XXXXXX&From=88018XXXXXXXX&To=8801XXXXXXXXX&M
essage=testmessage

9 HTTP POST:
Here is a simple form which will submit SendTextMessage request to the web service
using HTTP POST.

<form
action="http://cmp.robi.com.bd/WS/CMPWebService.asmx/SendTextM
essage" method="post">
<input type="text" name="Username" value="testuser" />
<input type="text" name="Password" value="XXXXXX" />
<input type="text" name="From" value="88018XXXXXXXX"/>
<input type="text" name="To" value="8801XXXXXXXXX" />
<input type="text" name="Message" value="testmessage"/>
<input type="submit" value="Submit" />
</form>

9 .Net Web Reference:

For a Microsoft DOT NET project you need to add
http://cmp.robi.com.bd/WS/CMPWebService.asmx as a web reference. The following
C# code shows how to call SendTextMessage:

bd.com.robi.cmp.CMPWebService service = new

bd.com.robi.cmp.CMPWebService();

bd.com.robi.cmp.ServiceClass ReturnValues =
service.SendTextMessage("testuser", "XXXXXX", "88018XXXXXXXX",
"8801XXXXXXXXX", "testmessage");

Corporate Messaging Platform 5

 Axiata (Bangladesh) Limited
 
if (ReturnValues.ErrorCode == 0)
Console.WriteLine("Message submitted successfully!
Message Id: " + ReturnValues.MessageId);
else
Console.WriteLine("Message submission failed");

2.3.2 SendWAPPush
Description:
This function sends a WAP push via Corporate Messaging web service.

Signature
ServiceClass SendWAPPush(String Username, String Password, String
From, String To, String WAPText, String WAPURL)

Parameters
Input fields Type Description
Username String Username that is used for login
Password String Password
From String Originator mobile number
To String Destination mobile number
WAPText String WAP text
WAPURL String WAP URL

Samples:

9 HTTP GET:
http://cmp.robi.com.bd/WS/CMPWebService.asmx/SendWAPPush?Username=testuser
&Password=XXXXXX&From=88018XXXXXXXX&To=8801XXXXXXXXX&WAP
Text=robi&WAPURL=http://wap.robi.com.bd

9 HTTP POST:
Here is a simple form which will submit SendWAPPush request to the web service
using HTTP POST.

<form
action="http://cmp.robi.com.bd/WS/CMPWebService.asmx/SendWAPPush"
method="post">
<input type="text" name="Username" value="testuser" />
<input type="text" name="Password" value="XXXXXX" />
<input type="text" name="From" value="88018XXXXXXXX" />
<input type="text" name="To" value="8801XXXXXXXXX" />
<input type="text" name="WAPText" value="wap" />
<input type="text" name="WAPURL" value="http://wap.robi.com.bd"
/>
<input type="submit" value="Submit" />
</form>

Corporate Messaging Platform 6

 Axiata (Bangladesh) Limited
 
9 .Net Web Reference:
For a Microsoft DOT NET you need to add
http://cmp.robi.com.bd/WS/CMPWebService.asmx as a web reference. The following
C# code shows how to call SendWAPPush:

bd.com.robi.cmp.CMPWebService service = new

bd.com.robi.cmp.CMPWebService();

bd.com.robi.cmp.ServiceClass ReturnValues =
service.SendWAPPush("testuser", "XXXXXX", "88018XXXXXXXX",
"8801XXXXXXXXX", "robi", "http://wap.robi.com.bd");

if (ReturnValues.ErrorCode == 0)
Console.WriteLine("WAP push submitted successfully! Message
Id: " + ReturnValues.MessageId);
else
Console.WriteLine("WAP push submission failed");

2.3.3 GetMessageStatus
Description:
This function is for getting status info about a message using a unique identification number
(MessageId).

Signature
ServiceClass GetMessageStatus(String Username, String Password, int
MessageId)

Parameters
Input fields Type Description
Username String Username that is used for login
Password String Password
MessageId int Message reference number e.g.: 22300

Samples:
9 HTTP GET:
http://cmp.robi.com.bd/WS/CMPWebService.asmx/GetMessageStatus?Username=
testuser&Password=XXXXXX&MessageId=22300

9 HTTP POST:
Here is a simple form which will submit GetMessageStatus request to the web service
using HTTP POST.

<form
action="http://cmp.robi.com.bd/WS/CMPWebService.asmx/GetMessag
eStatus" method="post">
<input type="text" name="Username" value="testuser" />
<input type="text" name="Password" value="XXXXXX" />
<input type="text" name="MessageId" value="22300" />
<input type="submit" value="Submit" />
</form>

Corporate Messaging Platform 7

 Axiata (Bangladesh) Limited
 

9 .Net Web Reference:

For a Microsoft DOT NET you need to add
http://cmp.robi.com.bd/WS/CMPWebService.asmx as a web reference. The following
C# code shows how to call GetMessageStatus:

bd.com.robi.cmp.CMPWebService service = new

bd.com.robi.cmp.CMPWebService();

bd.com.robi.cmp.ServiceClass ReturnValues =
service.GetMessageStatus("testuser", "XXXXXX", 22300);
if(ReturnValues.Status == 1)
Console.WriteLine("Message transmitted successfully!");
else
Console.WriteLine("Message transmission failed");

Console.WriteLine("Status info: " + ReturnValues.StatusText);

Console.WriteLine("Error code: " + ReturnValues.ErrorCode);
Console.WriteLine("Error details: " + ReturnValues.ErrorText);
Console.WriteLine("SMS count: " + ReturnValues.SMSCount);

Corporate Messaging Platform 8