SMS Push API Documentation

This document explains how to integrate with the SMS Push API using HTTP/HTTPS and XML.

1. HTTP / HTTPS API

Send Single SMS

http://domain:port/pushapi/sendmsg?username=xxxxxx&dest=xxxxxxxxxx&apikey=12345&signature=SENDERID&msgtype=TypeofMessage&msgtxt=message&custref=xxxxx&campaign=xxxx

Success Response

{
"code":"6001",
"desc":"Message received by platform.",
"reqId":"0332250011593877667921535",
"time":"2020-07-04 21:17:47.922",
"custRef":"12345",
"partMessageIds":["0332250011593877667921535"],
"totalMessageParts":1,
"campaignName":"test"
}

Error Response

{
"code":"110",
"desc":"INVALID_DESTINATION_NUMBER",
"totalMessageParts":0
}

Plain Text SMS

http://IP:port/pushapi/sendmsg?username=xxxxxxx&dest=xxxxxxxxxx&apikey=12345&signature=SENDERID&msgtype=PM&msgtxt=message&custref=xxxxx&campaign=xxxx

Unicode / Multilingual SMS

http://IP:port/pushapi/sendmsg?username=xxxxxxx&dest=xxxxxxxxxx&apikey=12345&signature=SENDERID&msgtype=UC&msgtxt=message&custref=xxxxx&campaign=xxxx

Bulk SMS

http://IP:port/pushapi/sendbulkmsg?username=xxxxxxx&dest=9999999999,8888888888,7777777777&apikey=12345&signature=SENDERID&msgtype=PM&msgtxt=message&custref=xxxxx&campaign=xxxx

HTTP Parameters

2. XML API

Endpoint

http://IP:Port/pushapi/sendxmlmsg

Sample XML Request

<xmlPushRequest username="xxxxx" pin="xxxxx">
    <from>SENDERID</from>

    <recipientList>

        <recipient>
            <destAddress>9999999999</destAddress>
            <custref>a</custref>
        </recipient>

        <recipient>
            <destAddress>8888888888</destAddress>
            <custref>b</custref>
        </recipient>

    </recipientList>

    <message>
        <messageType>PM</messageType>
        <messageTxt>Test Message</messageTxt>
    </message>

</xmlPushRequest>

Sample XML Response

<xmlPushResponse>

    <recipientList>

        <recipient>
            <code>6001</code>
            <desc>Message received by platform.</desc>
            <timestamp>2019-02-23 17:29:39.747</timestamp>
            <requestId>2813050011550923179747</requestId>
        </recipient>

    </recipientList>

</xmlPushResponse>

Supported XML Requests

• One to One SMS
• One to Many SMS

XML Parameters

API Response Codes