Cms Http-XML Interface Vf Mega Ecp v2 1

8/12/2019 Cms Http-XML Interface Vf Mega Ecp v2 1

1/16

Bulk API HTTP Interface 1

BB UU LL KK AA PP II

HH TT TT PP XX MM LL II nn tt ee r r f f aa cc ee


2/16

LEGAL INFORMATIONThe information in this document is subject to change without notice and describes only the product defined in theintroduction of this documentation. This document is intended for the use of Six DEE customers only for the purposesof the agreement under which the document is submitted, and no part of it may be reproduced or transmitted in anyform or means without the prior written permission of Six DEE. The document has been prepared to be used by

professional and properly trained personnel, and the customer assumes full responsibility when using it. Six DEEwelcomes customer comments as part of the process of continuous development and improvement of thedocumentation.

The information or statements given in this document concerning the suitability, capacity, or performance of thementioned hardware or software products cannot be considered binding but shall be defined in the agreement madebetween Six DEE and the customer. However, Six DEE has made all reasonable efforts to ensure that the instructionscontained in the document are adequate and free of material errors and omissions. Six DEE will, if necessary, explainissues, which may not be covered by the document.

Six DEE's liability for any errors in the document is limited to the documentary correction of errors. Six DEE WILL NOTBE RESPONSIBLE IN ANY EVENT FOR ERRORS IN THIS DOCUMENT OR FOR ANY DAMAGES, INCIDENTAL OR CONSEQUENTIAL(INCLUDING MONETARY LOSSES), that might arise from the use of this document or the information in it.

This document and the product it describes are considered protected by copyright according to the applicable laws.

Other product names mentioned in this document may be trademarks of their respective companies, and they arementioned for identification purposes only.

Copyright Six DEE Telecom Solutions Pvt. Ltd. 2012. All rights reserved.

Revision History

Date Revision No. Serial No. Description

03-02-2011 Initial version 1.0.0.0 Initial version


3/16

Bulk API HTTP Interface Page 3

Contents

1 Introduction.................................................................................42 Overview ....................................................................................5

2.1 HTTP API 5

2.1.1 HTTP XML Request for Plain Text Message ............................................................ 5

2.1.2 HTTP XML Response for Plain Text Message........................................................... 7

2.1.3 Sample XML for Plain Text Push ......................................................................... 9

2.1.4 HTTP XML Request for Binary Message................................................................11

2.1.5 HTTP XML Response for Binary Message...............................................................14

2.1.6 Sample XML for Binary Push.............................................................................15


4/16


1 Introduction

This document defines an XML interface structure for bulk and online campaign. Thecampaign should be preconfigured on the CMS platform for it to process the request from3rd party applications.


5/16


2 Overview

Bulk API supports the API's mentioned in this document which enables 3rd Parties to send

message through SMS.

2.1 HTTP APIThe following sections describe the APIs, the parameters and the values that need to beprovided for SMS. The platform supports asynchronous HTTP interface towards 3rd partyapplication.

The originating 3rd party applications would need to initiate a HTTP request in the formatmentioned in the subsequent sections and POST the XML packet defined later in the section

2.1.1 HTTP XML Request for Plain Text Message

Following is the format of the HTTP request (API) that the 3rd party systems would need toimplement in order to send message through SMS. It supports only plain English textmessage. It should only be used for Bulk Submit of messages. This API should not be usefor Single Message Submit.


6/16


2.1.1. 1 I ni t i a t e HTTP SessionThe client needs to initiate Bulk API by invoking this URL.

HTTP Request

http://:/BULK_API/BulkSubmit?XML=

2. 1.1. 2 PO ST XM L f or P l ain Text Mes sageOnce HTTP session is established 3rd party application need to post XML packet as

explained below. The method will be HTTP Post and XML string will be UTF-8 encoded.Acknowledgment of the request will be given as SUCCESS in the same stream.

Client to Bulk API

$feature

$transac t ionId

$t imeStamp

$URL

$username

$password

$campaignname

$circ lename

$channelname

$oa$message

$da


7/16


2 .1 .1 .3 P ar am et er D es cr ip ti on f or P la in Tex t M es sa geThe following table lists the parameters associated with each dialogue request primitiveand shows whether the parameter is Mandatory (M), in which case the message will bediscarded if the parameter is omitted, or Optional (O), in which case the parameter is notessential and conditional (C) depending upon some condition.

M - Must - parameter is mandatory

C - Depends - parameter is conditional

Optional - parameter is optional and if absent default values are used

Field Name Description Type Length

$feature Feature for SMS Push. Set it as BULK_SUBMIT. M 20

$transactionId Unique ID to identify request & same echoed backin response. It is alphanumeric.

M 32

$timeStamp Time Stamp of Request. Set it asDDMMYYYYHHMMSS

M 14

$URL Response URL, where response will be sent. Theresponse URL is invoked to indicatesuccess/failure of request acceptance by BULK APIplatform. In case of format error an errorresponse will be sent back. If unset response willnot be sent.

M 256

$username Username assigned to client. M 20

$password Password assigned to client. M 20

$campaignname Campaign name. Should be preconfigured on thesystem

M 20

$circlename Circle Name. Circle mnemonics are preconfigured

on the system. List will be shared at time ofintegration.

M 20

$channel Channel Name for Bulk Push.Eg: SMS

M 5

$oa Origination Address. M 11

$message Message text which will be pushed to thesubscribers.

M 400

$da List of MSISDNs. eg(DA|DA1|DA2.DAn). it shouldstart with 91 as Country Code.

M Max length ofone DA is 12and maximum50000 DAs canbe submittedin onerequest.

2.1.2 HTTP XML Response for Plain Text MessageThe response will be sent asynchronously on the same Response URL, which is provided inRequest XML. The method will be HTTP Post and XML string will be UTF-8 encoded.


