Developers

SMS Credit :

https://{Domain}/client/api/smscredit?apikey={apikey}

You will receive below response :

• In JSON

{
"status": {
"error-code": "000",
"error-status": "Success",
"error-description": "Success"
},
"account-expiry-date": "13/03/2020",
"balance-expiry-date": "13/03/2019",
"credit": "20795.65"
}

• In XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sms-credit>
<status>
<error-code>000</error-code>
<error-status>Success</error-status>
<error-description>Success</error-description>
</status>
<account-expiry-date>13/03/2020</account-expiry-date>
<balance-expiry-date>13/03/2019</balance-expiry-date>
<credit>20795.65</credit>
</sms-credit>

Output Parameter Description :

Get Delivery Report :

https://%7Bdomain%7D/client/api/getdlr?
apikey={apikey}&messageid={1,2}&externalid={1,2}&drquantity={X}&fromdate={yyyy-mm-dd hh:mm:ss{&todate={yyyy-mm-dd hh:mm:ss}

• Compulsory Parameter Description

1) ApiKey=apikey

• Optional Parameter Description

1) Messageid = messageid (unique sms serial no (ex. 1))
2) Externalid = externalId (unique sms serial no (ex. 2))
3) Drquantity = drquantity (X (ex. 5))
4) Fromdate = fromDate (date & time)
5) Todate = toDate (date & time)

You will receive below response :

• In JSON

{
"status": {
"error-code": "",
"error-status": "",
"error-description": ""
},
"dlr-details": {
"pending-dr-count": "",
"dr-count": "",
"dlr-list": [{
"message-id": "",
"external-id": "",
"mobile-no": "",
"message": "",
"submit-time": "",
"sent-time": "",
"delivery-time": "",
"actual-error-code": "",
"status": "",
"undelivered-reason": "",
"details": ""
}
]
}
}

• In XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dlr-response>
<staus>
<error-code></error-code>
<error-status></error-status>
<error-description></error-description>
</staus>
<dlr-details>
<dr-count></dr-count>
<dlr-list>
<message-id></message-id>
<external-id></external-id>
<mobile-no></mobile-no>
<message></message>
<submit-time></submit-time>
<sent-time></sent-time>
<delivery-time></delivery-time>
<actual-error-code></actual-error-code>
<status></status>
<undelivered-reason></undelivered-reason>
<details></details>
</dlr-list>
</dlr-details>
</dlr-response>

Sending SMS :

https://{Domain}/client/api/sendmessage?
apikey={apikey}&mobiles={mobileno}&sms={message}&senderid={senderid}&schedule={schedule}&sending-time={dd-MM-yyyyHH:mm:ss}&client-sms-ids={id&unicode={yes}&messagetype={messageType}

• For HTTP Request

Parameter	Value	Description
apikey	545dsffsJHK5869	Assigned apikey of user.
mobiles	8745896587,8401530248,8866559944	comma separated mobile numbers on which message will be delivered
sms	Test sms from api	Message content
senderid	aruhat	Sender id of user. If you do not enter any specific sender id, then it will take default sender id, which is assigned to your account
schedule	No/yes	If you want to scheduled message then set this to yes. By default its no.
sending-time	Sending time	If message needs to be sent to particular recipient, in future, then Date & Time can be scheduled for particular message. Format for date & time configurable.
unicode	yes/no, by default it’s no Means message’s are considered as nonunicode	If you want to send unicode SMS, then enter value as ‘yes’. If you do not provide value, then it will take non-unicode by default.
client-sms-ids	Third party id	If client want’s to give its own id then they set ids in this parameter. It consider as one id for one message.
message-type	Message Type	Message Type, Default is decided by system. Possible values sms, flash

• For XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<send-message>
<apikey>
<senderid>
<unicode>
<schedule>
<sending-time>
<message-type>
<sms-list>
<sms>
<message>
<mobiles>
<client-sms-ids>
</sms>
<sms>
<message>
<mobiles>
<client-sms-ids>
</sms>
</sms-list>
</send-message>

Parameter	Value	Description
<apikey></apikey>	Apikey <apikey>cd9e4dcb8e9d68ed</apikey>	Assigned apikey of user.
<senderid></senderid>	<senderid>Aruhat</senderid>	Sender id of user. If you do not enter any specific sender id, then it will take default sender id, which is assigned to your account
<unicode></unicode>	<unicode>yes</unicode>	If you want to send unicode SMS, then enter value as ‘yes’. If you do not provide value, then it will take nonunicode by default.
<schedule></schedule>	<schedule>no</schedule>	If you want to scheduled message then set this to yes. By default its no.
<sending-time></sendingtime>	<sending-time>14/07/2018 03:00:09</sending-time>	If message needs to be sent to particular recipient, in future, then Date & Time can be scheduled for particular message. Format for date & time configurable.
<sms-list></sms-list>	List of sms object	List of sms object if client wants to send more than message on same time.
<sms></sms>	SMS Object	Actual Object which contains sms content and mobile number and third party id.
<message></message>	<message>Actual Content</message>	Sms content
<mobiles></mobiles>	<mobiles>89********</mobiles>	Destination address
<client-sms-ids></client-smsids>	<client-sms-ids>a7845AB</client-sms-ids>	If client want’s to give its own id then they set ids in this parameter. It consider as one id for one message.
<message-type></messagetype>	<message-type>sms</messagetype>	Message Type

• In JSON

{
"apikey": "",
"senderid": "",
"unicode": "",
"schedule": "",
"sending-time": "",
"message-type": "",
"sms-list": [
{
"message": "",
"mobiles": "",
"client-sms-ids": ""
}
]
}

You will receive below response :

• In XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sms-response>
<status>
<error-code>
<error-status>
<error-description>
</status>
<sms-response-details>
<success-count>
<sent-sms-details>
<sms>
<client-sms-id>
<message-id>
<mobile-no>
</sms>
<sms>
<client-sms-id>
<message-id>
<mobile-no>
</sms>
</sent-sms-details>
<failed-sms-details>
<count>
<reasons>
<sms>
<sms-client-id>
<mobile-no>
<failed-reason>
<message-content>
<sender-id>
<balance>
<schedule-time>
</sms>
</reasons>
</failed-sms-details>
</sms-response-details>
</sms-response>

• In JSON

{
"status": {
"error-code": "",
"error-status": "",
"error-description": ""
},
"sms-response-details": [{
"success-count": "",
"sent-sms-details": [{
"client-sms-id": "",
"message-id": "",
"mobile-no": ""
}
],
"failed-sms-details": [{
"count": "",
"reasons": [{
"sms-client-id": "",
"mobile-no": "",
"failed-reason": "",
"message-content": "",
"sender-id": "",
"balance": "",
"schedule-time": ""
}
]
}
]
}
]
}