For Origination Client Integration

REVE SMS Version 1.0.
Content
HTTP Application Programming Interface
Last Updated: 26th April, 2020
REVE Systems Page |2
Table of Contents
Introduction: ................................................................................................................................................. 3
Send SMS API: ............................................................................................................................................... 3
Send SMS Using Simple Parameters: .................................................................................................... 3
Send SMS Using JSON Object: ............................................................................................................... 3
Delivery Report: ............................................................................................................................................ 4
Query status for Single SMS ID: ............................................................................................................ 4
Query Status for Multiple SMS IDs: ...................................................................................................... 4
Pushing Delivery Status to Origination Using GET Method: ................................................................. 4
Pushing Delivery Status to Origination Using GET Method: ................................................................. 4
Introduction:
One can send SMS request through JSON object or through simple parameters using API Key and Secret
Key.
Send SMS API:

You can send SMS using API key and Secret key using GET method
Parameters:
Parameter Value Required
apikey apikey provided by termination √
secretkey secretkey provided by termination √
Content JSON formatted array of sms. Described bellow √
CallerID Sender Identification Number √
toUser SMS Receiver Number √
Message Content SMS Body √
Send SMS Using Simple Parameters:

Request:
http://192.168.18.119:8585/sendtext?apikey=xxxxxx&secretkey=xxxxx&callerID=8801847&toUs
er=452621&messageContent=abcd
Response:
{"Status":"0","Text":"ACCEPTD","Message_ID":"444"}
Send SMS Using JSON Object:

Request:
http://192.168.18.119:8585/send?apikey=5d2a&secretkey=465&content=[{"callerID":"8801847
","toUser":"452621,568468","messageContent":"abcd"},{"callerID":"9101847","toUser":"91262
1,918468","messageContent":"abcd"}]
Response:
{"Status":"0","Text":"ACCEPTD","Message_ID":"444"},{"Status":"0","Text":"ACCEPTD","Message
_ID":"445"}
API Response Status:
Case Response
If user not provided/Deleted {“Status”:”109”,”Text”:”REJECTD”}
If wrong password/ not provided {“Status”:”108”,”Text”:”REJECTD”}
If content not provided {“Status”:”114”,”Text”:”REJECTD”}
if internal server error occurs {“Status”:”101”,”Text”:”REJECTD”}
If request successful {“Status”:”0”,”Text”:”Acceptd”}
If request failed {“Status”:”1”,”Text”:”REJECTD”}
Along with Status there is one parameter “Message_ID”. For every message there is a unique message ID
which you can use later to get the delivery status of the SMS or system can push the status to origination
delivery URL for this message ID.
Delivery Report:
You can get delivery status for single SMS as well as for multiple SMS from our System using GET method.
Also, REVE SMS can push delivery status in your call back URL using GET and POST method.
Query status for Single SMS ID:

Request:
http://192.168.18.119:8585/getstatus?apikey=xxxxxx&secretkey=xxxxx&messageid=444
Response:
{"Status":"0","Text":"DELIVRD","Message_ID":"444","Delivery
Time":"0"}
Query Status for Multiple SMS IDs:

Request:
http://192.168.18.119:8585/getmultistatus?apikey=xxxxx&secretkey=xxxxx&messageids=444,4
45
Response:
[{"Status":"0","Text":"DELIVRD","Message_ID":"444","Delivery
Time":"0"},{"Status":"0","Text":"DELIVRD","Message_ID":"445","Delivery
Time":"0"}]
Pushing Delivery Status to Origination Using GET Method:

If the origination support GET method for receiving Delivery status then we can send the status in
following parameters
Parameters: REPLACE_STATUS, REPLACE_TEXT, REPLACE_ID
Sample URL:
http://abc.com/submitstatus?apikey=5d2a5cebf00d66bb65f30b5a81c882e4&secretkey=46586ec2&stat
us=REPLACE_STATUS&text=REPLACE_TEXT&messageid=REPLACE_ID
Pushing Delivery Status to Origination Using POST Method:

Header: Fixed part of the API will be sent through the header part of the POST request and the status will
be sent in body.
Sample Header:
http://abc.com/submitstatus?apikey=xxxxx&secretkey=xxxx
Example status in Body:

Status:0, Message_ID:193002, Text:DELIVRD
From Trace:
API Response Status:
Case Response
If api key isn’t provided {“Status”:”109”,”Text”:”REJECTD”}
If wrong password/ not provided {“Status”:”108”,”Text”:”REJECTD”}
If message id isn’t provided {“Status”:”114”,”Text”:”REJECTD”}
If message id isn’t valid or query has been {“Status”:”114”,”Text”:”REJECTD”}
done already for the same id
if internal server error occurs {“Status”:”101”,”Text”:”REJECTD”}
if Authorization failed {“Status”:”-42”,”Text”:”REJECTD”}
If request failed {“Status”:”1”,”Text”:”REJECTD”}
If request pending {“Status”:”2”,”Text”:”PENDING”}
If request sent {“Status”:”4”,”Text”:”SENT”}
If sms request successful {“Status”:”0”,”Text”:”DELIVRD”}

For Origination Client Integration

Uploaded by

Copyright:

Available Formats

For Origination Client Integration

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

For Origination Client Integration

Uploaded by

Copyright:

Available Formats

REVE SMS Version 1.0.

Send SMS API:

Send SMS Using Simple Parameters:

Send SMS Using JSON Object:

API Response Status:

Query status for Single SMS ID:

Query Status for Multiple SMS IDs:

Pushing Delivery Status to Origination Using GET Method:

Parameters: REPLACE_STATUS, REPLACE_TEXT, REPLACE_ID

Pushing Delivery Status to Origination Using POST Method:

Example status in Body:

API Response Status:

You might also like

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.