1. Introduction - Cheap Bulk SMS Gateway | Bulk SMS API bulk sms api specification.pdf · Msgtype...

KAP Computer Solutions Pvt. Ltd.

1. Introduction

This document outlines the specification of KAPSYSTEM with respect to PUSH messaging system. The target audience of this document is internal customers, stakeholders, KAPSYSTEM existing and potential Customers.

2. Push Messaging SpecificationKAPSYSTEM platform provides API for pushing messages. Any sender name (CLI) in push request has to be registered with us; otherwise the request will be rejected by the platform.

2.1 Push Using URL [Get Method]Users can push message through URL using GET method. Choosing GET as the "method" will append all of the data to the URL; hence it is restricted to only 1024 characters.

2.1.1 Push URLKAPSYSTEM provides following URLs that takes few parameters as a query string for pushing the message.

a. URL Format for text messages

http://203.122.58.168/prepaidgetbroadcast/PrepaidGetBroadcast?userid=xxxxx&pwd=xxxx& msgtype=s&ctype=1&sender=KAPSYS&pno=919738010000&msgtxt=Test Message from KAPSYSTEM&alert=0

For every successful submission to KAPSYSTEM platform, platform generates a unique transaction id and returns as a response in the same URL call.

Response id format: UserId-152818-592

b. URL Format for SI Push

http://203.122.58.168/prepaidgetbroadcast/PrepaidGetBroadcast?userid=xxxxx&pwd=xxxx& ctype=10&pno=919738010000&sender=KAPSYS&msgtxt=Test Message from KAPSYSTEM&siurl=http://yahoo.com&alert=0&msgtype=S


Response id format: Userid-12450-7802

Confidential Page 1 of 6

Phone: +91-80-4900 4444 | Mobile: +91-97380 10000/1, +91-97380 23400(Support)Email: [email protected], [email protected] (Support) | URL: www.kapsystem.com


c. URL Format for Flash Messages

http://203.122.58.168/prepaidgetbroadcast/PrepaidGetBroadcast?userid=userid&pwd=password &msgtype=s&ctype=13&sender=KAPSYS&pno=919738010000&msgtxt=Test Message from KAPSYSTEM&alert=1


Response id format: Userid-22188-9386

2.1.2 Credit Enquiry URL

http://203.122.58.168:8000/servlet/com.prepaidcbs.listeners.GetAvailableCredits?userid=username&pwd =password

For every successful submission to KAPSYSTEM platform, platform returns the number of available credits.

Format: 1001 (i.e. available credits information)

2.1.3 URL ParametersFollowing are the supported parameters.

Parameter Name Parameter Description Parameter Value Parameter Type

Userid Account User Id User Id Provided to the user for Mauthentication

Pwd Account Password Password Provided M

Ctype Content Type 1 by default for text messages (Ref. Mto sec. 2.3)

Sender Account Sender Approved Sender Name M

Pno End User Number 919738010000(comma is the Mdelimiter for multiple mobilenumbers)

Msgtxt Message to be send Test Message M

Msgid Message Id 1111 (Maximum length of 15 and Omust be unique)

Alert For pushing promotional 1 (For pushing Alert Messages) M




or Alert messages 0 (For Promotional Messages)

Msgtype Message Type S=SMS S M

Siurl URL to be pushed with www.kapsystem.com Othe WAP push

� M=Mandatory, O=Optional

2.3 Push Using XML [POST Method] Users can push message through xml using post method. Choosing POST as the "method", the connection to the URL will be opened and XML chunk will be posted on the connection. There is no restriction of the character length and is secure method.

2.2.1 Server/XML DetailsConnection will be established from the following:

URL : http://203.122.58.168/prepaidgetbroadcast/prepaidxmlapi

XML Chunk:

xxxx

xxxx

xxx

xxxx"

xxx

xxx




2.2.2 XML ParametersFollowing are the supported parameters.

Parameter Name Parameter Description Parameter Value Parameter Type

Userid Account User Id User ID Provided to the use for Mauthentication

Pwd Account Password Password provided M

Ctype Content Type 1 by default for text message M(Ref to sec. 2.3)

Sender Account Sender Approved Sender Name M

Id Unique id for mobile numbersgiven in detail tag. This will beunique for all xml chunks

Msgid Message Id 1111 (Maximum length 15 and Mmust be unique)

Siurl URL to be pushed with the www.kapsystem.com NAWAP push. It is mandatory forWAP message else shouldbe NA.

Alert For pushing promotional or 1 (For Pushing Alert Messages) MAlert messages

0 (For Promotional Messages)

Pno End User Number 919738010000 M

Dlr For Delivery Report 1 (For receiving a delivery Mreport)

0 (If delivery report not required)

Msgtxt Message to be send Test Message M

� M=Mandatory, O=Optional




2.3 Content Type Parameter ValueSupported Content Types are:

2.4 Error CodesIn case of failure, KAPSYSTEM will not return response id but return the error code.



1. Introduction - Cheap Bulk SMS Gateway | Bulk SMS API bulk sms api specification.pdf · Msgtype...

Documents

Transcript of 1. Introduction - Cheap Bulk SMS Gateway | Bulk SMS API bulk sms api specification.pdf · Msgtype...