Gateway API Integration

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 URL settings and parameters to guide you through this process. Feel free to contact us [support @miyapp.com] should you need assistance on integrating our API into your platform.

 

Send Message API

End Point URL: https://miyapp.com/sendsms.php

 

Parameters

No

Field Name

Example Value

Description

1

user *

miyapp

The login name for you SMS account

2

password *

123456

The login password for your SMS account

3

mobile *

9999999999

The target mobile numbers separated with Comma

4

senderid *

miyapp

The sender name that will show as ‘from’ address

5

message *

Hello world

The actual text message to send to the target mobile number

6

schedule

2016:01:31:14:20:10

This is to schedule the SMS in future date. The format should be yyyy:mm:dd:hh:mm:ss

7

unicode

1 or 2

This is used for send Unicode sms via SMS HTTP API.
Unicode = 1 (You can directly send the Unicode characters).
Unicode = 2 (You can send Unicode converted as hex)

8

group_id

1,2,3

Account holder Group id in miyapp.com.

* are mandatory

 

Example [Sending to Mobile(s)]
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 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

 

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

 

EndPoint URL
https://miyapp.com/balance.php

 

Parameters

No

Field Name

Example Value

Description

1

user *

miyapp

The login name for you SMS account

2

password *

123456

The login password for your SMS account

3

action *

send

The action string. It can be 'send' or 'receive' or 'account'

* are mandatory

 

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

 

Response Codes

1112:SUCCESS:Total Send Credits:1000000 Used Credits: 84 Remaining credits: 999916

1113:SUCCESS:Total Receive Credits:1000 Used Credits: 50 Remaining credits: 950

1114:SUCCESS:

{"name":"Super User","Totalsendcredits":"1000000","Usedsendcredits":"84","Remainingsendcredits":"999916","TotalRrecivecredits":"1000","UsedRrecivecredits":"50","Remainingrecivecredits":"950","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