Our bulk sms services can be seamlessly integrated into any application or platform that supports HTTP API, giving you the same advantage you currently enjoy on our platform.
Below are the API URL settings and parameters for integration with any platform that supports HTTP API.
Our SMPP bind API for high volume customers is available on request
Send Message API
You can send to single or multiple gsm numbers via the API.
End Point URL: https://miyapp.com/sendsms.php
API Name = miyapp
Example [Sending to Mobile(s)]
API URL: https://miyapp.com/sendsms.php?user=xxx&password=yyy&mobile=9444XXXXXXX,9044XXXXXXX&senderid=miyapp&message=hello&unicode=1&schedule=yyyy:mm:dd:hh:mm:ss
Example [Sending to Mobile(s), exclude DND numbers]
API URL: https://miyapp.com/sendsms.php?user=xxx&password=yyy&mobile=9444XXXXXXX,9044XXXXXXX&senderid=miyapp&message=hello&unicode=1&schedule=yyyy:mm:dd:hh:mm:ss&dnd=0
Example [Sending to Group(s)]
https://miyapp.com/sendsms.php?user=xxx&password=yyy&group_id=1,2&senderid=miyapp&message=hello&unicode=1&schedule=yyyy:mm:dd:hh:mm:ss
Example [Sending to Group(s), exclude DND numbers]
https://miyapp.com/sendsms.php?user=xxx&password=yyy&group_id=1,2&senderid=miyapp&message=hello&unicode=1&schedule=yyyy:mm:dd:hh:mm:ss&dnd=0
Example [SPC Portal]
API URL: https://miyapp.com/sendsms.php?user=xxx&password=yyy&mobile=@@recipient@@&senderid=@@sender@@&message=@@message@@
API response on Success: 1111
API Response confirmation: Contains
Account balance API: https://miyapp.com/balance.php?user=xxx&password=yyy&action=send
API Protocol: HTTP POST
Push to API as: Bulk
Parameters
user * = The login name for you SMS account
password * = The login password for your SMS account
mobile * = The target mobile numbers separated with comma (ex. 08138002199,08033333333 etc)
senderid * = The sender name that will show as ‘from’ address (ex. your company trade name, not more than 11 characters)
message * = The actual text message to send to the target mobile number (ex. Hello)
schedule = This is to schedule the SMS in future date. The format should be yyyy:mm:dd:hh:mm:ss (ex. 2016:01:31:14:20:10)
unicode = This is used for send Unicode sms via SMS HTTP API (ex. 1 or 2)
Unicode = 1 (You can directly send the Unicode characters)
Unicode = 2 (You can send Unicode converted as hex)
group_id = Account holder Group id in miyapp.com (ex. 1,2,3)
dnd = 0 (this is used to exclude DND numbers)
dnd = 1 (default value - this is used to include DND numbers)
* = mandatory
Response Codes
1111:SUCCESS:SMS Submitted Successfully, mobilecount=x, creditsused=y (When all the mobile numbers are accepted for delivery)
1112:SUCCESS:SMS Submitted Successfully, mobilecount=x, creditsused=y, failedcount=z (When there are few numbers which are not accepted for delivery)
1113:SUCCESS:SMS Scheduled Successfully
1001:ERROR:Invalid URL. User cannot be empty
1001:ERROR:Invalid URL. Password cannot be empty
1001:ERROR:Invalid URL. Mobile or Group id cannot be empty
1001:ERROR:Invalid URL. Message cannot be empty
1005:ERROR:Invalid value in username or password field
1030:ERROR:Account doesn't exist
1010:ERROR:Account expired
1015:ERROR:Your credits are Low
1020:ERROR:Invalid Sender
1040:ERROR:You are not allowed to send Unicode Messages
1050:ERROR:Character count is greater than X
1060:ERROR:Invalid Group id Specified
1070:ERROR:Invalid schedule time
1080:ERROR:Unable to schedule message
1090:ERROR:Unable to send message
1100:ERROR:Message has been waitlisted (mobilecount=x)
Check Balance API
You can retrieve your account balance via API
EndPoint URL: https://miyapp.com/balance.php
Example [Send Credits Balance]
https://miyapp.com/balance.php?user=xxx&password=yyy&action=send
Example [Receive Credits Balance]
https://miyapp.com/balance.php?user=xxx&password=yyy&action=receive
Example [Get Account]
https://miyapp.com/balance.php?user=xxx&password=yyy&action=account
Parameters
user * = The login name for you SMS account
password * = The login password for your SMS account
action * = The action string. It can be 'send' or 'receive' or 'account'
* = mandatory
Response Codes
1112:SUCCESS:Total Send Credits:xx Used Credits: yy Remaining credits: zz
1113:SUCCESS:Total Receive Credits:xx Used Credits: yy Remaining credits: yy
1114:SUCCESS:
{"name":"Super User","Totalsendcredits":"xx","Usedsendcredits":"yy","Remainingsendcredits":"zz","TotalRrecivecredits":"xxx","UsedRrecivecredits":"yyy","Remainingrecivecredits":"zzz","createdDate":"28 Jan,2016 03:14 PM","expiryDate":"03 Feb,2017 09:15 PM"}
1001:ERROR:Invalid URL. User cannot be empty
1001:ERROR:Invalid URL. Password cannot be empty
1055:ERROR:Please enter the valid action
For SMPP binding details, or any need for assistance on integrating our API into your platform, contact our Support Crew [crew@miyapp.com]