8/16


2. 1.2. 1 PO ST XM L f or P l ain Text Mes sage

Bulk API to Client

$transac t ionId

$t imeStamp

$sta tusCode

$sta tusmessage

2 .1 .2 .2 P ar am et er D es cr ip ti on f or P la in Tex t M es sa geThe following table lists the parameters associated with each dialogue response primitiveand shows whether the parameter is Mandatory (M), in which case the message will bediscarded if the parameter is omitted, or Optional (O), in which case the parameter is notessential and conditional (C) depending upon some condition.





$transactionId Unique ID received in Request. M 32

$timeStamp Time Stamp of Response. M 14

$statusCode Status Code. (0-success or 1-failure) M 1

$statusmessage Status Message. M 64


9/16


2.1.3 Sample XML for Plain Text Push

2.1.3. 1 Request XML

Client to Bulk API

BULK_SUBMIT

123193245

22022010080900

ht tp : / /192.168.0 .100:8080/API/RSP

cpusercpuser

3gpromo

MUM

SMS

919898989898

This i s a tex t message

919945564598 |919945564591 |919945564590


10/16


2.1.3. 2 Response XML

Bulk API to Client

123193245

22022010080900

0

SUCCESS


11/16


2.1.4 HTTP XML Request for Binary MessageFollowing is the format of the HTTP request (API) that the 3rd party systems would need toimplement in order to send message through SMS. It supports Binary message. It should onlybe used for Bulk Submit of messages. This API should not be use for Single MessageSubmit.

2.1.4. 1 I ni t i a t e HTTP SessionThe client needs to initiate Bulk API by invoking this URL.

HTTP Request

http://:/BULK_API/BulkSubmit?XML=

2.1.4. 2 POST XML for Binary MessageOnce HTTP session is established 3rd party application need to post XML packet as

explained below. The method will be HTTP Post and XML string will be UTF-8 encoded.Acknowledgment of the request will be given as SUCCESS in the same stream. Thepartitioning of the long messages (with Header, Data) should be done at the client side.


12/16


Client to Bulk API

$feature

$transac t ionId

$t imeStamp

$URL

$username

$password

$campaignname

$circ lename

$channelname

$oa

$message

$da

BINARY_TYPE

$binaryType" +

DCS

$dcs

PID

$pid

HEADER-1

$header1

DATA-1

$data1


13/16


2. 1.4. 3 P ar am et er D esc ript ion f or B inar y MessageThe following table lists the parameters associated with each dialogue request primitiveand shows whether the parameter is Mandatory (M), in which case the message will be

discarded if the parameter is omitted, or Optional (O), in which case the parameter is notessential and conditional (C) depending upon some condition.





$feature Feature for SMS Push. Set i t as BULK_SUBMIT. M 20

$transactionId Unique ID to identify request & same echoed backin response. It is alphanumeric.

M 32

$timeStamp Time Stamp of Request. Set it asDDMMYYYYHHMMSS M 14

$URL Response URL, where response will be sent. Theresponse URL is invoked to indicate success/failureof request acceptance by BULK API platform. Incase of format error an error response will be sentback. If unset response will not be sent.

M 256

$username Username assigned to client. M 20

$password Password assigned to client. M 20

$campaignname Campaign name. Should be preconfigured on thesystem

M 20

$circlename Circle Name. Circle mnemonics are preconfiguredon the system. List will be shared at time ofintegration.

M 20

$channel Channel Name for Bulk Push.Eg: SMS

M 5

$oa Origination Address. M 11

$da List of MSISDNs. eg(DA|DA1|DA2.DAn). it shouldstart with 91 as Country Code.

M Max length ofone DA is 12and maximum50000 DAs canbe submittedin onerequest.

$binaryType Binary type which will be pushed to thesubscribers.

M 25

$dcs Dcs for Binary message M 3

$pid Pid for Binary message M 1

$header Header for Binary message M 320

$data Data for Binary message M 320

Multiple header and data tag can be added based on binary message.


14/16


2.1.5 HTTP XML Response for Binary MessageThe response will be sent asynchronously on the same Response URL, which is provided inRequest XML. The method will be HTTP Post and XML string will be UTF-8 encoded.

2.1.5. 1 POST XML for Binary Message

Bulk API to Client

$transac t ionId

$t imeStamp

$sta tusCode

$sta tusmessage

2. 1.5. 2 P ar am et er D esc ript ion for B inar y MessageThe following table lists the parameters associated with each dialogue response primitive

and shows whether the parameter is Mandatory (M), in which case the message will bediscarded if the parameter is omitted, or Optional (O), in which case the parameter is notessential and conditional (C) depending upon some condition.





$transactionId Unique ID received in Request. M 32

$timeStamp Time Stamp of Response. M 14

$statusCode Status Code. (0-success or 1-failure) M 1$statusmessage Status Message. M 64


15/16


2.1.6 Sample XML for Binary Push

2.1.6. 1 Request XML

Client to Bulk API

BULK_SUBMIT

123193245

22022010080900

ht tp : / /192.168.0 .100:8080/API/RSP

cpuser

cpuser

3gpromoMUM

SMS

919898989898

This i s a tex t message

919945564598 |919945564591 |919945564590

BINARY_TYPE

User Def ined Binary

DCS

245

PID

0

HEADER-1

050003000101


16/16


DATA-1

090709380915094000200935093e0938094d09240941002009360948093209400020092b093e093009380940002c0020092409410930094d0915002c0020092d093e09300924

2.1.6. 2 Response XML

Bulk API to Client

123193245

22022010080900

0

SUCCESS

Documents

Cms Http-XML Interface Vf Mega Ecp v2 1