developers-api

About API

Developers API

BULK SMS – Founded in 2010 in headquarters in New Delhi India , MY SMS APP , we are unique by our one stop solutions Bulk SMS Services addressing customers of all sectors . We are involved in offering end to end Web , Data & Voice Communication solutions; may be its new setting or optimizing current operations , we provide better ways of working , we ensure that our solutions significantly influence bottom lines and help our customers lower their total cost of ownership.

Business enterprises looking for customized end-to-end and/or comprehensive software solutions, MY SMS APP is the answer. The uppermost priority in our minds is rationality of purpose for a client’s site. Web Technologies like Bulk SMS Services, Website Redesigning, Web Application Development, Portal Development, Flash Intros, SEO (Search Engine Optimization), Website Maintenance, Web Promotion, Website Designing(Commerce Website, Static Website, CMS, Dynamic Website, Personal Websites),are few of our services what we offer.

API REFERENCE

Overview

This User Manual provides specifications of the API for the automated sending of SMS via the Internet. This guide is intended for the developers and clients alike who plan to integrate their systems with Bulk SMS service.

Required Environment

In order to use our API, you will need to have a system that has internet connectivity. This may be direct internet connectivity or via a firewall or proxy server. Additionally, should you wish to receive delivery reports (DLRs), you must have a web server that is able to receive incoming requests from the Internet. This web server does not necessarily have to be running on the same machine that is sending messages to us.

This is one of the simpler server-based method of communication. It can be used either in the form of a HTTP POST or HTTP GET. We recommend POST for larger data transfer and data security. All calls to the API must be URL-encoded. The parameter names are case sensitive.

Note: We recommend POST for larger data transfer and data security. All calls to the API must be URL encoded.

SSL Enabled API Triggering

This API has been designed to allow you to access it using an SSL Enabled connection for added security.

To trigger the API on an SSL enabled connection, enter the URL beginning with https:// instead of http://

Mobile Phone Number Format

All mobile phone numbers submitted via API should be a valid 10 digit mobile number starting from 7, 8 or 9. For example: 9xxxxxxxxx, 8xxxxxxxxx, 7xxxxxxxxx.If mobile number exceeds 10 digits the last 10 digits will be considered as a mobile number. For example: 919xxxxxxxxx will be considered as 9xxxxxxxxx

Security

Our API supports both HTTP and HTTPS. Using HTTPS to encrypt all requests through SSL is recommended, but if you’re using a client and tool that’s not set up to make SSL requests, you can use HTTP. All requests are secured through BASIC authentication via the Working Key. An additional level of protection is provided where Working key can be configured to accept requests from a specific IP Address only. Also, API usage with username & password combination is removed due to security concerns.

Output Restrictions

If the provider network is down, our Gateway Servers will retry your message up to six hours before giving up. Also, Duplicate messages in single request only are filtered by default. A “duplicate message” is defined as the same destination address, sender address and the message body. However, duplicate messages sent by different request are NOT filtered.

Input Restrictions

All the parameter passed must be provided in the URL encoded format. Also, recommended to use the POST method for error free submission due to URL limitations.

Sender ID Options

All text messages carry a sender ID. When you send a text message through API, you could use any of the approved sender IDs for your account. You can reach us for applying for a new sender ID.

Setting a Sender ID (Alphabetic Originator)

You can set the sender ID with your company name, or anything. So, this means that your recipients could see the name you want in the sender field rather than just a phone number. This alphabetic originator, or sender ID, can contain characters from a-z, A-Z. Other characters may cause messages to fail.

Supported Character Sets

GSM 03.38 Encoding

The standard SMS mobile-phone character set is used universally to send text messages. The standard character set allows few of the Roman alphabet and the most common accented forms, certain special characters, and few Greek alphabets that sum up to 160 characters. It includes the following characters:

@ £ \ $ ¥ è é ù ì ò Ç \ n Ø ø \ r Å å ? _ F ” ? O ? ? S T ? Æ æ ß É ! \ ” # ¤ % & ‘ ( ) * + , – ../ 0 1 2 3 4 5 6 7 8 9 : ; < = > ? ¡ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z ? Ö Ñ Ü § ¿ a b c d e f g h I j k l m n o p q r s t u v w x y z ö ñ ü à ä Ä { } \ ~ [ ]

Note: All extended characters will take two characters to send. Extended characters are: £ ¥ è é ù ì ò Ç Ø ø Å å Δ Φ Γ Λ Ω Π Ψ Σ Θ Ξ Æ æ ß É ¤ ¡ Ä Ö Ñ Ü § ¿ ä ö ñ ü à | \ { } ~ [ ] ^ Also, extended character like € takes three characters to send.

Unicode

When using non-GSM 03.38 characters SMS transmits as a Unicode message. The Unicode character support provides the ability to send a message in Hindi, Kannada, Tamil etc.

If the message to be transmitted is in Unicode format, the entire message has to be converted into Unicode. Also, Unicode transmission will charge double the credits, including plain English SMS sent in Unicode mode.

Message Length - Multipart Messages

Standard GSM 03.38 Character Set

Single text messages are limited to 160 characters, including spaces. The maximum length of two-part or three-part multipart text messages is 306 (2 x 153) and 459 (3 x 153) characters, respectively. You could send up to 1000 characters as multipart message which will be split into 7 messages internally. This refers only to messages that contain the standard GSM 03.38 character set.Each multipart text message is limited to 153 characters rather than 160 due to the need for user-data headers (UDHs) information. Mobile phones use UDH information to enable them to link long messages together so that they appear as single SMS messages in recipient’s phone inbox.

Number of SMS	Number of characters in the linked SMS
1	upto 160 characters
2	upto 306 characters (2 x 153)
3	upto 459 characters (3 x 153)
4	upto 612 characters (4 x 153)
5	upto 765 characters (5 x 153)
6	upto 918 characters (6 x 153)

Unicode Characters

Using Unicode, for languages such as Hindi, restricts your message to a maximum of 70 characters per SMS. You can, however, send longer text messages, with our system splitting them into two or at the three separate text messages. The maximum lengths of two-part and three-part multipart Unicode text messages are 134 (2 x 67) and 201 (3 x 67) characters, respectively. You could send up to 500 characters as multipart message which will be split into 8 messages internally.

Number of SMS	Number of characters in the linked SMS
1	upto 70 characters
2	upto 134 characters (2 x 67)
3	upto 201 characters (3 x 67)
4	upto 268 characters (4 x 67)
5	upto 335 characters (5 x 67)
6	upto 402 characters (6 x 67)
7	upto 469 characters (7 x 67)
8	upto 500 characters (7 x 67) + (1 x 31)

Successful Submission of SMS

For each successful submission of an SMS, the API would return a unique message ID for that transaction. The Client’s Application should capture the unique message ID and fetch a Delivery Report (DLR) against that corresponding message ID. This message ID then can be used to track the status of the message and receive the delivery report against this message ID through the delivery report URL specified by the client.

Response Formats

By default, the API URL generates responses in JSON format. You can also generate responses in XML, PHP, JSONP formats. All you need to do is add &format=php (for PHP format) or &format=xml (for XML format).

Response Parameters

The response parameters in case of error in API are tabulated below:

Name	Parameter	Description	Expected Values
Response code	status	Error code for your api call	Numeric Value A401,E601 etc
Error Message	message	Error Message for API call	String.Refer API Error codes section

API Error Codes

When certain parameters of the API URL are not entered correctly, you will receive a response from the URL stating the type of error. These error descriptions will help you to pin-point the erroneous parameter in the URL and rectify it.

The common error codes received while using the API in the below format are :

STATUS	MESSAGE
A400	Api file not found in project
A401A	Method Not Implemented.
A401B	Method Not Found
A402	Api Key not found.
A403	Api Signature not found
A404	Your api account got suspended
A405	Api secret not found.
A406	Request is not allowed from this ip
A407	Header misconfigured
A408	Api Signature not equal

SMS Status Codes-HTTP API(On Submission)

When we receive an API call for sending SMS one of the following status code is attached at the application level. However, operator level status codes are tabulated next.

The common status codes received while using the API are:

AWAITED-DLR	Mobile number has been accepted and submitted to the operator. Awaiting delivery report from the operator
DNDNUMB	Mobile number is DND.
OPTOUT-REJ	Optout from subscription.
INVALID-NUM	In case any invalid number present along with the valid numbers.

SMS Status Codes-XML/JSON API(On Submission)

There could be one or more nodes in an XML API, each of those nodes could have a different status code on submission

The common status codes received while using the API are:

AWAITED-DLR	Mobile number has been accepted and submitted to the operator. Awaiting delivery report from the operator
DNDNUMB	Mobile number is DND.
OPTOUT-REJ	Optout from subscription.
INVALID-NUM	In case any invalid number present along with the valid numbers.
SENDER-ID-NOT-FOUND	In case the sender ID given in any one of the nodes is not available
INV-TEMPLATE-MATCH	In case the message given in any one of the nodes does not match the template approved for the sender ID in the same node
MAX-LENGTH	In case the message given in any one of the nodes exceeds the maximum of 1000 characters

SMS Status Codes(Operator Level)

On submission of a message to operator, we associate one of the following status codes to every SMS in order to track the status

The common status codes received while using the API are

NO-CREDITS	Insufficient credits.
SERIES-BLOCK	Mobile number series blocked.
INV-NUMBER	Invalid number.
SERVER-ERR	Server error
SPAM	Spam SMS
SNDRID-NOT-ALLOTED	Sender ID not allocated.
BLACKLIST	Blacklisted number
TEMPLATE-NOT-FOUND	Template not mapped.
INV-TEMPLATE-MATCH	Template not matching approved text.
SENDER-ID-NOT-FOUND	Sender ID not found.
DNDNUMB	DND registered number.
NOT-OPTIN	Not subscribed for opt-in group.
TIME-OUT-PROM	Time out for promotional SMS.
DELIVRD	SMS successfully delivered.
INVALID-SUB	Number does not exist. / Failed to locate the number in HLR database.
ABSENT-SUB	Telecom services not providing service for the particular number. / Mobile Subscriber not reachable.
HANDSET-ERR	Problem with Handset or handset failed to get the complete message. / Handset doesn't support the incoming messages.
BARRED	End user has enabled message barring system. / Subscriber only accepts messages from Closed User Group [CUG].
NET-ERR	Subscriber's operator not supported. / Gateway mobile switching error.
MEMEXEC	Handset memory full.
FAILED	SMS expired due to roaming limitation. / Failed to process the message at operator level.
MOB-OFF	Mobile handset in switched off mode.
HANDSET-BUSY	Subscriber is in busy condition.
SERIES-BLK	Series blocked by the operator.
EXPIRED	SMS expired after multiple re-try.
REJECTED	SMS Rejected as the number is blacklisted by operator.
OUTPUT-REJ	Unsubscribed from the group.
REJECTED-MULTIPART	Validation fail [SMS over 160 characters]
UNDELIV	Failed due to network errors.
NO_DLR_OPTR	In case operator have not acknowledge on status report of the SMS.

Sending An SMS

HTTP API sends a text message using POST/GET and form-encoded data. The URL you use to send a text message has a required field called api_key, which is unique and assigned to your account.

The other required parameters for the Request are method,sender, to and message, which are used to define the destination phone number and the message body. If you want to send to multiple phone numbers, provide the numbers in comma separated format.

To send an SMS using the HTTP API, the following URL format is used:

https://www.mysmsapp.in/api/push.json?apikey=<apikey>&sender=<senderid>&mobileno=<mob>&text=<text>

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
delivery reports URL	dlrurl	The URL to receive delivery reports. Spiffing custom is mandatory.	delivery reports URL
Message ID	custom	Custom message ID by customer, comma separated	Alphanumeric (max 40 char)
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM
unicode	unicode	To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.	1 / 0 / auto
flash	flash	To specify that the message is to be sent in the flash format	1 or 0

Advanced Parameters(Optional)

The advanced parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
Callback function name	callback	Callback function for JSONP response format.	String
Custom reference fields	custom1 & custom2	Custom reference fields	Alphanumeric (max 40 char)
port number	port	Port number to which SMS has to be sent	Valid integer port number above 2000

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

ErrorCode	Description
0	NORMAL DELIVERED
1	Source not found\|EC_UNKNOWN_SUBSCRIBER
2	Sink not found\|EC_UNKNOWN_BASE_STATION
3	Delivery zone not found\|DND Fail
5	Location not found\|EC_UNIDENTIFIED_SUBSCRIBER
6	Location blocked\|Absent subscriber
7	Reply path not found\|UNKNOWN EQUIPMENT
8	Message not submit\|FSM TIMEOUT
9	Unsupported number plan\|EC_ILLEGAL_SUBSCRIBER
10	Unsupported type of number\|EC_BEARER_SERVICE_NOT_PROVISIONED
11	Message not DELIVER or STATUS\|EC_TELESERVICE_NOT_PROVISIONED
12	Dialling zone not found\|EC_ILLEGAL_EQUIPMENT
13	Not home zone and IMSI not allowed\|EC_CALL_BARRED
14	Not home zone and IMSI fetch failed\|Barred unauthorized message originator
15	Screening block\|CUG REJECT
18	ESME error\|message waiting for report expired'
19	Originating location mismatch\|SRIAck unsuccessful with any other error codes'
20	Originating reservation failed\|EC_SS_INCOMPATIBILITY
21	Originating reservation denied subscription not found\|EC_FACILITY_NOT_SUPPORTED
22	Originating reservation denied subscription state illegal\|Memory capacity exceeded
23	Originating reservation denied call case blocked for subscription\|Unknown Subscriber'
24	Originating reservation denied call case blocked for subscription type\|call forbidden'
25	Originating reservation denied low balance\|the network does not support SMS'
26	'teleservice not supported'
27	Absent subscriber
29	'HLR:data error in route signal'
30	Terminating reservation failed\|HLR:data lacked'
31	Terminating reservation denied subscription not found\|EC_SUBSCRIBER_BUSY_FOR_MT_SMS
32	Terminating reservation denied subscription state illegal\|EC_SM_DELIVERY_FAILURE
33	Terminating reservation denied call case blocked for subscription\|EC_MESSAGE_WAITING_LIST_FULL
34	Terminating reservation denied call case blocked for subscription type\|EC_SYSTEM_FAILURE
35	Terminating reservation denied low balance\|EC_DATA_MISSING
36	EC_UNEXPECTED_DATA_VALUE
37	'Unmarked Subscriber'
38	'failure because the subscriber is busy'
39	'VMSC isolated'
40	System is congested\|VMSC:data lacked'
41	Originating IMSI mismatch\|VMSC:unexpected data'
42	'MS error'
43	Not Supported by equipment
44	Illegal equipment
45	Quarantine Add\|Unspecific PID Error
46	Quarantine Remove\|Message Class Not Supported
47	DCS error
48	TPDU Not Supported
49	Short message delivery failure with memory capacity exceeded
50	Unexpected error from Store\|UNKNOWN ERROR
51	Direct delivery disabled from store\|EC_RESOURCE_LIMITATION
53	Message limit exceeded\|Subscriber Busy For MT-SMS
54	Retry scheme ended\|Data Download Error
60	Originator blocked\|Absent subscriber
61	Destination blocked\|Absent subscriber
62	Keyword blocked\|Absent subscriber
63	SC address blocked\|Absent subscriber
64	Blocked due to exceeded quota\|Absent subscriber
65	Loop detected\|Absent subscriber
66	Data coding scheme blocked\|Absent subscriber over GPRS Page Fail
67	Information element identifier blocked\|Absent subscriber over GPRS Detached
68	Country Code Validation Block\|Absent subscriber over GPRS Deregistered
69	Destination Flooding
70	No ESME provider available\|MS store is full'
71	ESME account not connected\|EC_UNKNOWN_ALPHABET
72	No ESME sub account routing\|EC_USSD_BUSY
74	ESME local throttling - exceeded msg/s\|INVALID HEADER IN MSG
80	Home routing sender GT mismatch\|PENDING DLR (Retry )
81	Location mismatch between provided location and location known to HLR.\|Service not supported
82	IMSI mismatch between provided IMSI \|Mistyped parameter
83	Local throttling by sink\|No response from the peer
84	The IMSI could not be retrieved from the HSS\|Resource limitation
85	The IMEI of the UE is unknown\|Initiating release
86	The user location is unknown\|Unrecognised error
87	ESME router\|Provider Error (In case of any failures observed in TCAP level this error will generate).
88	Network fluctuation from far End Operator(Temporary Error)
89	INVALID PACKET AT SMSC LEVEL
90	USER-ABORT
91	PROVIDER-ABORT
92	MSC NUMBER MISSING
93	Equipment protocol error
94	Equipment not SM equipped
95	Unknown service centre
96	Service Centre congestion
97	INVALID SCHEDULE DELIVERY TIME
98	Subscriber not SC subscriber
99	Invalid SME address
100	Unidentified subscriber\|no response from the called subscriber'
101	Facility not supported\|VMSC:the called MS poweroff'
102	System failure\|VMSC:limited due to MS roaming' / SENDER ID BLOCKED
103	Unexpected data value\|ROUTE NOT ACTIVE
104	Data missing\|OFF-NET NOT ACTIVE FOR ACCOUNT/ ON-NET ROUTES NOT DEFINED
105	Equipment protocol error\|MTP_FAILURE
106	UNKNOWN service centre address\|MS response is overtime'
107	Service centre congestion\|HLR:the subscriber is unregistered'
108	Invalid short message entity address\|ROUTE BLOCKED FOR THIS SERIES
109	Subscriber not service centre subscriber\|MSISDN SERIES NOT CONFIGURED
110	Reject\|NOT ABLE TO GET FINAL ROUTE
111	Local cancel\|Queue_Unvailable
112	Abort\|NOT A VALID TEMPLATE
113	Exception\|MANDATORY WORDS NOT FOUND
114	UNKNOWN\|DEFAULT ROUTE NOT FOUND IN CONFIGURED ROUTES
115	ROUTE NOT CONFIGURED AT PLATFORM LEVEL
116	Map Dialog P Abort Indication Provider Reason: Maintenance Activity
117	Map Dialog P Abort Indication Provider Reason: Version Incompatibility
118	Map Dialog P Abort Indication Provider Reason: Abnormal Dialogue
119	MAP_DLGUA_UsrRsn_NTR_MapDlgUnavailable
120	MAP_DLGUA_UsrRsn_NTR_MapNotConfigured
121	MAP_DLGUA_UsrRsn_NTR_OtherErr
122	MAP_DLGRJT_PrvRsn_NotSent
123	INTERNATIONAL ROAMING
124	EC_OR_appContextNotSupported
125	EC_OR_invalidDestinationReference
126	EC_OR_invalidOriginatingReference
127	EC_OR_encapsulatedAC_NotSupported
128	EC_OR_transportProtectionNotAdequate
129	EC_OR_noReasonGiven
130	EC_OR_potentialVersionIncompatibility
131	EC_OR_remoteNodeNotReachable
132	Map Dialog Rejected Refuse Reason: Application Context not supported
133	Map Dialog Rejected Refuse Reason: Potential Version Incompatibility
134	Map Dialog Rejected Refuse Reason: Remote Node not reachable
135	Map Dialog Rejected Provider Reason: Provider malfunction
136	Map Dialog Rejected Provider Reason: Transaction Released
137	Map Dialog Rejected Provider Reason: Resource Limitation
138	Map Dialog Rejected Provider Reason: Maintenance Activity
139	Map Dialog Rejected Provider Reason: Version Incompatibility
140	Map Dialog Rejected Provider Reason: Abnormal Dialogue
141	Map Dialog User Abort Diagnostic Info: Short Term resource Limitation
142	Map Dialog User Abort Diagnostic Info: Long term resource limitation
143	Map Dialog User Abort Diagnostic Info: Handover cancellation
144	Map Dialog User Abort Diagnostic Info: Radio Channel Release
145	Map Dialog User Abort Diagnostic Info: Call Release
146	Map Dialog User Abort Diagnostic Info: Network path Release
147	Map Dialog User Abort Diagnostic Info: Associated Procedure release
148	Map Dialog User Abort Diagnostic Info: Tandem Dialog Release
149	Map Dialog User Abort Diagnostic Info: Remote Operation Failure
150	UNKNOWN subscriber\|Map Dialog User Abort User Reason: User specific reason
151	Call barred\|Map Dialog User Abort User Reason: User resource limitation
152	Teleservice not provisioned\|EC_NNR_noTranslationForAnAddressOfSuchNature
153	Absent subscriber\|EC_NNR_noTranslationForThisSpecificAddress
154	Facility not supported\|EC_NNR_subsystemCongestion
155	System failure\|EC_NNR_subsystemFailure
156	Unexpected data value\|EC_NNR_unequippedUser
157	Data missing\|EC_NNR_MTPfailure
158	Memory capacity exceeded\|EC_NNR_networkCongestion
159	Mobile subscriber not reachable\|EC_NNR_unqualified
160	Reject\|EC_NNR_errorInMessageTransportXUDT
161	Local cancel\|EC_NNR_errorInLocalProcessingXUDT
162	Abort\|EC_NNR_destinationCannotPerformReassemblyXUDT
163	Exception\|EC_NNR_SCCPfailure
164	UNKNOWN\|EC_NNR_hopCounterViolation
165	EC_NNR_segmentationNotSupported
166	EC_NNR_segmentationFailure
167	USSD platform Unknown error
168	DND Blocked
169	MAP-P-Abort: Provider reasons
170	MAP-P-Abort Provider reason: Malfunction
171	MAP-P-Abort Provider reason: Dialog Released
172	'waiting queue in destination subscriber table is full'
173	MAP-P-Abort Provider reason: Abnormal Dialog
174	MAP-P-Abort: Invalid PDU
175	MAP-Open: Out of MAP dialogs
176	Invalid Service code
177	Subscriber MSISDN Blacklisted
178	Subscriber IMSI Blacklisted
179	Invalid Originating Address with Length greater than 20 chars
180	MAP-Open Refuse reason: Node Not Reached
181	'service barred'
182	'operation barred'
183	VLRBlackListed
184	VLRWhiteListed
185	MAP-Notice Problem: Message Cannot Be Delivered
186	BILNG_SystemError
187	MAP-Notice: Abnormal event detected by peer
188	MAP-U-Abort: Error
189	MAP-U-Abort User Reason: User Specific Reason
190	MAP-U-Abort: User resource limitation
191	MAP-U-Abort: Resource unavailable (short term)
192	Unexpected session release from Servers/3rd party APP
193	'unknServCent'
194	'sc_Congestion'
195	'invaSME_Add'
196	'subsNotSC_Subsc'
197	Application Specific Error from Client
198	MAP-U-Abort: Application procedure cancellation (tandem dialogue released)
199	MAP-U-Abort: Application procedure cancellation (remote operations failure)
200	Unidentified subscriber\|OPERATOR BLOCKED FOR ACCOUNT
201	Absent subscriber IMSI detached\|EC_unknown Subscriber
202	Absent subscriber no page response\|Unknown Base Station
203	Subscriber busy for MT-SMS\|Unknown MSC
205	Illegal subscriber\|EC_Unidentified Subscriber
206	Illegal equipment\|Absent Subscriber for SM
206	Illegal equipment\|Absent Subscriber for SM
207	System failure\|Unknown Equipment
208	Unexpected data value\|Roaming Not Allowed
209	Data missing\|Illegal Subscriber
210	Memory capacity exceeded\|Illegal SS Operation
211	Equipment protocol error\|SS Error Status
212	Equipment not short message equipped\|SS Not Available
213	Reject\|SS Subscription Violation
214	Local cancel\|SS Incompatible
215	Abort\|HLR:limited due to MS roaming'
216	Exception\|Internal IPC memory allocation Failure
217	UNKNOWN\|Internal IPC Router Failure
218	'HLR:illegal subscriber'
219	'HLR:subscriber absent'
220	'HLR:the called MS poweroff'
221	MSISDN BLOCKED
221	Message List Full
222	MESSAGE CONTENT IS BLACKLISTED/EC_Network System Failure
223	Data Missing
224	Unexpected Data
225	MESSAGE CONTENT IS BLACKLISTED AT OPERATOR/ 'HLR:no response'
226	'VMSC:no response'
227	IN Subscriber not exist1
228	'the destination subscriber PPS authentication overtime'
229	'IN Invalid subscriber'
230	Not Allowed
231	ATI Not Allowed
232	No Group Call Number Available
233	Resource Limitation
234	Unauthorized Requesting Network
235	Unathorized LCS Client
236	Position Method Failure
237	Custom error 8
238	Custom error 9
239	Custom error 10
240	Recipient Temporary Error
241	Recipient Permanent Error
242	Service Not configured/for a particular circle/subscriber. Or simply menu is incomplete or service i
243	Terminating session due to invalid input
244	Unspecific
245	'HLR:the remote address not reachable' /'VMSC:Invalid Destination'
246	Client Resource Not Available
247	Unknown Alphabet
248	EC_TIME_OUT
249	EC_IMSI_BLACKLISTED
250	Personal service barring\|EC_DEST_ADDRESS_BLACKLISTED
251	Personal service barring\|EC_InvalidMscAddress
252	Personal service barring\|MESSAGE VALIDITY EXPIRED
253	Personal service barring\|the origination subscriber PPS authentication SCP connection broken'
254	Personal service barring\|any other error code other than 255
255	Personal service barring\|EC_UNKNOWN_ERROR
255	Personal service barring\|EC_UNKNOWN_ERROR
256	Personal service barring\|EC_SM_DF_memoryCapacityExceeded
257	Personal service barring\|EC_SM_DF_equipmentProtocolError
258	EC_SM_DF_equipmentNotSM_Equipped
259	EC_SM_DF_unknownServiceCentre
260	EC_SM_DF_sc_Congestion
260	'SMS not supported by MS'
261	EC_SM_DF_invalidSME_Address
262	EC_SM_DF_subscriberNotSC_Subscriber
263	MO Handover: Destination SME Barred
264	MO Handover: Duplicate Message Rejected
265	MO Handover: Validity Period Format Unsupported
266	MO Handover: Validity Period Unsupported
267	MO Handover: Not Supported by equipment
268	MO Handover: System Error
269	MO Handover: Duplicated invoke id
270	MO Handover: Service not supported
271	MO Handover: Mistyped parameter
272	MO Handover: No response from the peer
273	MO Handover: Resource limitation
274	MO Handover: Initiating release
275	Error Gateway
276	MO Handover: Unexpected error
277	MO Handover: Unexpected response from the peer
278	MO Handover: Unable to complete operation within timeout
279	MO Handover: Invalid response received
280	Error\|MO Handover: TCAP error
281	EC_UA_userSpecificReason
282	EC_UA_userResourceLimitation
283	EC_UA_resourceUnavailable
284	EC_UA_applicationProcedureCancellation
285	MO Handover: Unexpected Data Value
286	MO Handover: Telematic Interworking not Supported
287	MO Handover: FDA throttled
288	MO Handover: SM decoding problem
300	Invalid destination address\|Provider Error Duplicate Invoke ID
301	Invalid destination numbering plan\|Provider Error Service Not Supported
302	Invalid destination type of number\|Provider Error Mistyped Paramter
303	Invalid destination flag\|Provider Error Resource Limitation
304	Invalid number of destinations\|Provider Error Initiating Release
305	Provider Error Unexpected Response
306	Provider Error Service Completion Failure
307	EC_Provider No Response from Peer
308	Provider Error Invalid Response
400	EC_MAP_abort _error
401	Stack/Sig Error Map User specific Reason
402	Stack/Sig Error Map User Resource Limitation
403	Stack/Sig Error Map Resource Unavailable
404	Stack/Sig Error Map Application Procedure Cancellation
407	EC_HLR/MSC Timeout
409	Unknown Error
410	EC_Cancelled
411	EC_ValidityExpired
412	EC_NotSubmittedToSmppChannel
413	EC_DESTINATION_FLOODING
414	EC_DESTINATION_TXT_FLOODING
415	Stack/Sig Response Rejected By Peer
416	Stack/Sig Abnormal Event Recieved From Peer
417	Stack/Sig Cannot deliver Message
417	Sig Error Map Invalid Response from peer
418	Sig Error Map Dialogue Does not Exist
419	Sig Error Map Max evoke reached
420	Stack/Sig Invalid Origination Reference
420	Stack/Sig Invalid Origination Reference
421	Stack/Sig No Reson
421	Stack/Sig No Reson
422	Stack/Sig Remote Node Not Reachable
422	Stack/Sig Remote Node Not Reachable
423	Stack/Sig Map Potential Version Incompatibility
424	Stack/Sig Secured Transport Not Possible
424	Stack/Sig Secured Transport Not Possible
425	Stack/Sig Usr Transport Protection Not Adequate
425	Stack/Sig Usr Transport Protection Not Adequate
428	Sig Error MAP Subsystem congested
428	Sig Error MAP Subsystem congested
429	Sig Error MAP Subsystem failure
429	Sig Error MAP Subsystem failure
430	Sig Error MAP Error in local processing CCIT92
430	Sig Error MAP Error in local processing CCIT92
431	Sig Error MAP Re assembly failure
431	Sig Error MAP Re assembly failure
432	Sig Error MAP SCCP failure
432	Sig Error MAP SCCP failure
433	Sig Error MAP HOP counter violation ITU
433	Sig Error MAP HOP counter violation ITU
434	Sig Error MAP segmentation not supported
434	Sig Error MAP segmentation not supported
435	Sig Error MAP Segmentation failure
435	Sig Error MAP Segmentation failure
496	EC_invalidPduFurmat
497	EC_NotSubmittedToGMSC
500	EC_PROVIDER_GENERAL_ERROR
501	Insufficient Balance
502	EC_NO_RESPONSE
503	EC_SERVICE_COMPLETION_FAILURE
504	EC_UNEXPECTED_RESPONSE_FROM_PEER
507	EC_MISTYPED_PARAMETER
508	EC_NOT_SUPPORTED_SERVICE
509	EC_DUPLICATED_INVOKE_ID
510	Temp_Fail
511	SPAM_Fail
536	EC_PA_providerMalfunction
537	EC_PA_supportingDialogOrTransactionRealeased
538	EC_PA_ressourceLimitation
539	EC_PA_maintenanceActivity
540	EC_PA_versionIncompatibility
541	EC_PA_abnormalMapDialog
600	Internal Error
601	Timeout at SRI
602	Absent subscriber
703	Submit_SM_Timeout
715	Expired at BMG
715	Expired
792	EC_NC_abnormalEventDetectedByPeer
793	EC_NC_responseRejectedByPeer
794	EC_NC_abnormalEventReceivedFromPeer
795	EC_NC_messageCannotBeDeliveredToPeer
796	EC_NC_providerOutOfInvoke
801	EC_BLACKLISTED_MSISDN
1001	No Response from far Network
1024	EC_OR_appContextNotSupported
1025	EC_OR_invalidDestinationReference
1026	EC_OR_invalidOriginatingReference;
1027	EC_OR_encapsulatedAC_NotSupported
1028	EC_OR_transportProtectionNotAdequate
1029	EC_OR_noReasonGiven
1030	EC_OR_potentialVersionIncompatibility
1031	EC_OR_remoteNodeNotReachable
1152	EC_NNR_noTranslationForAnAddressOfSuchNatur
1153	EC_NNR_noTranslationForThisSpecificAddress
1154	EC_NNR_subsystemCongestion
1155	EC_NNR_subsystemFailure
1156	EC_NNR_unequippedUser
1157	EC_NNR_MTPfailure
1158	EC_NNR_networkCongestion
1159	EC_NNR_unqualified
1160	EC_NNR_errorInMessageTransportXUDT
1161	EC_NNR_errorInLocalProcessingXUDT
1162	EC_NNR_destinationCannotPerformReassemblyXUDT
1163	EC_NNR_SCCPfailure
1164	EC_NNR_hopCounterViolation
1165	EC_NNR_segmentationNotSupported
1166	EC_NNR_segmentationFailure
1281	EC_UA_userSpecificReason
1282	EC_UA_userResourceLimitation
1283	EC_UA_resourceUnavailable
1284	EC_UA_applicationProcedureCancellation
1536	EC_PA_providerMalfunction
1537	EC_PA_supportingDialogOrTransactionRealeased
1538	EC_PA_ressourceLimitation
1539	EC_PA_maintenanceActivity
1540	EC_PA_versionIncompatibility
1541	EC_PA_abnormalMapDialog
1793	EC_NC_responseRejectedByPeer
1794	EC_NC_abnormalEventReceivedFromPeer
1795	EC_NC_messageCannotBeDeliveredToPeer
1796	EC_NC_providerOutOfInvoke
2000	Make_Call API Failure
2001	Message too long
2002	Command length is invalid
2003	Command ID is invalid or not supported
2004	Incorrect bind status for given command
2005	Already bound
2006	Invalid Priority Flag
2007	Invalid registered delivery flag
2008	System error
2010	Invalid source address
2011	Invalid destination address
2012	Message ID is invalid
2013	Bind failed
2014	Invalid password
2015	Invalid System ID
2017	Cancelling message failed
2019	Message recplacement failed
2020	Message queue full
2021	Invalid service type
2022	Invalid services type
2048	EC_TIME_OUT
2049	EC_IMSI_BLACKLISTED
2050	EC_DEST_ADDRESS_BLACKLISTED
2051	EC_InvalidMscAddress
2052	EC_BLACKLISTED_DESTINATIONADDRESS
2064	Invalid destination flag
2066	Invalid submit with replace request
2067	Invalid esm class set
2068	Invalid submit to ditribution list
2069	Submitting message has failed
2072	Invalid source address type of number ( TON )
2073	Invalid source address numbering plan ( NPI )
2080	Invalid destination address type of number ( TON )
2081	Invalid destination address numbering plan ( NPI )
2083	Invalid system type
2084	Invalid replace_if_present flag
2085	Invalid number of messages
2088	Throttling error
2097	Invalid scheduled delivery time
2098	Invalid Validty Period value
2099	Predefined message not found
2100	ESME Receiver temporary error
2101	ESME Receiver permanent error
2102	ESME Receiver reject message error
2103	Message query request failed
2168	DND Block
2192	Error in the optional part of the PDU body
2193	TLV not allowed
2194	Invalid parameter length
2195	Expected TLV missing
2196	Invalid TLV value
2254	Transaction delivery failure
2255	Unknown error
2256	ESME not authorised to use specified servicetype
2257	ESME prohibited from using specified operation
2258	Specified servicetype is unavailable
2259	Specified servicetype is denied
2260	Invalid data coding scheme
2261	Invalid source address subunit
2262	Invalid destination address subunit
2300	Incorrect destination address
2301	Incorrect number of destination addresses
2302	Syntax error in user data parameter
2303	Incorrect bin/head/normal user data parameter combination
2304	Incorrect dcs parameter usage
2305	Incorrect validity period parameters usage
2306	Incorrect originator address usage
2307	Incorrect PID parameter usage
2308	Incorrect first delivery parameter usage
2309	Incorrect reply path usage
2310	Incorrect status report request parameter usage
2311	Incorrect cancel enabled parameter usage
2312	Incorrect priority parameter usage
2313	Incorrect tariff class parameter usage
2314	Incorrect service description parameter usage
2315	Incorrect transport type paramdeter usage
2316	Incorrect message type parameter usage
2318	Incorrect MMS parameter usage
2319	Incorrect operation timer parameter usage
2320	Incorrect dialogue ID parameter usage
2321	Incorrect alpha originator address usage
2322	Invalid data for alpha numeric originator
2323	Online closed user group rejection
2324	Licence exceeded
4000	DLT_SCRUBBING_TIMEOUT
4001	DLT_SCRUBBING_TIMEOUT
4096	EC_InvalidPduFormat
4097	EC_NotSubmittedToGMSC
4100	EC_Cancelled
4101	EC_ValidityExpired
4103	EC_DESTINATION_FLOODING
4104	EC_DESTINATION_TXT_FLOODING
4106	BLOCKED_BY_DLT
4107	DLT_SCRUBBING_TIMEOUT
4108	SENDER_BLOCKED_BY_DLT
5000	SCRUBBING_FAILED
5001	SCRUBBING_FAILED
5101	BLOCKED_BY_DLT
5102	BLOCKED_BY_DLT
5103	BLOCKED_BY_DLT
5104	BLOCKED_BY_DLT
5105	BLOCKED_BY_DLT
5106	BLOCKED_BY_DLT
5107	BLOCKED_BY_DLT
5108	BLOCKED_BY_DLT
5201	SENDER_BLOCKED_BY_DLT
5202	SENDER_BLOCKED_BY_DLT
5203	SENDER_MISMATCH_WITH_ENTITY
5204	SENDER_BLOCKED_BY_DLT
5205	Entity_ID_Not_Matched
5301	TEMPLATE_ERROR
5302	TEMPLATE_ERROR
5303	TEMPLATE_ERROR
5304	Content ID not in DB
5305	TEMPLATE_ERROR
5306	TEMPLATE_ERROR
5307	TEMPLATE_ERROR
5308	TEMPLATE_ERROR
5401	TEMPLATE_ERROR
5402	TEMPLATE_ERROR
5403	TEMPLATE_ERROR
5404	TEMPLATE_ERROR
5405	TEMPLATE_ERROR
5406	TEMPLATE_ERROR
5501	CONSENT_FAILED
5502	CONSENT_FAILED
5503	CONSENT_FAILED
7001	ENTITY_ID_ERROR
7002	ENTITY_ID_ERROR
7003	ENTITY_ID_ERROR
7004	ENTITY_ID_ERROR
20A	Bearer Service Not Supported
20b	Tele Service Not Provisioned
20c	Error Equipment
20d	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21b	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21f	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Reply from Subscriber
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40a	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error MAP guard timer expired
41B	Sig Error MAP SPCAUSE mask
41c	Sig Error MAP No translation Based Address
41d	Sig Error MAP No translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig DlG Invalid Destination Reference
42a	Sig Error MAP unequipped user
42b	Sig Error MAP network failure
42c	Sig Error MAP network congestion
42d	Sig Error MAP unqualified
42E	Sig Error MAP HOP Counter violation ANS92
42F	Sig Error MAP Error in message transport CCIT92
20A	Bearer Service Not Supported
20B	Tele Service Not Provisioned
20C	Error Equipment
20D	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21B	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21F	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Subscriber Reply
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40A	Stack/Sig Error Map Provider Malfunction
40A	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error Map guard Timer Expired
41B	Sig Error Map SPCAUSE mask
41C	Sig Error MAP No Translation Basd Address
41D	Sig Error MAP No Translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig Dlg Invalid Destination Reference
42A	Sig Error MAP Un Equipped User
42A	Sig Error MAP Un Equipped User
42B	Sig Error MAP Network Failure
42B	Sig Error MAP Network Failure
42C	Sig Error MAP Network Conjestion
42C	Sig Error MAP Network Conjestion
42D	Sig Error MAP un Qualified
42D	Sig Error MAP un Qualified
42E	Sig Error MAP HOP Counter violaion ANS92
42E	Sig Error MAP HOP Counter violaion ANS92
42F	Sig Error MAP Error in message transport CCIT92
42F	Sig Error MAP Error in message transport CCIT92

Sending a Unicode SMS

To send a unicode SMS using the HTTP API, the following URL format is used:

https://www.mysmsapp.in/api/push.json?apikey=<apikey>&sender=<senderid>&mobileno=<mob>&text=<text>

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
delivery reports URL	dlrurl	The URL to receive delivery reports. Spiffing custom is mandatory.	delivery reports URL
Message ID	custom	Custom message ID by customer, comma separated	Alphanumeric (max 40 char)
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM
unicode	unicode	To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.	1 / 0 / auto
flash	flash	To specify that the message is to be sent in the flash format	1 or 0

Advanced Parameters(Optional)

The advanced parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
Callback function name	callback	Callback function for JSONP response format.	String
Custom reference fields	custom1 & custom2	Custom reference fields	Alphanumeric (max 40 char)
port number	port	Port number to which SMS has to be sent	Valid integer port number above 2000

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

ErrorCode	Description
0	NORMAL DELIVERED
1	Source not found\|EC_UNKNOWN_SUBSCRIBER
2	Sink not found\|EC_UNKNOWN_BASE_STATION
3	Delivery zone not found\|DND Fail
5	Location not found\|EC_UNIDENTIFIED_SUBSCRIBER
6	Location blocked\|Absent subscriber
7	Reply path not found\|UNKNOWN EQUIPMENT
8	Message not submit\|FSM TIMEOUT
9	Unsupported number plan\|EC_ILLEGAL_SUBSCRIBER
10	Unsupported type of number\|EC_BEARER_SERVICE_NOT_PROVISIONED
11	Message not DELIVER or STATUS\|EC_TELESERVICE_NOT_PROVISIONED
12	Dialling zone not found\|EC_ILLEGAL_EQUIPMENT
13	Not home zone and IMSI not allowed\|EC_CALL_BARRED
14	Not home zone and IMSI fetch failed\|Barred unauthorized message originator
15	Screening block\|CUG REJECT
18	ESME error\|message waiting for report expired'
19	Originating location mismatch\|SRIAck unsuccessful with any other error codes'
20	Originating reservation failed\|EC_SS_INCOMPATIBILITY
21	Originating reservation denied subscription not found\|EC_FACILITY_NOT_SUPPORTED
22	Originating reservation denied subscription state illegal\|Memory capacity exceeded
23	Originating reservation denied call case blocked for subscription\|Unknown Subscriber'
24	Originating reservation denied call case blocked for subscription type\|call forbidden'
25	Originating reservation denied low balance\|the network does not support SMS'
26	'teleservice not supported'
27	Absent subscriber
29	'HLR:data error in route signal'
30	Terminating reservation failed\|HLR:data lacked'
31	Terminating reservation denied subscription not found\|EC_SUBSCRIBER_BUSY_FOR_MT_SMS
32	Terminating reservation denied subscription state illegal\|EC_SM_DELIVERY_FAILURE
33	Terminating reservation denied call case blocked for subscription\|EC_MESSAGE_WAITING_LIST_FULL
34	Terminating reservation denied call case blocked for subscription type\|EC_SYSTEM_FAILURE
35	Terminating reservation denied low balance\|EC_DATA_MISSING
36	EC_UNEXPECTED_DATA_VALUE
37	'Unmarked Subscriber'
38	'failure because the subscriber is busy'
39	'VMSC isolated'
40	System is congested\|VMSC:data lacked'
41	Originating IMSI mismatch\|VMSC:unexpected data'
42	'MS error'
43	Not Supported by equipment
44	Illegal equipment
45	Quarantine Add\|Unspecific PID Error
46	Quarantine Remove\|Message Class Not Supported
47	DCS error
48	TPDU Not Supported
49	Short message delivery failure with memory capacity exceeded
50	Unexpected error from Store\|UNKNOWN ERROR
51	Direct delivery disabled from store\|EC_RESOURCE_LIMITATION
53	Message limit exceeded\|Subscriber Busy For MT-SMS
54	Retry scheme ended\|Data Download Error
60	Originator blocked\|Absent subscriber
61	Destination blocked\|Absent subscriber
62	Keyword blocked\|Absent subscriber
63	SC address blocked\|Absent subscriber
64	Blocked due to exceeded quota\|Absent subscriber
65	Loop detected\|Absent subscriber
66	Data coding scheme blocked\|Absent subscriber over GPRS Page Fail
67	Information element identifier blocked\|Absent subscriber over GPRS Detached
68	Country Code Validation Block\|Absent subscriber over GPRS Deregistered
69	Destination Flooding
70	No ESME provider available\|MS store is full'
71	ESME account not connected\|EC_UNKNOWN_ALPHABET
72	No ESME sub account routing\|EC_USSD_BUSY
74	ESME local throttling - exceeded msg/s\|INVALID HEADER IN MSG
80	Home routing sender GT mismatch\|PENDING DLR (Retry )
81	Location mismatch between provided location and location known to HLR.\|Service not supported
82	IMSI mismatch between provided IMSI \|Mistyped parameter
83	Local throttling by sink\|No response from the peer
84	The IMSI could not be retrieved from the HSS\|Resource limitation
85	The IMEI of the UE is unknown\|Initiating release
86	The user location is unknown\|Unrecognised error
87	ESME router\|Provider Error (In case of any failures observed in TCAP level this error will generate).
88	Network fluctuation from far End Operator(Temporary Error)
89	INVALID PACKET AT SMSC LEVEL
90	USER-ABORT
91	PROVIDER-ABORT
92	MSC NUMBER MISSING
93	Equipment protocol error
94	Equipment not SM equipped
95	Unknown service centre
96	Service Centre congestion
97	INVALID SCHEDULE DELIVERY TIME
98	Subscriber not SC subscriber
99	Invalid SME address
100	Unidentified subscriber\|no response from the called subscriber'
101	Facility not supported\|VMSC:the called MS poweroff'
102	System failure\|VMSC:limited due to MS roaming' / SENDER ID BLOCKED
103	Unexpected data value\|ROUTE NOT ACTIVE
104	Data missing\|OFF-NET NOT ACTIVE FOR ACCOUNT/ ON-NET ROUTES NOT DEFINED
105	Equipment protocol error\|MTP_FAILURE
106	UNKNOWN service centre address\|MS response is overtime'
107	Service centre congestion\|HLR:the subscriber is unregistered'
108	Invalid short message entity address\|ROUTE BLOCKED FOR THIS SERIES
109	Subscriber not service centre subscriber\|MSISDN SERIES NOT CONFIGURED
110	Reject\|NOT ABLE TO GET FINAL ROUTE
111	Local cancel\|Queue_Unvailable
112	Abort\|NOT A VALID TEMPLATE
113	Exception\|MANDATORY WORDS NOT FOUND
114	UNKNOWN\|DEFAULT ROUTE NOT FOUND IN CONFIGURED ROUTES
115	ROUTE NOT CONFIGURED AT PLATFORM LEVEL
116	Map Dialog P Abort Indication Provider Reason: Maintenance Activity
117	Map Dialog P Abort Indication Provider Reason: Version Incompatibility
118	Map Dialog P Abort Indication Provider Reason: Abnormal Dialogue
119	MAP_DLGUA_UsrRsn_NTR_MapDlgUnavailable
120	MAP_DLGUA_UsrRsn_NTR_MapNotConfigured
121	MAP_DLGUA_UsrRsn_NTR_OtherErr
122	MAP_DLGRJT_PrvRsn_NotSent
123	INTERNATIONAL ROAMING
124	EC_OR_appContextNotSupported
125	EC_OR_invalidDestinationReference
126	EC_OR_invalidOriginatingReference
127	EC_OR_encapsulatedAC_NotSupported
128	EC_OR_transportProtectionNotAdequate
129	EC_OR_noReasonGiven
130	EC_OR_potentialVersionIncompatibility
131	EC_OR_remoteNodeNotReachable
132	Map Dialog Rejected Refuse Reason: Application Context not supported
133	Map Dialog Rejected Refuse Reason: Potential Version Incompatibility
134	Map Dialog Rejected Refuse Reason: Remote Node not reachable
135	Map Dialog Rejected Provider Reason: Provider malfunction
136	Map Dialog Rejected Provider Reason: Transaction Released
137	Map Dialog Rejected Provider Reason: Resource Limitation
138	Map Dialog Rejected Provider Reason: Maintenance Activity
139	Map Dialog Rejected Provider Reason: Version Incompatibility
140	Map Dialog Rejected Provider Reason: Abnormal Dialogue
141	Map Dialog User Abort Diagnostic Info: Short Term resource Limitation
142	Map Dialog User Abort Diagnostic Info: Long term resource limitation
143	Map Dialog User Abort Diagnostic Info: Handover cancellation
144	Map Dialog User Abort Diagnostic Info: Radio Channel Release
145	Map Dialog User Abort Diagnostic Info: Call Release
146	Map Dialog User Abort Diagnostic Info: Network path Release
147	Map Dialog User Abort Diagnostic Info: Associated Procedure release
148	Map Dialog User Abort Diagnostic Info: Tandem Dialog Release
149	Map Dialog User Abort Diagnostic Info: Remote Operation Failure
150	UNKNOWN subscriber\|Map Dialog User Abort User Reason: User specific reason
151	Call barred\|Map Dialog User Abort User Reason: User resource limitation
152	Teleservice not provisioned\|EC_NNR_noTranslationForAnAddressOfSuchNature
153	Absent subscriber\|EC_NNR_noTranslationForThisSpecificAddress
154	Facility not supported\|EC_NNR_subsystemCongestion
155	System failure\|EC_NNR_subsystemFailure
156	Unexpected data value\|EC_NNR_unequippedUser
157	Data missing\|EC_NNR_MTPfailure
158	Memory capacity exceeded\|EC_NNR_networkCongestion
159	Mobile subscriber not reachable\|EC_NNR_unqualified
160	Reject\|EC_NNR_errorInMessageTransportXUDT
161	Local cancel\|EC_NNR_errorInLocalProcessingXUDT
162	Abort\|EC_NNR_destinationCannotPerformReassemblyXUDT
163	Exception\|EC_NNR_SCCPfailure
164	UNKNOWN\|EC_NNR_hopCounterViolation
165	EC_NNR_segmentationNotSupported
166	EC_NNR_segmentationFailure
167	USSD platform Unknown error
168	DND Blocked
169	MAP-P-Abort: Provider reasons
170	MAP-P-Abort Provider reason: Malfunction
171	MAP-P-Abort Provider reason: Dialog Released
172	'waiting queue in destination subscriber table is full'
173	MAP-P-Abort Provider reason: Abnormal Dialog
174	MAP-P-Abort: Invalid PDU
175	MAP-Open: Out of MAP dialogs
176	Invalid Service code
177	Subscriber MSISDN Blacklisted
178	Subscriber IMSI Blacklisted
179	Invalid Originating Address with Length greater than 20 chars
180	MAP-Open Refuse reason: Node Not Reached
181	'service barred'
182	'operation barred'
183	VLRBlackListed
184	VLRWhiteListed
185	MAP-Notice Problem: Message Cannot Be Delivered
186	BILNG_SystemError
187	MAP-Notice: Abnormal event detected by peer
188	MAP-U-Abort: Error
189	MAP-U-Abort User Reason: User Specific Reason
190	MAP-U-Abort: User resource limitation
191	MAP-U-Abort: Resource unavailable (short term)
192	Unexpected session release from Servers/3rd party APP
193	'unknServCent'
194	'sc_Congestion'
195	'invaSME_Add'
196	'subsNotSC_Subsc'
197	Application Specific Error from Client
198	MAP-U-Abort: Application procedure cancellation (tandem dialogue released)
199	MAP-U-Abort: Application procedure cancellation (remote operations failure)
200	Unidentified subscriber\|OPERATOR BLOCKED FOR ACCOUNT
201	Absent subscriber IMSI detached\|EC_unknown Subscriber
202	Absent subscriber no page response\|Unknown Base Station
203	Subscriber busy for MT-SMS\|Unknown MSC
205	Illegal subscriber\|EC_Unidentified Subscriber
206	Illegal equipment\|Absent Subscriber for SM
206	Illegal equipment\|Absent Subscriber for SM
207	System failure\|Unknown Equipment
208	Unexpected data value\|Roaming Not Allowed
209	Data missing\|Illegal Subscriber
210	Memory capacity exceeded\|Illegal SS Operation
211	Equipment protocol error\|SS Error Status
212	Equipment not short message equipped\|SS Not Available
213	Reject\|SS Subscription Violation
214	Local cancel\|SS Incompatible
215	Abort\|HLR:limited due to MS roaming'
216	Exception\|Internal IPC memory allocation Failure
217	UNKNOWN\|Internal IPC Router Failure
218	'HLR:illegal subscriber'
219	'HLR:subscriber absent'
220	'HLR:the called MS poweroff'
221	MSISDN BLOCKED
221	Message List Full
222	MESSAGE CONTENT IS BLACKLISTED/EC_Network System Failure
223	Data Missing
224	Unexpected Data
225	MESSAGE CONTENT IS BLACKLISTED AT OPERATOR/ 'HLR:no response'
226	'VMSC:no response'
227	IN Subscriber not exist1
228	'the destination subscriber PPS authentication overtime'
229	'IN Invalid subscriber'
230	Not Allowed
231	ATI Not Allowed
232	No Group Call Number Available
233	Resource Limitation
234	Unauthorized Requesting Network
235	Unathorized LCS Client
236	Position Method Failure
237	Custom error 8
238	Custom error 9
239	Custom error 10
240	Recipient Temporary Error
241	Recipient Permanent Error
242	Service Not configured/for a particular circle/subscriber. Or simply menu is incomplete or service i
243	Terminating session due to invalid input
244	Unspecific
245	'HLR:the remote address not reachable' /'VMSC:Invalid Destination'
246	Client Resource Not Available
247	Unknown Alphabet
248	EC_TIME_OUT
249	EC_IMSI_BLACKLISTED
250	Personal service barring\|EC_DEST_ADDRESS_BLACKLISTED
251	Personal service barring\|EC_InvalidMscAddress
252	Personal service barring\|MESSAGE VALIDITY EXPIRED
253	Personal service barring\|the origination subscriber PPS authentication SCP connection broken'
254	Personal service barring\|any other error code other than 255
255	Personal service barring\|EC_UNKNOWN_ERROR
255	Personal service barring\|EC_UNKNOWN_ERROR
256	Personal service barring\|EC_SM_DF_memoryCapacityExceeded
257	Personal service barring\|EC_SM_DF_equipmentProtocolError
258	EC_SM_DF_equipmentNotSM_Equipped
259	EC_SM_DF_unknownServiceCentre
260	EC_SM_DF_sc_Congestion
260	'SMS not supported by MS'
261	EC_SM_DF_invalidSME_Address
262	EC_SM_DF_subscriberNotSC_Subscriber
263	MO Handover: Destination SME Barred
264	MO Handover: Duplicate Message Rejected
265	MO Handover: Validity Period Format Unsupported
266	MO Handover: Validity Period Unsupported
267	MO Handover: Not Supported by equipment
268	MO Handover: System Error
269	MO Handover: Duplicated invoke id
270	MO Handover: Service not supported
271	MO Handover: Mistyped parameter
272	MO Handover: No response from the peer
273	MO Handover: Resource limitation
274	MO Handover: Initiating release
275	Error Gateway
276	MO Handover: Unexpected error
277	MO Handover: Unexpected response from the peer
278	MO Handover: Unable to complete operation within timeout
279	MO Handover: Invalid response received
280	Error\|MO Handover: TCAP error
281	EC_UA_userSpecificReason
282	EC_UA_userResourceLimitation
283	EC_UA_resourceUnavailable
284	EC_UA_applicationProcedureCancellation
285	MO Handover: Unexpected Data Value
286	MO Handover: Telematic Interworking not Supported
287	MO Handover: FDA throttled
288	MO Handover: SM decoding problem
300	Invalid destination address\|Provider Error Duplicate Invoke ID
301	Invalid destination numbering plan\|Provider Error Service Not Supported
302	Invalid destination type of number\|Provider Error Mistyped Paramter
303	Invalid destination flag\|Provider Error Resource Limitation
304	Invalid number of destinations\|Provider Error Initiating Release
305	Provider Error Unexpected Response
306	Provider Error Service Completion Failure
307	EC_Provider No Response from Peer
308	Provider Error Invalid Response
400	EC_MAP_abort _error
401	Stack/Sig Error Map User specific Reason
402	Stack/Sig Error Map User Resource Limitation
403	Stack/Sig Error Map Resource Unavailable
404	Stack/Sig Error Map Application Procedure Cancellation
407	EC_HLR/MSC Timeout
409	Unknown Error
410	EC_Cancelled
411	EC_ValidityExpired
412	EC_NotSubmittedToSmppChannel
413	EC_DESTINATION_FLOODING
414	EC_DESTINATION_TXT_FLOODING
415	Stack/Sig Response Rejected By Peer
416	Stack/Sig Abnormal Event Recieved From Peer
417	Stack/Sig Cannot deliver Message
417	Sig Error Map Invalid Response from peer
418	Sig Error Map Dialogue Does not Exist
419	Sig Error Map Max evoke reached
420	Stack/Sig Invalid Origination Reference
420	Stack/Sig Invalid Origination Reference
421	Stack/Sig No Reson
421	Stack/Sig No Reson
422	Stack/Sig Remote Node Not Reachable
422	Stack/Sig Remote Node Not Reachable
423	Stack/Sig Map Potential Version Incompatibility
424	Stack/Sig Secured Transport Not Possible
424	Stack/Sig Secured Transport Not Possible
425	Stack/Sig Usr Transport Protection Not Adequate
425	Stack/Sig Usr Transport Protection Not Adequate
428	Sig Error MAP Subsystem congested
428	Sig Error MAP Subsystem congested
429	Sig Error MAP Subsystem failure
429	Sig Error MAP Subsystem failure
430	Sig Error MAP Error in local processing CCIT92
430	Sig Error MAP Error in local processing CCIT92
431	Sig Error MAP Re assembly failure
431	Sig Error MAP Re assembly failure
432	Sig Error MAP SCCP failure
432	Sig Error MAP SCCP failure
433	Sig Error MAP HOP counter violation ITU
433	Sig Error MAP HOP counter violation ITU
434	Sig Error MAP segmentation not supported
434	Sig Error MAP segmentation not supported
435	Sig Error MAP Segmentation failure
435	Sig Error MAP Segmentation failure
496	EC_invalidPduFurmat
497	EC_NotSubmittedToGMSC
500	EC_PROVIDER_GENERAL_ERROR
501	Insufficient Balance
502	EC_NO_RESPONSE
503	EC_SERVICE_COMPLETION_FAILURE
504	EC_UNEXPECTED_RESPONSE_FROM_PEER
507	EC_MISTYPED_PARAMETER
508	EC_NOT_SUPPORTED_SERVICE
509	EC_DUPLICATED_INVOKE_ID
510	Temp_Fail
511	SPAM_Fail
536	EC_PA_providerMalfunction
537	EC_PA_supportingDialogOrTransactionRealeased
538	EC_PA_ressourceLimitation
539	EC_PA_maintenanceActivity
540	EC_PA_versionIncompatibility
541	EC_PA_abnormalMapDialog
600	Internal Error
601	Timeout at SRI
602	Absent subscriber
703	Submit_SM_Timeout
715	Expired at BMG
715	Expired
792	EC_NC_abnormalEventDetectedByPeer
793	EC_NC_responseRejectedByPeer
794	EC_NC_abnormalEventReceivedFromPeer
795	EC_NC_messageCannotBeDeliveredToPeer
796	EC_NC_providerOutOfInvoke
801	EC_BLACKLISTED_MSISDN
1001	No Response from far Network
1024	EC_OR_appContextNotSupported
1025	EC_OR_invalidDestinationReference
1026	EC_OR_invalidOriginatingReference;
1027	EC_OR_encapsulatedAC_NotSupported
1028	EC_OR_transportProtectionNotAdequate
1029	EC_OR_noReasonGiven
1030	EC_OR_potentialVersionIncompatibility
1031	EC_OR_remoteNodeNotReachable
1152	EC_NNR_noTranslationForAnAddressOfSuchNatur
1153	EC_NNR_noTranslationForThisSpecificAddress
1154	EC_NNR_subsystemCongestion
1155	EC_NNR_subsystemFailure
1156	EC_NNR_unequippedUser
1157	EC_NNR_MTPfailure
1158	EC_NNR_networkCongestion
1159	EC_NNR_unqualified
1160	EC_NNR_errorInMessageTransportXUDT
1161	EC_NNR_errorInLocalProcessingXUDT
1162	EC_NNR_destinationCannotPerformReassemblyXUDT
1163	EC_NNR_SCCPfailure
1164	EC_NNR_hopCounterViolation
1165	EC_NNR_segmentationNotSupported
1166	EC_NNR_segmentationFailure
1281	EC_UA_userSpecificReason
1282	EC_UA_userResourceLimitation
1283	EC_UA_resourceUnavailable
1284	EC_UA_applicationProcedureCancellation
1536	EC_PA_providerMalfunction
1537	EC_PA_supportingDialogOrTransactionRealeased
1538	EC_PA_ressourceLimitation
1539	EC_PA_maintenanceActivity
1540	EC_PA_versionIncompatibility
1541	EC_PA_abnormalMapDialog
1793	EC_NC_responseRejectedByPeer
1794	EC_NC_abnormalEventReceivedFromPeer
1795	EC_NC_messageCannotBeDeliveredToPeer
1796	EC_NC_providerOutOfInvoke
2000	Make_Call API Failure
2001	Message too long
2002	Command length is invalid
2003	Command ID is invalid or not supported
2004	Incorrect bind status for given command
2005	Already bound
2006	Invalid Priority Flag
2007	Invalid registered delivery flag
2008	System error
2010	Invalid source address
2011	Invalid destination address
2012	Message ID is invalid
2013	Bind failed
2014	Invalid password
2015	Invalid System ID
2017	Cancelling message failed
2019	Message recplacement failed
2020	Message queue full
2021	Invalid service type
2022	Invalid services type
2048	EC_TIME_OUT
2049	EC_IMSI_BLACKLISTED
2050	EC_DEST_ADDRESS_BLACKLISTED
2051	EC_InvalidMscAddress
2052	EC_BLACKLISTED_DESTINATIONADDRESS
2064	Invalid destination flag
2066	Invalid submit with replace request
2067	Invalid esm class set
2068	Invalid submit to ditribution list
2069	Submitting message has failed
2072	Invalid source address type of number ( TON )
2073	Invalid source address numbering plan ( NPI )
2080	Invalid destination address type of number ( TON )
2081	Invalid destination address numbering plan ( NPI )
2083	Invalid system type
2084	Invalid replace_if_present flag
2085	Invalid number of messages
2088	Throttling error
2097	Invalid scheduled delivery time
2098	Invalid Validty Period value
2099	Predefined message not found
2100	ESME Receiver temporary error
2101	ESME Receiver permanent error
2102	ESME Receiver reject message error
2103	Message query request failed
2168	DND Block
2192	Error in the optional part of the PDU body
2193	TLV not allowed
2194	Invalid parameter length
2195	Expected TLV missing
2196	Invalid TLV value
2254	Transaction delivery failure
2255	Unknown error
2256	ESME not authorised to use specified servicetype
2257	ESME prohibited from using specified operation
2258	Specified servicetype is unavailable
2259	Specified servicetype is denied
2260	Invalid data coding scheme
2261	Invalid source address subunit
2262	Invalid destination address subunit
2300	Incorrect destination address
2301	Incorrect number of destination addresses
2302	Syntax error in user data parameter
2303	Incorrect bin/head/normal user data parameter combination
2304	Incorrect dcs parameter usage
2305	Incorrect validity period parameters usage
2306	Incorrect originator address usage
2307	Incorrect PID parameter usage
2308	Incorrect first delivery parameter usage
2309	Incorrect reply path usage
2310	Incorrect status report request parameter usage
2311	Incorrect cancel enabled parameter usage
2312	Incorrect priority parameter usage
2313	Incorrect tariff class parameter usage
2314	Incorrect service description parameter usage
2315	Incorrect transport type paramdeter usage
2316	Incorrect message type parameter usage
2318	Incorrect MMS parameter usage
2319	Incorrect operation timer parameter usage
2320	Incorrect dialogue ID parameter usage
2321	Incorrect alpha originator address usage
2322	Invalid data for alpha numeric originator
2323	Online closed user group rejection
2324	Licence exceeded
4000	DLT_SCRUBBING_TIMEOUT
4001	DLT_SCRUBBING_TIMEOUT
4096	EC_InvalidPduFormat
4097	EC_NotSubmittedToGMSC
4100	EC_Cancelled
4101	EC_ValidityExpired
4103	EC_DESTINATION_FLOODING
4104	EC_DESTINATION_TXT_FLOODING
4106	BLOCKED_BY_DLT
4107	DLT_SCRUBBING_TIMEOUT
4108	SENDER_BLOCKED_BY_DLT
5000	SCRUBBING_FAILED
5001	SCRUBBING_FAILED
5101	BLOCKED_BY_DLT
5102	BLOCKED_BY_DLT
5103	BLOCKED_BY_DLT
5104	BLOCKED_BY_DLT
5105	BLOCKED_BY_DLT
5106	BLOCKED_BY_DLT
5107	BLOCKED_BY_DLT
5108	BLOCKED_BY_DLT
5201	SENDER_BLOCKED_BY_DLT
5202	SENDER_BLOCKED_BY_DLT
5203	SENDER_MISMATCH_WITH_ENTITY
5204	SENDER_BLOCKED_BY_DLT
5205	Entity_ID_Not_Matched
5301	TEMPLATE_ERROR
5302	TEMPLATE_ERROR
5303	TEMPLATE_ERROR
5304	Content ID not in DB
5305	TEMPLATE_ERROR
5306	TEMPLATE_ERROR
5307	TEMPLATE_ERROR
5308	TEMPLATE_ERROR
5401	TEMPLATE_ERROR
5402	TEMPLATE_ERROR
5403	TEMPLATE_ERROR
5404	TEMPLATE_ERROR
5405	TEMPLATE_ERROR
5406	TEMPLATE_ERROR
5501	CONSENT_FAILED
5502	CONSENT_FAILED
5503	CONSENT_FAILED
7001	ENTITY_ID_ERROR
7002	ENTITY_ID_ERROR
7003	ENTITY_ID_ERROR
7004	ENTITY_ID_ERROR
20A	Bearer Service Not Supported
20b	Tele Service Not Provisioned
20c	Error Equipment
20d	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21b	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21f	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Reply from Subscriber
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40a	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error MAP guard timer expired
41B	Sig Error MAP SPCAUSE mask
41c	Sig Error MAP No translation Based Address
41d	Sig Error MAP No translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig DlG Invalid Destination Reference
42a	Sig Error MAP unequipped user
42b	Sig Error MAP network failure
42c	Sig Error MAP network congestion
42d	Sig Error MAP unqualified
42E	Sig Error MAP HOP Counter violation ANS92
42F	Sig Error MAP Error in message transport CCIT92
20A	Bearer Service Not Supported
20B	Tele Service Not Provisioned
20C	Error Equipment
20D	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21B	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21F	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Subscriber Reply
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40A	Stack/Sig Error Map Provider Malfunction
40A	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error Map guard Timer Expired
41B	Sig Error Map SPCAUSE mask
41C	Sig Error MAP No Translation Basd Address
41D	Sig Error MAP No Translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig Dlg Invalid Destination Reference
42A	Sig Error MAP Un Equipped User
42A	Sig Error MAP Un Equipped User
42B	Sig Error MAP Network Failure
42B	Sig Error MAP Network Failure
42C	Sig Error MAP Network Conjestion
42C	Sig Error MAP Network Conjestion
42D	Sig Error MAP un Qualified
42D	Sig Error MAP un Qualified
42E	Sig Error MAP HOP Counter violaion ANS92
42E	Sig Error MAP HOP Counter violaion ANS92
42F	Sig Error MAP Error in message transport CCIT92
42F	Sig Error MAP Error in message transport CCIT92

Scheduling SMS

To schedule an SMS using the HTTP API, the following URL format is used:

https://www.mysmsapp.in/api/push.json?apikey=<apikey>&sender=<senderid>&mobileno=<mob>&text=<text>&schedule=<schedule>

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM

Advanced Parameters(Optional)

The advanced parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
Callback function name	callback	Callback function for JSONP response format.	String
Custom reference fields	custom1 & custom2	Custom reference fields	Alphanumeric (max 40 char)
port number	port	Port number to which SMS has to be sent	Valid integer port number above 2000

Example Response

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

ErrorCode	Description
0	NORMAL DELIVERED
1	Source not found\|EC_UNKNOWN_SUBSCRIBER
2	Sink not found\|EC_UNKNOWN_BASE_STATION
3	Delivery zone not found\|DND Fail
5	Location not found\|EC_UNIDENTIFIED_SUBSCRIBER
6	Location blocked\|Absent subscriber
7	Reply path not found\|UNKNOWN EQUIPMENT
8	Message not submit\|FSM TIMEOUT
9	Unsupported number plan\|EC_ILLEGAL_SUBSCRIBER
10	Unsupported type of number\|EC_BEARER_SERVICE_NOT_PROVISIONED
11	Message not DELIVER or STATUS\|EC_TELESERVICE_NOT_PROVISIONED
12	Dialling zone not found\|EC_ILLEGAL_EQUIPMENT
13	Not home zone and IMSI not allowed\|EC_CALL_BARRED
14	Not home zone and IMSI fetch failed\|Barred unauthorized message originator
15	Screening block\|CUG REJECT
18	ESME error\|message waiting for report expired'
19	Originating location mismatch\|SRIAck unsuccessful with any other error codes'
20	Originating reservation failed\|EC_SS_INCOMPATIBILITY
21	Originating reservation denied subscription not found\|EC_FACILITY_NOT_SUPPORTED
22	Originating reservation denied subscription state illegal\|Memory capacity exceeded
23	Originating reservation denied call case blocked for subscription\|Unknown Subscriber'
24	Originating reservation denied call case blocked for subscription type\|call forbidden'
25	Originating reservation denied low balance\|the network does not support SMS'
26	'teleservice not supported'
27	Absent subscriber
29	'HLR:data error in route signal'
30	Terminating reservation failed\|HLR:data lacked'
31	Terminating reservation denied subscription not found\|EC_SUBSCRIBER_BUSY_FOR_MT_SMS
32	Terminating reservation denied subscription state illegal\|EC_SM_DELIVERY_FAILURE
33	Terminating reservation denied call case blocked for subscription\|EC_MESSAGE_WAITING_LIST_FULL
34	Terminating reservation denied call case blocked for subscription type\|EC_SYSTEM_FAILURE
35	Terminating reservation denied low balance\|EC_DATA_MISSING
36	EC_UNEXPECTED_DATA_VALUE
37	'Unmarked Subscriber'
38	'failure because the subscriber is busy'
39	'VMSC isolated'
40	System is congested\|VMSC:data lacked'
41	Originating IMSI mismatch\|VMSC:unexpected data'
42	'MS error'
43	Not Supported by equipment
44	Illegal equipment
45	Quarantine Add\|Unspecific PID Error
46	Quarantine Remove\|Message Class Not Supported
47	DCS error
48	TPDU Not Supported
49	Short message delivery failure with memory capacity exceeded
50	Unexpected error from Store\|UNKNOWN ERROR
51	Direct delivery disabled from store\|EC_RESOURCE_LIMITATION
53	Message limit exceeded\|Subscriber Busy For MT-SMS
54	Retry scheme ended\|Data Download Error
60	Originator blocked\|Absent subscriber
61	Destination blocked\|Absent subscriber
62	Keyword blocked\|Absent subscriber
63	SC address blocked\|Absent subscriber
64	Blocked due to exceeded quota\|Absent subscriber
65	Loop detected\|Absent subscriber
66	Data coding scheme blocked\|Absent subscriber over GPRS Page Fail
67	Information element identifier blocked\|Absent subscriber over GPRS Detached
68	Country Code Validation Block\|Absent subscriber over GPRS Deregistered
69	Destination Flooding
70	No ESME provider available\|MS store is full'
71	ESME account not connected\|EC_UNKNOWN_ALPHABET
72	No ESME sub account routing\|EC_USSD_BUSY
74	ESME local throttling - exceeded msg/s\|INVALID HEADER IN MSG
80	Home routing sender GT mismatch\|PENDING DLR (Retry )
81	Location mismatch between provided location and location known to HLR.\|Service not supported
82	IMSI mismatch between provided IMSI \|Mistyped parameter
83	Local throttling by sink\|No response from the peer
84	The IMSI could not be retrieved from the HSS\|Resource limitation
85	The IMEI of the UE is unknown\|Initiating release
86	The user location is unknown\|Unrecognised error
87	ESME router\|Provider Error (In case of any failures observed in TCAP level this error will generate).
88	Network fluctuation from far End Operator(Temporary Error)
89	INVALID PACKET AT SMSC LEVEL
90	USER-ABORT
91	PROVIDER-ABORT
92	MSC NUMBER MISSING
93	Equipment protocol error
94	Equipment not SM equipped
95	Unknown service centre
96	Service Centre congestion
97	INVALID SCHEDULE DELIVERY TIME
98	Subscriber not SC subscriber
99	Invalid SME address
100	Unidentified subscriber\|no response from the called subscriber'
101	Facility not supported\|VMSC:the called MS poweroff'
102	System failure\|VMSC:limited due to MS roaming' / SENDER ID BLOCKED
103	Unexpected data value\|ROUTE NOT ACTIVE
104	Data missing\|OFF-NET NOT ACTIVE FOR ACCOUNT/ ON-NET ROUTES NOT DEFINED
105	Equipment protocol error\|MTP_FAILURE
106	UNKNOWN service centre address\|MS response is overtime'
107	Service centre congestion\|HLR:the subscriber is unregistered'
108	Invalid short message entity address\|ROUTE BLOCKED FOR THIS SERIES
109	Subscriber not service centre subscriber\|MSISDN SERIES NOT CONFIGURED
110	Reject\|NOT ABLE TO GET FINAL ROUTE
111	Local cancel\|Queue_Unvailable
112	Abort\|NOT A VALID TEMPLATE
113	Exception\|MANDATORY WORDS NOT FOUND
114	UNKNOWN\|DEFAULT ROUTE NOT FOUND IN CONFIGURED ROUTES
115	ROUTE NOT CONFIGURED AT PLATFORM LEVEL
116	Map Dialog P Abort Indication Provider Reason: Maintenance Activity
117	Map Dialog P Abort Indication Provider Reason: Version Incompatibility
118	Map Dialog P Abort Indication Provider Reason: Abnormal Dialogue
119	MAP_DLGUA_UsrRsn_NTR_MapDlgUnavailable
120	MAP_DLGUA_UsrRsn_NTR_MapNotConfigured
121	MAP_DLGUA_UsrRsn_NTR_OtherErr
122	MAP_DLGRJT_PrvRsn_NotSent
123	INTERNATIONAL ROAMING
124	EC_OR_appContextNotSupported
125	EC_OR_invalidDestinationReference
126	EC_OR_invalidOriginatingReference
127	EC_OR_encapsulatedAC_NotSupported
128	EC_OR_transportProtectionNotAdequate
129	EC_OR_noReasonGiven
130	EC_OR_potentialVersionIncompatibility
131	EC_OR_remoteNodeNotReachable
132	Map Dialog Rejected Refuse Reason: Application Context not supported
133	Map Dialog Rejected Refuse Reason: Potential Version Incompatibility
134	Map Dialog Rejected Refuse Reason: Remote Node not reachable
135	Map Dialog Rejected Provider Reason: Provider malfunction
136	Map Dialog Rejected Provider Reason: Transaction Released
137	Map Dialog Rejected Provider Reason: Resource Limitation
138	Map Dialog Rejected Provider Reason: Maintenance Activity
139	Map Dialog Rejected Provider Reason: Version Incompatibility
140	Map Dialog Rejected Provider Reason: Abnormal Dialogue
141	Map Dialog User Abort Diagnostic Info: Short Term resource Limitation
142	Map Dialog User Abort Diagnostic Info: Long term resource limitation
143	Map Dialog User Abort Diagnostic Info: Handover cancellation
144	Map Dialog User Abort Diagnostic Info: Radio Channel Release
145	Map Dialog User Abort Diagnostic Info: Call Release
146	Map Dialog User Abort Diagnostic Info: Network path Release
147	Map Dialog User Abort Diagnostic Info: Associated Procedure release
148	Map Dialog User Abort Diagnostic Info: Tandem Dialog Release
149	Map Dialog User Abort Diagnostic Info: Remote Operation Failure
150	UNKNOWN subscriber\|Map Dialog User Abort User Reason: User specific reason
151	Call barred\|Map Dialog User Abort User Reason: User resource limitation
152	Teleservice not provisioned\|EC_NNR_noTranslationForAnAddressOfSuchNature
153	Absent subscriber\|EC_NNR_noTranslationForThisSpecificAddress
154	Facility not supported\|EC_NNR_subsystemCongestion
155	System failure\|EC_NNR_subsystemFailure
156	Unexpected data value\|EC_NNR_unequippedUser
157	Data missing\|EC_NNR_MTPfailure
158	Memory capacity exceeded\|EC_NNR_networkCongestion
159	Mobile subscriber not reachable\|EC_NNR_unqualified
160	Reject\|EC_NNR_errorInMessageTransportXUDT
161	Local cancel\|EC_NNR_errorInLocalProcessingXUDT
162	Abort\|EC_NNR_destinationCannotPerformReassemblyXUDT
163	Exception\|EC_NNR_SCCPfailure
164	UNKNOWN\|EC_NNR_hopCounterViolation
165	EC_NNR_segmentationNotSupported
166	EC_NNR_segmentationFailure
167	USSD platform Unknown error
168	DND Blocked
169	MAP-P-Abort: Provider reasons
170	MAP-P-Abort Provider reason: Malfunction
171	MAP-P-Abort Provider reason: Dialog Released
172	'waiting queue in destination subscriber table is full'
173	MAP-P-Abort Provider reason: Abnormal Dialog
174	MAP-P-Abort: Invalid PDU
175	MAP-Open: Out of MAP dialogs
176	Invalid Service code
177	Subscriber MSISDN Blacklisted
178	Subscriber IMSI Blacklisted
179	Invalid Originating Address with Length greater than 20 chars
180	MAP-Open Refuse reason: Node Not Reached
181	'service barred'
182	'operation barred'
183	VLRBlackListed
184	VLRWhiteListed
185	MAP-Notice Problem: Message Cannot Be Delivered
186	BILNG_SystemError
187	MAP-Notice: Abnormal event detected by peer
188	MAP-U-Abort: Error
189	MAP-U-Abort User Reason: User Specific Reason
190	MAP-U-Abort: User resource limitation
191	MAP-U-Abort: Resource unavailable (short term)
192	Unexpected session release from Servers/3rd party APP
193	'unknServCent'
194	'sc_Congestion'
195	'invaSME_Add'
196	'subsNotSC_Subsc'
197	Application Specific Error from Client
198	MAP-U-Abort: Application procedure cancellation (tandem dialogue released)
199	MAP-U-Abort: Application procedure cancellation (remote operations failure)
200	Unidentified subscriber\|OPERATOR BLOCKED FOR ACCOUNT
201	Absent subscriber IMSI detached\|EC_unknown Subscriber
202	Absent subscriber no page response\|Unknown Base Station
203	Subscriber busy for MT-SMS\|Unknown MSC
205	Illegal subscriber\|EC_Unidentified Subscriber
206	Illegal equipment\|Absent Subscriber for SM
206	Illegal equipment\|Absent Subscriber for SM
207	System failure\|Unknown Equipment
208	Unexpected data value\|Roaming Not Allowed
209	Data missing\|Illegal Subscriber
210	Memory capacity exceeded\|Illegal SS Operation
211	Equipment protocol error\|SS Error Status
212	Equipment not short message equipped\|SS Not Available
213	Reject\|SS Subscription Violation
214	Local cancel\|SS Incompatible
215	Abort\|HLR:limited due to MS roaming'
216	Exception\|Internal IPC memory allocation Failure
217	UNKNOWN\|Internal IPC Router Failure
218	'HLR:illegal subscriber'
219	'HLR:subscriber absent'
220	'HLR:the called MS poweroff'
221	MSISDN BLOCKED
221	Message List Full
222	MESSAGE CONTENT IS BLACKLISTED/EC_Network System Failure
223	Data Missing
224	Unexpected Data
225	MESSAGE CONTENT IS BLACKLISTED AT OPERATOR/ 'HLR:no response'
226	'VMSC:no response'
227	IN Subscriber not exist1
228	'the destination subscriber PPS authentication overtime'
229	'IN Invalid subscriber'
230	Not Allowed
231	ATI Not Allowed
232	No Group Call Number Available
233	Resource Limitation
234	Unauthorized Requesting Network
235	Unathorized LCS Client
236	Position Method Failure
237	Custom error 8
238	Custom error 9
239	Custom error 10
240	Recipient Temporary Error
241	Recipient Permanent Error
242	Service Not configured/for a particular circle/subscriber. Or simply menu is incomplete or service i
243	Terminating session due to invalid input
244	Unspecific
245	'HLR:the remote address not reachable' /'VMSC:Invalid Destination'
246	Client Resource Not Available
247	Unknown Alphabet
248	EC_TIME_OUT
249	EC_IMSI_BLACKLISTED
250	Personal service barring\|EC_DEST_ADDRESS_BLACKLISTED
251	Personal service barring\|EC_InvalidMscAddress
252	Personal service barring\|MESSAGE VALIDITY EXPIRED
253	Personal service barring\|the origination subscriber PPS authentication SCP connection broken'
254	Personal service barring\|any other error code other than 255
255	Personal service barring\|EC_UNKNOWN_ERROR
255	Personal service barring\|EC_UNKNOWN_ERROR
256	Personal service barring\|EC_SM_DF_memoryCapacityExceeded
257	Personal service barring\|EC_SM_DF_equipmentProtocolError
258	EC_SM_DF_equipmentNotSM_Equipped
259	EC_SM_DF_unknownServiceCentre
260	EC_SM_DF_sc_Congestion
260	'SMS not supported by MS'
261	EC_SM_DF_invalidSME_Address
262	EC_SM_DF_subscriberNotSC_Subscriber
263	MO Handover: Destination SME Barred
264	MO Handover: Duplicate Message Rejected
265	MO Handover: Validity Period Format Unsupported
266	MO Handover: Validity Period Unsupported
267	MO Handover: Not Supported by equipment
268	MO Handover: System Error
269	MO Handover: Duplicated invoke id
270	MO Handover: Service not supported
271	MO Handover: Mistyped parameter
272	MO Handover: No response from the peer
273	MO Handover: Resource limitation
274	MO Handover: Initiating release
275	Error Gateway
276	MO Handover: Unexpected error
277	MO Handover: Unexpected response from the peer
278	MO Handover: Unable to complete operation within timeout
279	MO Handover: Invalid response received
280	Error\|MO Handover: TCAP error
281	EC_UA_userSpecificReason
282	EC_UA_userResourceLimitation
283	EC_UA_resourceUnavailable
284	EC_UA_applicationProcedureCancellation
285	MO Handover: Unexpected Data Value
286	MO Handover: Telematic Interworking not Supported
287	MO Handover: FDA throttled
288	MO Handover: SM decoding problem
300	Invalid destination address\|Provider Error Duplicate Invoke ID
301	Invalid destination numbering plan\|Provider Error Service Not Supported
302	Invalid destination type of number\|Provider Error Mistyped Paramter
303	Invalid destination flag\|Provider Error Resource Limitation
304	Invalid number of destinations\|Provider Error Initiating Release
305	Provider Error Unexpected Response
306	Provider Error Service Completion Failure
307	EC_Provider No Response from Peer
308	Provider Error Invalid Response
400	EC_MAP_abort _error
401	Stack/Sig Error Map User specific Reason
402	Stack/Sig Error Map User Resource Limitation
403	Stack/Sig Error Map Resource Unavailable
404	Stack/Sig Error Map Application Procedure Cancellation
407	EC_HLR/MSC Timeout
409	Unknown Error
410	EC_Cancelled
411	EC_ValidityExpired
412	EC_NotSubmittedToSmppChannel
413	EC_DESTINATION_FLOODING
414	EC_DESTINATION_TXT_FLOODING
415	Stack/Sig Response Rejected By Peer
416	Stack/Sig Abnormal Event Recieved From Peer
417	Stack/Sig Cannot deliver Message
417	Sig Error Map Invalid Response from peer
418	Sig Error Map Dialogue Does not Exist
419	Sig Error Map Max evoke reached
420	Stack/Sig Invalid Origination Reference
420	Stack/Sig Invalid Origination Reference
421	Stack/Sig No Reson
421	Stack/Sig No Reson
422	Stack/Sig Remote Node Not Reachable
422	Stack/Sig Remote Node Not Reachable
423	Stack/Sig Map Potential Version Incompatibility
424	Stack/Sig Secured Transport Not Possible
424	Stack/Sig Secured Transport Not Possible
425	Stack/Sig Usr Transport Protection Not Adequate
425	Stack/Sig Usr Transport Protection Not Adequate
428	Sig Error MAP Subsystem congested
428	Sig Error MAP Subsystem congested
429	Sig Error MAP Subsystem failure
429	Sig Error MAP Subsystem failure
430	Sig Error MAP Error in local processing CCIT92
430	Sig Error MAP Error in local processing CCIT92
431	Sig Error MAP Re assembly failure
431	Sig Error MAP Re assembly failure
432	Sig Error MAP SCCP failure
432	Sig Error MAP SCCP failure
433	Sig Error MAP HOP counter violation ITU
433	Sig Error MAP HOP counter violation ITU
434	Sig Error MAP segmentation not supported
434	Sig Error MAP segmentation not supported
435	Sig Error MAP Segmentation failure
435	Sig Error MAP Segmentation failure
496	EC_invalidPduFurmat
497	EC_NotSubmittedToGMSC
500	EC_PROVIDER_GENERAL_ERROR
501	Insufficient Balance
502	EC_NO_RESPONSE
503	EC_SERVICE_COMPLETION_FAILURE
504	EC_UNEXPECTED_RESPONSE_FROM_PEER
507	EC_MISTYPED_PARAMETER
508	EC_NOT_SUPPORTED_SERVICE
509	EC_DUPLICATED_INVOKE_ID
510	Temp_Fail
511	SPAM_Fail
536	EC_PA_providerMalfunction
537	EC_PA_supportingDialogOrTransactionRealeased
538	EC_PA_ressourceLimitation
539	EC_PA_maintenanceActivity
540	EC_PA_versionIncompatibility
541	EC_PA_abnormalMapDialog
600	Internal Error
601	Timeout at SRI
602	Absent subscriber
703	Submit_SM_Timeout
715	Expired at BMG
715	Expired
792	EC_NC_abnormalEventDetectedByPeer
793	EC_NC_responseRejectedByPeer
794	EC_NC_abnormalEventReceivedFromPeer
795	EC_NC_messageCannotBeDeliveredToPeer
796	EC_NC_providerOutOfInvoke
801	EC_BLACKLISTED_MSISDN
1001	No Response from far Network
1024	EC_OR_appContextNotSupported
1025	EC_OR_invalidDestinationReference
1026	EC_OR_invalidOriginatingReference;
1027	EC_OR_encapsulatedAC_NotSupported
1028	EC_OR_transportProtectionNotAdequate
1029	EC_OR_noReasonGiven
1030	EC_OR_potentialVersionIncompatibility
1031	EC_OR_remoteNodeNotReachable
1152	EC_NNR_noTranslationForAnAddressOfSuchNatur
1153	EC_NNR_noTranslationForThisSpecificAddress
1154	EC_NNR_subsystemCongestion
1155	EC_NNR_subsystemFailure
1156	EC_NNR_unequippedUser
1157	EC_NNR_MTPfailure
1158	EC_NNR_networkCongestion
1159	EC_NNR_unqualified
1160	EC_NNR_errorInMessageTransportXUDT
1161	EC_NNR_errorInLocalProcessingXUDT
1162	EC_NNR_destinationCannotPerformReassemblyXUDT
1163	EC_NNR_SCCPfailure
1164	EC_NNR_hopCounterViolation
1165	EC_NNR_segmentationNotSupported
1166	EC_NNR_segmentationFailure
1281	EC_UA_userSpecificReason
1282	EC_UA_userResourceLimitation
1283	EC_UA_resourceUnavailable
1284	EC_UA_applicationProcedureCancellation
1536	EC_PA_providerMalfunction
1537	EC_PA_supportingDialogOrTransactionRealeased
1538	EC_PA_ressourceLimitation
1539	EC_PA_maintenanceActivity
1540	EC_PA_versionIncompatibility
1541	EC_PA_abnormalMapDialog
1793	EC_NC_responseRejectedByPeer
1794	EC_NC_abnormalEventReceivedFromPeer
1795	EC_NC_messageCannotBeDeliveredToPeer
1796	EC_NC_providerOutOfInvoke
2000	Make_Call API Failure
2001	Message too long
2002	Command length is invalid
2003	Command ID is invalid or not supported
2004	Incorrect bind status for given command
2005	Already bound
2006	Invalid Priority Flag
2007	Invalid registered delivery flag
2008	System error
2010	Invalid source address
2011	Invalid destination address
2012	Message ID is invalid
2013	Bind failed
2014	Invalid password
2015	Invalid System ID
2017	Cancelling message failed
2019	Message recplacement failed
2020	Message queue full
2021	Invalid service type
2022	Invalid services type
2048	EC_TIME_OUT
2049	EC_IMSI_BLACKLISTED
2050	EC_DEST_ADDRESS_BLACKLISTED
2051	EC_InvalidMscAddress
2052	EC_BLACKLISTED_DESTINATIONADDRESS
2064	Invalid destination flag
2066	Invalid submit with replace request
2067	Invalid esm class set
2068	Invalid submit to ditribution list
2069	Submitting message has failed
2072	Invalid source address type of number ( TON )
2073	Invalid source address numbering plan ( NPI )
2080	Invalid destination address type of number ( TON )
2081	Invalid destination address numbering plan ( NPI )
2083	Invalid system type
2084	Invalid replace_if_present flag
2085	Invalid number of messages
2088	Throttling error
2097	Invalid scheduled delivery time
2098	Invalid Validty Period value
2099	Predefined message not found
2100	ESME Receiver temporary error
2101	ESME Receiver permanent error
2102	ESME Receiver reject message error
2103	Message query request failed
2168	DND Block
2192	Error in the optional part of the PDU body
2193	TLV not allowed
2194	Invalid parameter length
2195	Expected TLV missing
2196	Invalid TLV value
2254	Transaction delivery failure
2255	Unknown error
2256	ESME not authorised to use specified servicetype
2257	ESME prohibited from using specified operation
2258	Specified servicetype is unavailable
2259	Specified servicetype is denied
2260	Invalid data coding scheme
2261	Invalid source address subunit
2262	Invalid destination address subunit
2300	Incorrect destination address
2301	Incorrect number of destination addresses
2302	Syntax error in user data parameter
2303	Incorrect bin/head/normal user data parameter combination
2304	Incorrect dcs parameter usage
2305	Incorrect validity period parameters usage
2306	Incorrect originator address usage
2307	Incorrect PID parameter usage
2308	Incorrect first delivery parameter usage
2309	Incorrect reply path usage
2310	Incorrect status report request parameter usage
2311	Incorrect cancel enabled parameter usage
2312	Incorrect priority parameter usage
2313	Incorrect tariff class parameter usage
2314	Incorrect service description parameter usage
2315	Incorrect transport type paramdeter usage
2316	Incorrect message type parameter usage
2318	Incorrect MMS parameter usage
2319	Incorrect operation timer parameter usage
2320	Incorrect dialogue ID parameter usage
2321	Incorrect alpha originator address usage
2322	Invalid data for alpha numeric originator
2323	Online closed user group rejection
2324	Licence exceeded
4000	DLT_SCRUBBING_TIMEOUT
4001	DLT_SCRUBBING_TIMEOUT
4096	EC_InvalidPduFormat
4097	EC_NotSubmittedToGMSC
4100	EC_Cancelled
4101	EC_ValidityExpired
4103	EC_DESTINATION_FLOODING
4104	EC_DESTINATION_TXT_FLOODING
4106	BLOCKED_BY_DLT
4107	DLT_SCRUBBING_TIMEOUT
4108	SENDER_BLOCKED_BY_DLT
5000	SCRUBBING_FAILED
5001	SCRUBBING_FAILED
5101	BLOCKED_BY_DLT
5102	BLOCKED_BY_DLT
5103	BLOCKED_BY_DLT
5104	BLOCKED_BY_DLT
5105	BLOCKED_BY_DLT
5106	BLOCKED_BY_DLT
5107	BLOCKED_BY_DLT
5108	BLOCKED_BY_DLT
5201	SENDER_BLOCKED_BY_DLT
5202	SENDER_BLOCKED_BY_DLT
5203	SENDER_MISMATCH_WITH_ENTITY
5204	SENDER_BLOCKED_BY_DLT
5205	Entity_ID_Not_Matched
5301	TEMPLATE_ERROR
5302	TEMPLATE_ERROR
5303	TEMPLATE_ERROR
5304	Content ID not in DB
5305	TEMPLATE_ERROR
5306	TEMPLATE_ERROR
5307	TEMPLATE_ERROR
5308	TEMPLATE_ERROR
5401	TEMPLATE_ERROR
5402	TEMPLATE_ERROR
5403	TEMPLATE_ERROR
5404	TEMPLATE_ERROR
5405	TEMPLATE_ERROR
5406	TEMPLATE_ERROR
5501	CONSENT_FAILED
5502	CONSENT_FAILED
5503	CONSENT_FAILED
7001	ENTITY_ID_ERROR
7002	ENTITY_ID_ERROR
7003	ENTITY_ID_ERROR
7004	ENTITY_ID_ERROR
20A	Bearer Service Not Supported
20b	Tele Service Not Provisioned
20c	Error Equipment
20d	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21b	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21f	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Reply from Subscriber
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40a	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error MAP guard timer expired
41B	Sig Error MAP SPCAUSE mask
41c	Sig Error MAP No translation Based Address
41d	Sig Error MAP No translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig DlG Invalid Destination Reference
42a	Sig Error MAP unequipped user
42b	Sig Error MAP network failure
42c	Sig Error MAP network congestion
42d	Sig Error MAP unqualified
42E	Sig Error MAP HOP Counter violation ANS92
42F	Sig Error MAP Error in message transport CCIT92
20A	Bearer Service Not Supported
20B	Tele Service Not Provisioned
20C	Error Equipment
20D	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21B	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21F	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Subscriber Reply
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40A	Stack/Sig Error Map Provider Malfunction
40A	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error Map guard Timer Expired
41B	Sig Error Map SPCAUSE mask
41C	Sig Error MAP No Translation Basd Address
41D	Sig Error MAP No Translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig Dlg Invalid Destination Reference
42A	Sig Error MAP Un Equipped User
42A	Sig Error MAP Un Equipped User
42B	Sig Error MAP Network Failure
42B	Sig Error MAP Network Failure
42C	Sig Error MAP Network Conjestion
42C	Sig Error MAP Network Conjestion
42D	Sig Error MAP un Qualified
42D	Sig Error MAP un Qualified
42E	Sig Error MAP HOP Counter violaion ANS92
42E	Sig Error MAP HOP Counter violaion ANS92
42F	Sig Error MAP Error in message transport CCIT92
42F	Sig Error MAP Error in message transport CCIT92

Sending SMS To An Optin Group

The URL for sending an SMS to an optin group is in the following format:

https://www.mysmsapp.in/api/push.json? method=optin&api_key=Ad9e5XXXXXXXX&sender=INFXXX&message=testing&format=json&name=keyword777

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
delivery reports URL	dlrurl	The URL to receive delivery reports. Spiffing custom is mandatory.	delivery reports URL
Message ID	custom	Custom message ID by customer, comma separated	Alphanumeric (max 40 char)
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM
unicode	unicode	To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.	1 / 0 / auto
flash	flash	To specify that the message is to be sent in the flash format	1 or 0

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the Optin API to send an SMS is in the below format :

ErrorCode	Description
0	NORMAL DELIVERED
1	Source not found\|EC_UNKNOWN_SUBSCRIBER
2	Sink not found\|EC_UNKNOWN_BASE_STATION
3	Delivery zone not found\|DND Fail
5	Location not found\|EC_UNIDENTIFIED_SUBSCRIBER
6	Location blocked\|Absent subscriber
7	Reply path not found\|UNKNOWN EQUIPMENT
8	Message not submit\|FSM TIMEOUT
9	Unsupported number plan\|EC_ILLEGAL_SUBSCRIBER
10	Unsupported type of number\|EC_BEARER_SERVICE_NOT_PROVISIONED
11	Message not DELIVER or STATUS\|EC_TELESERVICE_NOT_PROVISIONED
12	Dialling zone not found\|EC_ILLEGAL_EQUIPMENT
13	Not home zone and IMSI not allowed\|EC_CALL_BARRED
14	Not home zone and IMSI fetch failed\|Barred unauthorized message originator
15	Screening block\|CUG REJECT
18	ESME error\|message waiting for report expired'
19	Originating location mismatch\|SRIAck unsuccessful with any other error codes'
20	Originating reservation failed\|EC_SS_INCOMPATIBILITY
21	Originating reservation denied subscription not found\|EC_FACILITY_NOT_SUPPORTED
22	Originating reservation denied subscription state illegal\|Memory capacity exceeded
23	Originating reservation denied call case blocked for subscription\|Unknown Subscriber'
24	Originating reservation denied call case blocked for subscription type\|call forbidden'
25	Originating reservation denied low balance\|the network does not support SMS'
26	'teleservice not supported'
27	Absent subscriber
29	'HLR:data error in route signal'
30	Terminating reservation failed\|HLR:data lacked'
31	Terminating reservation denied subscription not found\|EC_SUBSCRIBER_BUSY_FOR_MT_SMS
32	Terminating reservation denied subscription state illegal\|EC_SM_DELIVERY_FAILURE
33	Terminating reservation denied call case blocked for subscription\|EC_MESSAGE_WAITING_LIST_FULL
34	Terminating reservation denied call case blocked for subscription type\|EC_SYSTEM_FAILURE
35	Terminating reservation denied low balance\|EC_DATA_MISSING
36	EC_UNEXPECTED_DATA_VALUE
37	'Unmarked Subscriber'
38	'failure because the subscriber is busy'
39	'VMSC isolated'
40	System is congested\|VMSC:data lacked'
41	Originating IMSI mismatch\|VMSC:unexpected data'
42	'MS error'
43	Not Supported by equipment
44	Illegal equipment
45	Quarantine Add\|Unspecific PID Error
46	Quarantine Remove\|Message Class Not Supported
47	DCS error
48	TPDU Not Supported
49	Short message delivery failure with memory capacity exceeded
50	Unexpected error from Store\|UNKNOWN ERROR
51	Direct delivery disabled from store\|EC_RESOURCE_LIMITATION
53	Message limit exceeded\|Subscriber Busy For MT-SMS
54	Retry scheme ended\|Data Download Error
60	Originator blocked\|Absent subscriber
61	Destination blocked\|Absent subscriber
62	Keyword blocked\|Absent subscriber
63	SC address blocked\|Absent subscriber
64	Blocked due to exceeded quota\|Absent subscriber
65	Loop detected\|Absent subscriber
66	Data coding scheme blocked\|Absent subscriber over GPRS Page Fail
67	Information element identifier blocked\|Absent subscriber over GPRS Detached
68	Country Code Validation Block\|Absent subscriber over GPRS Deregistered
69	Destination Flooding
70	No ESME provider available\|MS store is full'
71	ESME account not connected\|EC_UNKNOWN_ALPHABET
72	No ESME sub account routing\|EC_USSD_BUSY
74	ESME local throttling - exceeded msg/s\|INVALID HEADER IN MSG
80	Home routing sender GT mismatch\|PENDING DLR (Retry )
81	Location mismatch between provided location and location known to HLR.\|Service not supported
82	IMSI mismatch between provided IMSI \|Mistyped parameter
83	Local throttling by sink\|No response from the peer
84	The IMSI could not be retrieved from the HSS\|Resource limitation
85	The IMEI of the UE is unknown\|Initiating release
86	The user location is unknown\|Unrecognised error
87	ESME router\|Provider Error (In case of any failures observed in TCAP level this error will generate).
88	Network fluctuation from far End Operator(Temporary Error)
89	INVALID PACKET AT SMSC LEVEL
90	USER-ABORT
91	PROVIDER-ABORT
92	MSC NUMBER MISSING
93	Equipment protocol error
94	Equipment not SM equipped
95	Unknown service centre
96	Service Centre congestion
97	INVALID SCHEDULE DELIVERY TIME
98	Subscriber not SC subscriber
99	Invalid SME address
100	Unidentified subscriber\|no response from the called subscriber'
101	Facility not supported\|VMSC:the called MS poweroff'
102	System failure\|VMSC:limited due to MS roaming' / SENDER ID BLOCKED
103	Unexpected data value\|ROUTE NOT ACTIVE
104	Data missing\|OFF-NET NOT ACTIVE FOR ACCOUNT/ ON-NET ROUTES NOT DEFINED
105	Equipment protocol error\|MTP_FAILURE
106	UNKNOWN service centre address\|MS response is overtime'
107	Service centre congestion\|HLR:the subscriber is unregistered'
108	Invalid short message entity address\|ROUTE BLOCKED FOR THIS SERIES
109	Subscriber not service centre subscriber\|MSISDN SERIES NOT CONFIGURED
110	Reject\|NOT ABLE TO GET FINAL ROUTE
111	Local cancel\|Queue_Unvailable
112	Abort\|NOT A VALID TEMPLATE
113	Exception\|MANDATORY WORDS NOT FOUND
114	UNKNOWN\|DEFAULT ROUTE NOT FOUND IN CONFIGURED ROUTES
115	ROUTE NOT CONFIGURED AT PLATFORM LEVEL
116	Map Dialog P Abort Indication Provider Reason: Maintenance Activity
117	Map Dialog P Abort Indication Provider Reason: Version Incompatibility
118	Map Dialog P Abort Indication Provider Reason: Abnormal Dialogue
119	MAP_DLGUA_UsrRsn_NTR_MapDlgUnavailable
120	MAP_DLGUA_UsrRsn_NTR_MapNotConfigured
121	MAP_DLGUA_UsrRsn_NTR_OtherErr
122	MAP_DLGRJT_PrvRsn_NotSent
123	INTERNATIONAL ROAMING
124	EC_OR_appContextNotSupported
125	EC_OR_invalidDestinationReference
126	EC_OR_invalidOriginatingReference
127	EC_OR_encapsulatedAC_NotSupported
128	EC_OR_transportProtectionNotAdequate
129	EC_OR_noReasonGiven
130	EC_OR_potentialVersionIncompatibility
131	EC_OR_remoteNodeNotReachable
132	Map Dialog Rejected Refuse Reason: Application Context not supported
133	Map Dialog Rejected Refuse Reason: Potential Version Incompatibility
134	Map Dialog Rejected Refuse Reason: Remote Node not reachable
135	Map Dialog Rejected Provider Reason: Provider malfunction
136	Map Dialog Rejected Provider Reason: Transaction Released
137	Map Dialog Rejected Provider Reason: Resource Limitation
138	Map Dialog Rejected Provider Reason: Maintenance Activity
139	Map Dialog Rejected Provider Reason: Version Incompatibility
140	Map Dialog Rejected Provider Reason: Abnormal Dialogue
141	Map Dialog User Abort Diagnostic Info: Short Term resource Limitation
142	Map Dialog User Abort Diagnostic Info: Long term resource limitation
143	Map Dialog User Abort Diagnostic Info: Handover cancellation
144	Map Dialog User Abort Diagnostic Info: Radio Channel Release
145	Map Dialog User Abort Diagnostic Info: Call Release
146	Map Dialog User Abort Diagnostic Info: Network path Release
147	Map Dialog User Abort Diagnostic Info: Associated Procedure release
148	Map Dialog User Abort Diagnostic Info: Tandem Dialog Release
149	Map Dialog User Abort Diagnostic Info: Remote Operation Failure
150	UNKNOWN subscriber\|Map Dialog User Abort User Reason: User specific reason
151	Call barred\|Map Dialog User Abort User Reason: User resource limitation
152	Teleservice not provisioned\|EC_NNR_noTranslationForAnAddressOfSuchNature
153	Absent subscriber\|EC_NNR_noTranslationForThisSpecificAddress
154	Facility not supported\|EC_NNR_subsystemCongestion
155	System failure\|EC_NNR_subsystemFailure
156	Unexpected data value\|EC_NNR_unequippedUser
157	Data missing\|EC_NNR_MTPfailure
158	Memory capacity exceeded\|EC_NNR_networkCongestion
159	Mobile subscriber not reachable\|EC_NNR_unqualified
160	Reject\|EC_NNR_errorInMessageTransportXUDT
161	Local cancel\|EC_NNR_errorInLocalProcessingXUDT
162	Abort\|EC_NNR_destinationCannotPerformReassemblyXUDT
163	Exception\|EC_NNR_SCCPfailure
164	UNKNOWN\|EC_NNR_hopCounterViolation
165	EC_NNR_segmentationNotSupported
166	EC_NNR_segmentationFailure
167	USSD platform Unknown error
168	DND Blocked
169	MAP-P-Abort: Provider reasons
170	MAP-P-Abort Provider reason: Malfunction
171	MAP-P-Abort Provider reason: Dialog Released
172	'waiting queue in destination subscriber table is full'
173	MAP-P-Abort Provider reason: Abnormal Dialog
174	MAP-P-Abort: Invalid PDU
175	MAP-Open: Out of MAP dialogs
176	Invalid Service code
177	Subscriber MSISDN Blacklisted
178	Subscriber IMSI Blacklisted
179	Invalid Originating Address with Length greater than 20 chars
180	MAP-Open Refuse reason: Node Not Reached
181	'service barred'
182	'operation barred'
183	VLRBlackListed
184	VLRWhiteListed
185	MAP-Notice Problem: Message Cannot Be Delivered
186	BILNG_SystemError
187	MAP-Notice: Abnormal event detected by peer
188	MAP-U-Abort: Error
189	MAP-U-Abort User Reason: User Specific Reason
190	MAP-U-Abort: User resource limitation
191	MAP-U-Abort: Resource unavailable (short term)
192	Unexpected session release from Servers/3rd party APP
193	'unknServCent'
194	'sc_Congestion'
195	'invaSME_Add'
196	'subsNotSC_Subsc'
197	Application Specific Error from Client
198	MAP-U-Abort: Application procedure cancellation (tandem dialogue released)
199	MAP-U-Abort: Application procedure cancellation (remote operations failure)
200	Unidentified subscriber\|OPERATOR BLOCKED FOR ACCOUNT
201	Absent subscriber IMSI detached\|EC_unknown Subscriber
202	Absent subscriber no page response\|Unknown Base Station
203	Subscriber busy for MT-SMS\|Unknown MSC
205	Illegal subscriber\|EC_Unidentified Subscriber
206	Illegal equipment\|Absent Subscriber for SM
206	Illegal equipment\|Absent Subscriber for SM
207	System failure\|Unknown Equipment
208	Unexpected data value\|Roaming Not Allowed
209	Data missing\|Illegal Subscriber
210	Memory capacity exceeded\|Illegal SS Operation
211	Equipment protocol error\|SS Error Status
212	Equipment not short message equipped\|SS Not Available
213	Reject\|SS Subscription Violation
214	Local cancel\|SS Incompatible
215	Abort\|HLR:limited due to MS roaming'
216	Exception\|Internal IPC memory allocation Failure
217	UNKNOWN\|Internal IPC Router Failure
218	'HLR:illegal subscriber'
219	'HLR:subscriber absent'
220	'HLR:the called MS poweroff'
221	MSISDN BLOCKED
221	Message List Full
222	MESSAGE CONTENT IS BLACKLISTED/EC_Network System Failure
223	Data Missing
224	Unexpected Data
225	MESSAGE CONTENT IS BLACKLISTED AT OPERATOR/ 'HLR:no response'
226	'VMSC:no response'
227	IN Subscriber not exist1
228	'the destination subscriber PPS authentication overtime'
229	'IN Invalid subscriber'
230	Not Allowed
231	ATI Not Allowed
232	No Group Call Number Available
233	Resource Limitation
234	Unauthorized Requesting Network
235	Unathorized LCS Client
236	Position Method Failure
237	Custom error 8
238	Custom error 9
239	Custom error 10
240	Recipient Temporary Error
241	Recipient Permanent Error
242	Service Not configured/for a particular circle/subscriber. Or simply menu is incomplete or service i
243	Terminating session due to invalid input
244	Unspecific
245	'HLR:the remote address not reachable' /'VMSC:Invalid Destination'
246	Client Resource Not Available
247	Unknown Alphabet
248	EC_TIME_OUT
249	EC_IMSI_BLACKLISTED
250	Personal service barring\|EC_DEST_ADDRESS_BLACKLISTED
251	Personal service barring\|EC_InvalidMscAddress
252	Personal service barring\|MESSAGE VALIDITY EXPIRED
253	Personal service barring\|the origination subscriber PPS authentication SCP connection broken'
254	Personal service barring\|any other error code other than 255
255	Personal service barring\|EC_UNKNOWN_ERROR
255	Personal service barring\|EC_UNKNOWN_ERROR
256	Personal service barring\|EC_SM_DF_memoryCapacityExceeded
257	Personal service barring\|EC_SM_DF_equipmentProtocolError
258	EC_SM_DF_equipmentNotSM_Equipped
259	EC_SM_DF_unknownServiceCentre
260	EC_SM_DF_sc_Congestion
260	'SMS not supported by MS'
261	EC_SM_DF_invalidSME_Address
262	EC_SM_DF_subscriberNotSC_Subscriber
263	MO Handover: Destination SME Barred
264	MO Handover: Duplicate Message Rejected
265	MO Handover: Validity Period Format Unsupported
266	MO Handover: Validity Period Unsupported
267	MO Handover: Not Supported by equipment
268	MO Handover: System Error
269	MO Handover: Duplicated invoke id
270	MO Handover: Service not supported
271	MO Handover: Mistyped parameter
272	MO Handover: No response from the peer
273	MO Handover: Resource limitation
274	MO Handover: Initiating release
275	Error Gateway
276	MO Handover: Unexpected error
277	MO Handover: Unexpected response from the peer
278	MO Handover: Unable to complete operation within timeout
279	MO Handover: Invalid response received
280	Error\|MO Handover: TCAP error
281	EC_UA_userSpecificReason
282	EC_UA_userResourceLimitation
283	EC_UA_resourceUnavailable
284	EC_UA_applicationProcedureCancellation
285	MO Handover: Unexpected Data Value
286	MO Handover: Telematic Interworking not Supported
287	MO Handover: FDA throttled
288	MO Handover: SM decoding problem
300	Invalid destination address\|Provider Error Duplicate Invoke ID
301	Invalid destination numbering plan\|Provider Error Service Not Supported
302	Invalid destination type of number\|Provider Error Mistyped Paramter
303	Invalid destination flag\|Provider Error Resource Limitation
304	Invalid number of destinations\|Provider Error Initiating Release
305	Provider Error Unexpected Response
306	Provider Error Service Completion Failure
307	EC_Provider No Response from Peer
308	Provider Error Invalid Response
400	EC_MAP_abort _error
401	Stack/Sig Error Map User specific Reason
402	Stack/Sig Error Map User Resource Limitation
403	Stack/Sig Error Map Resource Unavailable
404	Stack/Sig Error Map Application Procedure Cancellation
407	EC_HLR/MSC Timeout
409	Unknown Error
410	EC_Cancelled
411	EC_ValidityExpired
412	EC_NotSubmittedToSmppChannel
413	EC_DESTINATION_FLOODING
414	EC_DESTINATION_TXT_FLOODING
415	Stack/Sig Response Rejected By Peer
416	Stack/Sig Abnormal Event Recieved From Peer
417	Stack/Sig Cannot deliver Message
417	Sig Error Map Invalid Response from peer
418	Sig Error Map Dialogue Does not Exist
419	Sig Error Map Max evoke reached
420	Stack/Sig Invalid Origination Reference
420	Stack/Sig Invalid Origination Reference
421	Stack/Sig No Reson
421	Stack/Sig No Reson
422	Stack/Sig Remote Node Not Reachable
422	Stack/Sig Remote Node Not Reachable
423	Stack/Sig Map Potential Version Incompatibility
424	Stack/Sig Secured Transport Not Possible
424	Stack/Sig Secured Transport Not Possible
425	Stack/Sig Usr Transport Protection Not Adequate
425	Stack/Sig Usr Transport Protection Not Adequate
428	Sig Error MAP Subsystem congested
428	Sig Error MAP Subsystem congested
429	Sig Error MAP Subsystem failure
429	Sig Error MAP Subsystem failure
430	Sig Error MAP Error in local processing CCIT92
430	Sig Error MAP Error in local processing CCIT92
431	Sig Error MAP Re assembly failure
431	Sig Error MAP Re assembly failure
432	Sig Error MAP SCCP failure
432	Sig Error MAP SCCP failure
433	Sig Error MAP HOP counter violation ITU
433	Sig Error MAP HOP counter violation ITU
434	Sig Error MAP segmentation not supported
434	Sig Error MAP segmentation not supported
435	Sig Error MAP Segmentation failure
435	Sig Error MAP Segmentation failure
496	EC_invalidPduFurmat
497	EC_NotSubmittedToGMSC
500	EC_PROVIDER_GENERAL_ERROR
501	Insufficient Balance
502	EC_NO_RESPONSE
503	EC_SERVICE_COMPLETION_FAILURE
504	EC_UNEXPECTED_RESPONSE_FROM_PEER
507	EC_MISTYPED_PARAMETER
508	EC_NOT_SUPPORTED_SERVICE
509	EC_DUPLICATED_INVOKE_ID
510	Temp_Fail
511	SPAM_Fail
536	EC_PA_providerMalfunction
537	EC_PA_supportingDialogOrTransactionRealeased
538	EC_PA_ressourceLimitation
539	EC_PA_maintenanceActivity
540	EC_PA_versionIncompatibility
541	EC_PA_abnormalMapDialog
600	Internal Error
601	Timeout at SRI
602	Absent subscriber
703	Submit_SM_Timeout
715	Expired at BMG
715	Expired
792	EC_NC_abnormalEventDetectedByPeer
793	EC_NC_responseRejectedByPeer
794	EC_NC_abnormalEventReceivedFromPeer
795	EC_NC_messageCannotBeDeliveredToPeer
796	EC_NC_providerOutOfInvoke
801	EC_BLACKLISTED_MSISDN
1001	No Response from far Network
1024	EC_OR_appContextNotSupported
1025	EC_OR_invalidDestinationReference
1026	EC_OR_invalidOriginatingReference;
1027	EC_OR_encapsulatedAC_NotSupported
1028	EC_OR_transportProtectionNotAdequate
1029	EC_OR_noReasonGiven
1030	EC_OR_potentialVersionIncompatibility
1031	EC_OR_remoteNodeNotReachable
1152	EC_NNR_noTranslationForAnAddressOfSuchNatur
1153	EC_NNR_noTranslationForThisSpecificAddress
1154	EC_NNR_subsystemCongestion
1155	EC_NNR_subsystemFailure
1156	EC_NNR_unequippedUser
1157	EC_NNR_MTPfailure
1158	EC_NNR_networkCongestion
1159	EC_NNR_unqualified
1160	EC_NNR_errorInMessageTransportXUDT
1161	EC_NNR_errorInLocalProcessingXUDT
1162	EC_NNR_destinationCannotPerformReassemblyXUDT
1163	EC_NNR_SCCPfailure
1164	EC_NNR_hopCounterViolation
1165	EC_NNR_segmentationNotSupported
1166	EC_NNR_segmentationFailure
1281	EC_UA_userSpecificReason
1282	EC_UA_userResourceLimitation
1283	EC_UA_resourceUnavailable
1284	EC_UA_applicationProcedureCancellation
1536	EC_PA_providerMalfunction
1537	EC_PA_supportingDialogOrTransactionRealeased
1538	EC_PA_ressourceLimitation
1539	EC_PA_maintenanceActivity
1540	EC_PA_versionIncompatibility
1541	EC_PA_abnormalMapDialog
1793	EC_NC_responseRejectedByPeer
1794	EC_NC_abnormalEventReceivedFromPeer
1795	EC_NC_messageCannotBeDeliveredToPeer
1796	EC_NC_providerOutOfInvoke
2000	Make_Call API Failure
2001	Message too long
2002	Command length is invalid
2003	Command ID is invalid or not supported
2004	Incorrect bind status for given command
2005	Already bound
2006	Invalid Priority Flag
2007	Invalid registered delivery flag
2008	System error
2010	Invalid source address
2011	Invalid destination address
2012	Message ID is invalid
2013	Bind failed
2014	Invalid password
2015	Invalid System ID
2017	Cancelling message failed
2019	Message recplacement failed
2020	Message queue full
2021	Invalid service type
2022	Invalid services type
2048	EC_TIME_OUT
2049	EC_IMSI_BLACKLISTED
2050	EC_DEST_ADDRESS_BLACKLISTED
2051	EC_InvalidMscAddress
2052	EC_BLACKLISTED_DESTINATIONADDRESS
2064	Invalid destination flag
2066	Invalid submit with replace request
2067	Invalid esm class set
2068	Invalid submit to ditribution list
2069	Submitting message has failed
2072	Invalid source address type of number ( TON )
2073	Invalid source address numbering plan ( NPI )
2080	Invalid destination address type of number ( TON )
2081	Invalid destination address numbering plan ( NPI )
2083	Invalid system type
2084	Invalid replace_if_present flag
2085	Invalid number of messages
2088	Throttling error
2097	Invalid scheduled delivery time
2098	Invalid Validty Period value
2099	Predefined message not found
2100	ESME Receiver temporary error
2101	ESME Receiver permanent error
2102	ESME Receiver reject message error
2103	Message query request failed
2168	DND Block
2192	Error in the optional part of the PDU body
2193	TLV not allowed
2194	Invalid parameter length
2195	Expected TLV missing
2196	Invalid TLV value
2254	Transaction delivery failure
2255	Unknown error
2256	ESME not authorised to use specified servicetype
2257	ESME prohibited from using specified operation
2258	Specified servicetype is unavailable
2259	Specified servicetype is denied
2260	Invalid data coding scheme
2261	Invalid source address subunit
2262	Invalid destination address subunit
2300	Incorrect destination address
2301	Incorrect number of destination addresses
2302	Syntax error in user data parameter
2303	Incorrect bin/head/normal user data parameter combination
2304	Incorrect dcs parameter usage
2305	Incorrect validity period parameters usage
2306	Incorrect originator address usage
2307	Incorrect PID parameter usage
2308	Incorrect first delivery parameter usage
2309	Incorrect reply path usage
2310	Incorrect status report request parameter usage
2311	Incorrect cancel enabled parameter usage
2312	Incorrect priority parameter usage
2313	Incorrect tariff class parameter usage
2314	Incorrect service description parameter usage
2315	Incorrect transport type paramdeter usage
2316	Incorrect message type parameter usage
2318	Incorrect MMS parameter usage
2319	Incorrect operation timer parameter usage
2320	Incorrect dialogue ID parameter usage
2321	Incorrect alpha originator address usage
2322	Invalid data for alpha numeric originator
2323	Online closed user group rejection
2324	Licence exceeded
4000	DLT_SCRUBBING_TIMEOUT
4001	DLT_SCRUBBING_TIMEOUT
4096	EC_InvalidPduFormat
4097	EC_NotSubmittedToGMSC
4100	EC_Cancelled
4101	EC_ValidityExpired
4103	EC_DESTINATION_FLOODING
4104	EC_DESTINATION_TXT_FLOODING
4106	BLOCKED_BY_DLT
4107	DLT_SCRUBBING_TIMEOUT
4108	SENDER_BLOCKED_BY_DLT
5000	SCRUBBING_FAILED
5001	SCRUBBING_FAILED
5101	BLOCKED_BY_DLT
5102	BLOCKED_BY_DLT
5103	BLOCKED_BY_DLT
5104	BLOCKED_BY_DLT
5105	BLOCKED_BY_DLT
5106	BLOCKED_BY_DLT
5107	BLOCKED_BY_DLT
5108	BLOCKED_BY_DLT
5201	SENDER_BLOCKED_BY_DLT
5202	SENDER_BLOCKED_BY_DLT
5203	SENDER_MISMATCH_WITH_ENTITY
5204	SENDER_BLOCKED_BY_DLT
5205	Entity_ID_Not_Matched
5301	TEMPLATE_ERROR
5302	TEMPLATE_ERROR
5303	TEMPLATE_ERROR
5304	Content ID not in DB
5305	TEMPLATE_ERROR
5306	TEMPLATE_ERROR
5307	TEMPLATE_ERROR
5308	TEMPLATE_ERROR
5401	TEMPLATE_ERROR
5402	TEMPLATE_ERROR
5403	TEMPLATE_ERROR
5404	TEMPLATE_ERROR
5405	TEMPLATE_ERROR
5406	TEMPLATE_ERROR
5501	CONSENT_FAILED
5502	CONSENT_FAILED
5503	CONSENT_FAILED
7001	ENTITY_ID_ERROR
7002	ENTITY_ID_ERROR
7003	ENTITY_ID_ERROR
7004	ENTITY_ID_ERROR
20A	Bearer Service Not Supported
20b	Tele Service Not Provisioned
20c	Error Equipment
20d	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21b	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21f	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Reply from Subscriber
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40a	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error MAP guard timer expired
41B	Sig Error MAP SPCAUSE mask
41c	Sig Error MAP No translation Based Address
41d	Sig Error MAP No translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig DlG Invalid Destination Reference
42a	Sig Error MAP unequipped user
42b	Sig Error MAP network failure
42c	Sig Error MAP network congestion
42d	Sig Error MAP unqualified
42E	Sig Error MAP HOP Counter violation ANS92
42F	Sig Error MAP Error in message transport CCIT92
20A	Bearer Service Not Supported
20B	Tele Service Not Provisioned
20C	Error Equipment
20D	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21B	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21F	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Subscriber Reply
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40A	Stack/Sig Error Map Provider Malfunction
40A	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error Map guard Timer Expired
41B	Sig Error Map SPCAUSE mask
41C	Sig Error MAP No Translation Basd Address
41D	Sig Error MAP No Translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig Dlg Invalid Destination Reference
42A	Sig Error MAP Un Equipped User
42A	Sig Error MAP Un Equipped User
42B	Sig Error MAP Network Failure
42B	Sig Error MAP Network Failure
42C	Sig Error MAP Network Conjestion
42C	Sig Error MAP Network Conjestion
42D	Sig Error MAP un Qualified
42D	Sig Error MAP un Qualified
42E	Sig Error MAP HOP Counter violaion ANS92
42E	Sig Error MAP HOP Counter violaion ANS92
42F	Sig Error MAP Error in message transport CCIT92
42F	Sig Error MAP Error in message transport CCIT92

Sending A Port SMS

Using the below API we can send a normal or unicode SMS to a particular port Application port numbers can be used in SMS messages to deliver a particular SMS to an application on a mobile phone. If any application is present and running in that particular port, the text is received as port SMS else the message will hit the native inbox of the mobile

NOTE:The API tries to hit the application(port) for 10 seconds, if unsuccessful the message is delivered on the native inbox

To send a port SMS using the HTTP API, the following URL format is used:

https://www.mysmsapp.in/api/push.json?method=sms&api_key=Ad9e5XXXXXXXXXXXXX&to=997XXXXXXX,997XXXXXXX&sender=INFXXX&message=testing&format=json&port=8090

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)

Optional Parameters

Name	Parameter	Description	Expected Values
delivery reports URL	dlrurl	The URL to receive delivery reports. Spiffing custom is mandatory.	delivery reports URL
Message ID	custom	Custom message ID by customer, comma separated	Alphanumeric (max 40 char)
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM
unicode	unicode	To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.	1 / 0 / auto
flash	flash	To specify that the message is to be sent in the flash format	1 or 0

Advanced Parameters(Optional)

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
Callback function name	callback	Callback function for JSONP response format.	String
Custom reference fields	custom1 & custom2	Custom reference fields	Alphanumeric (max 40 char)
port number	port	Port number to which SMS has to be sent	Valid integer port number above 2000

Message Length - Multipart Port Messages

Standard GSM 03.38 Character Set

You could send up to 1000 characters as multipart message which will be split into 7 messages internally.

Number of SMS	Number of characters in the linked SMS
1	146 characters
2	292 characters (2 x 146)
3	438 characters (3 x 146)
....	......
6	upto 918 characters (6 x 153)
7	1000 characters (6 x 146) + 124

Unicode

You could send up to 500 characters as multipart message which will be split into 8 messages internally.

Number of SMS	Number of characters in the linked SMS
1	64 characters
2	128 characters (2 x 64)
3	192 characters (3 x 64)
...	....
6	upto 918 characters (6 x 153)
7	500 characters (7 x 64) + 52

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
A400	Api file not found in project
A401A	Method Not Implemented.
A401B	Method Not Found
A402	Api Key not found.
A403	Api Signature not found
A404	Your api account got suspended
A405	Api secret not found.
A406	Request is not allowed from this ip
A407	Header misconfigured
A408	Api Signature not equal

Adding Contacts to a Group

The URL for adding contacts to a group is in the following format:

https://www.mysmsapp.in/api/push.json?method=groups.register&api_key=Ad9e5XXXXXXXXXXXXX&name=friends&number=91XXXXXXXXXX&fullname=John&email=abc@gmail.com&format=xml

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
contact name	fullname	name of the contact	name of the contact
email address	email	email of the contact	email of the contact
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
add/delete action	action. Add is Default	Flag to specify the action	add/delete

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <message>Number has been added Successfully</message>
</api>

JSON

{
    "status": "OK",
    "message": "Number has been added Successfully",
}

PHP

{
    "status": "OK",
    "message": "Number has been added Successfully",
}

ERROR RESPONSE

{
    "status":"ERROR",
    "message":"Group Name does not exist!"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.

API Error Codes

The common error codes received while using the API to create a contact group is in the below format :

STATUS	MESSAGE
A420	Group name/id missing
A421	Group is empty/Invalid group
A422	Invalid mobile number
A423	Group name/number missing
A424	Group Name does not exist!
A425	Number does not Exist

Sending Message to a group

The URL for sending a simple message to a group is in the following format:

https://www.mysmsapp.in/api/push.json?method=groups&api_key=Ad9e5XXXXXXXXXXXXX&name=MYGROUP&sender=INFXXX&message=testing

The URL for sending a customized message to a group is in the following format:

https://www.mysmsapp.in/api/push.json?
method=groups&api_key=Ad9e5XXXXXXXXXXXXX&name=MYGROUP&sender=INFXXX&message=Dear {name}, Your email is {email}

Here {name} and {email} are variables and picked up from the group MYGROUP corresponding to each mobile number.

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM
unicode	unicode	To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.	1 / 0 / auto
flash	flash	To specify that the message is to be sent in the flash format	1 or 0

Advanced Parameters(Optional)

The advanced parameters in the HTTP API are tabulated below :

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
Callback function name	callback	Callback function for JSONP response format	String

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to send message to a contact group is in the below format :

STATUS	MESSAGE
A420	Group name/id missing
A421	Group is empty/Invalid group
A422	Invalid mobile number
A423	Group name/number missing
A424	Group Name does not exist!
A425	Number does not Exist

Delete Schedule

The URL for deleting an SMS slot that is scheduled is in the following format:

In order to delete a scheduled slot,there should a minimum gap of 15mins before its execution

https://www.mysmsapp.in/api/push.json? method=sms.schedule&api_key=Ad9e5XXXXXXXXXXXXX&groupid=121&format=xml

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms.schedule
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
group ID	groupid	group id that has to be deleted	group id that has to be deleted

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <message>
    Campaign cancelled successfully and credits are refunded.
  </message>  
</api>

JSON

{
    "status": "OK",
    "message": "Campaign cancelled successfully and credits are refunded."
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [message] => Campaign cancelled successfully and credits are refunded.
)

ERROR RESPONSE

{
    "status":"A432",
    "message":"Campaign already cancelled"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.

API Error Codes

The common error codes received while using the API to delete an SMS schedule is in the below format :

STATUS	MESSAGE
A431	Invalid Group ID
A434	Campaign within next 5 minutes cannot be modified/canceled.

Edit Schedule

The URL for editing an SMS slot that is scheduled is in the following format:

In order to edit a scheduled slot,there should a minimum gap of 5mins before its execution

https://www.mysmsapp.in/api/push.json? method=sms.schedule&api_key=Ad9e5XXXXXXXXXXXXX&groupid=121&format=xml&task=modify&time=24 dec 2014 9:00pm

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <message>
    Campaign updated successfully
  </message>  
</api>

JSON

{
    "status": "OK",
    "message": "Campaign updated successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [message] => Campaign updated successfully.
)

ERROR RESPONSE

{
    "status":"A431",
    "message":"Invalid Group ID"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.

API Error Codes

The common error codes received while using the API to Edit an SMS schedule is in the below format :

STATUS	MESSAGE
A431	Invalid Group ID
A434	Campaign within next 5 minutes cannot be modified/canceled.

Credits Availability Check

The URL for checking the credits in your account is in the following format:

https://www.mysmsapp.in/api/creditstatus?apikey=<apikey>

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  </message>
  <data>
    <credits>2758</credits>
  </data>
</api>

JSON

{
    "status": "OK",
    "message": "",
    "data": 
    {
      "credits": "2758"
    }
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [message] => 
    [data] => Array
        (
            [credits] => 2758
        )
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data
credits	Displays the credits available in the account

Checking SMS Status -PULL

The URL for checking the credits in your account is in the following format:

https://www.mysmsapp.in/api/creditstatus?apikey=<apikey>

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
message id	id	Message ID, comma separated	message id of messages sent in the last 3 days

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
service provider and location flag	number info	Flag to query service provider and location data	1 or 0

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <message>Processed Successfully</message>
  <data>
    <sms>
      <id>165-1</id>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
      <senttime>2014-09-01 04:05:06</senttime>
      <dlrtime>2014-09-01 04:05:18</dlrtime>
      </custom>   
      </custom1>
      </custom2>
      <provider>BSNL</provider>
      <location>JAMMU AND KASHMIR</location>
    </sms>
  </data>
</api>

JSON

{
    "status": "OK",
    "message": "Processed successfully",
    "data": 
            [{
                "id": "2758-1",
                "mobile": "9190********",
                "status": "AWAITED-DLR",
                "senttime":"2014-09-01 04:05:06",
                "dlrtime":"2014-09-01 04:05:18",
                "custom":"",
                "custom1": "",
                "custom2": "",
                "provider": "BSNL",
                "location": "JAMMU AND KASHMIR"
            }]
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [message] => Processed Successfully
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 2758-6
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                    [senttime] => 2014-09-01 04:05:06
                    [dlrtime] => 2014-09-01 04:05:18
                    [custom] => 
                    [custom1] => 
                    [custom2] => 
                    [provider] => BSNL
                    [location] => JAMMU AND KASHMIR
                
                )
        )
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
custom1	Custom message id 1 if you provide one
custom2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message
custom	Custom message id if you provide one
senttime	message sent time
dlrtime	message delivered time
provider	provider of the mobile numer
location	Registered location of the mobile number

API Error Codes

The common error codes received while using the API to check sms status is in the below format :

STATUS	MESSAGE
A419	Invalid Group ID/Campaign

Checking Group Status -PULL

The URL for checking group status is in the following format:

https://www.mysmsapp.in/api/push.json?method=sms.groupstatus&api_key=Ad9e5XXXXXXXXXXXXX&format=json&groupid=2191&numberinfo=1

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
group id	groupid	Custom group ID by customer, comma separated	group id of campaign sent in the last 3 days

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	forma	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
service provider and location flag	numberinfo	Flag to query service provider and location data	1 or 0

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <message>Processed Successfully</message>
  <data>
    <sms>
      <id>165-1</id>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
      <senttime>2014-09-01 04:05:06</senttime>
      <dlrtime>2014-09-01 04:05:18</dlrtime>
      </custom>   
      </custom1>
      </custom2>
      <provider>BSNL</provider>
      <location>JAMMU AND KASHMIR</location>
    </sms>
    <sms>
      <id>165-2</id>
      <mobile>9195********</mobile>
      <status>AWAITED-DLR</status>
      <senttime>2014-09-01 04:05:06</senttime>
      <dlrtime>2014-09-01 04:05:18</dlrtime>
      </custom>   
      </custom1>
      </custom2>
      <provider>BSNL</provider>
      <location>BANGALORE</location>
    </sms>
  </data>
</api>

JSON

{
    "status": "OK",
    "message": "Processed successfully",
    "data": 
            [{
                "id": "2758-1",
                "mobile": "9190********",
                "status": "AWAITED-DLR",
                "senttime":"2014-09-01 04:05:06",
                "dlrtime":"2014-09-01 04:05:18",
                "custom":"",
                "custom1": "",
                "custom2": "",
                "provider": "BSNL",
                "location": "JAMMU AND KASHMIR"
            },
            {
                 "id":"2758-2",
                 "mobile":"99XXXXXXXX",
                 "status":"UNDELIV",
                 "senttime":"2014-09-01 04:05:06",
                 "dlrtime":"2014-09-01 04:05:18",
                 "custom":"",
                 "custom1":NULL,
                 "custom2":NULL,
                 "provider":"BSNL",
                 "location":"BANGALORE"     
            }]
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [message] => Processed Successfully
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 2758-6
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                    [senttime] => 2014-09-01 04:05:06
                    [dlrtime] => 2014-09-01 04:05:18
                    [custom] => 
                    [custom1] => 
                    [custom2] => 
                    [provider] => BSNL
                    [location] => JAMMU AND KASHMIR
                
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                    [senttime] => 2014-09-01 04:05:06
                    [dlrtime] => 2014-09-01 04:05:18
                    [custom] => 
                    [custom1] => 
                    [custom2] => 
                    [provider] => BSNL
                    [location] => JAMMU AND KASHMIR
                
                )
        )
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to check group status is in the below format :

STATUS	MESSAGE
A419	Invalid Group ID/Campaign

Checking SMS Status -PUSH

The URL for pushing the status of an SMS is in the following format:

https://www.mysmsapp.in/api/push.json?method=sms&api_key=Ad9e5XXXXXXXXXXXXX&to=997XXXXXXX&sender=INFXXX&message=testing&format=json&custom=1&custom1=11&custom2=22&dlrurl=DLRURL

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	sender	Sender ID assigned to your account	Sender ID
Mobile number	to	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)
Message	message	Message to be sent	Message text which is URL encoded(1000 char for normal, 500 for unicode)
message id	custom	message id provided for Sms	message id provided for Sms
delivery reports URL	dlrurl	The URL to receive delivery reports. Spiffing custom is mandatory.	delivery reports URL

Optional Parameters

Value within the dlrurl should always be url encoded

http://mysmsapp.in/dlr/trigger.php?sent={sent}&delivered={delivered}&custom={custom}&sid={sid}&status={status}&reference={reference}&custom1={custom1}&custom2={custom2}

Response as seen in DLR URL

2015-07-13 13:50:58 54.254.218.30
{“sent”:”2015-07-13 19:20:46″,”delivered”:”2015-07-13 19:20:57″,”custom”:”1″,”sid”:”1406368098-1″ ,”status”:”DELIVRD”,”reference”:”1″,”custom1″:”11″, “custom2″:”22″,”msgid”:”1″}

Custom Flags in DLRURL

We have few custom flags supported in DLR URL in order to get the additional values. In case one wants to build the URL in above format, the following flags can be used.

Name	Parameter
{custom} (alias-{reference}/{msgid})	Message ID provided by user
{sent}	Sent time in YYYY-MM-DD HH:MM:SS format
{delivered}	Delivered time in YYYY-MM-DD HH:MM:SS format
{status}	SMS status code
{custom1}	Custom Flag 1 associated with the message provided by the user
{custom2}	Custom Flag 2 associated with the message provided by the user
A405	Api secret not found.
A406	Request is not allowed from this ip
A407	Header misconfigured
A408	Api Signature not equal

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
A411	Port number must be numeric
A415	Invalid xml/Invalid Json
A416	Invalid Message ID/Mobile
A417	Invalid Message ID/Mobile
A418	Invalid Group ID/Campaign
A419	Invalid Group ID/Campaign
A430	Invalid Group ID
A431	Invalid Group ID
A432	Campaign already completed/Campaign already cancelled
A433	Schedule time already passed
A434	Campaign within next 5 minutes cannot be modified/canceled.
A434	Invalid schedule time. Minimum 5 min time gap is required.
E601	Missing receipent
E603	Missing message
E602	Missing senderid
E604	Senderid must be less than 14 chars
E605	Invalid Sender or Sender not allowed
E606	Invalid schedule time. Minimum 15 min time gap is required.
E606A	Batch size should be greater or equal to 1000
E606B	Schedule minute should be in multiples of 15. minimum 15 minute
E612	Invalid Template Matched
E607	SMS length is exceeding 1000 characters
E607A	Unable to find gateway to sent sms.
E608	No Valid mobile numbers found
E608A	Your daily usage limit exceeded
E609	An error occured while saving group details
E610	Unable to write to temp files
E611	Unable to process your request. try again
H601	Insufficent credits. Total 1. Required 1 more credits.

SI Lookup

The URL for performing a lookup is in the following format:

https://www.mysmsapp.in/api/push.json? method=hlr&api_key=Ad9e5XXXXXXXXXXXXX&to=997XXXXXXX&format=json

NOTE: 1 credit will be deducted per mobile number

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Mobile number	to	Mobile number along with country prfix to which the SMS is to be sent.Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)

Optional Parameters

The Optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
hlr	Each number will be wrapped inside hlr
onn	Original Network Name
ocn	Original Country Name
ocp	Original Country Prefix
rnn	Roaming Network Name
rnp	Roaming Network Prefix
rcn	Roaming Country Name
rcp	Roaming Country Prefix
pnn	Ported Network Name
pnp	Ported Network Prefix
pcn	Ported Country Name
pcp	Ported Country Prefix
Mccmnc	Mobile country code used in the combination of mobile network code to uniquely identify an operator
Mobile	Mobile number
id	External message ID
credits	Amount charged for the service

API Error Codes

The common error codes received while using the API to perform an SI Lookup is as follows :

STATUS	MESSAGE
A440	Invalid destination numbers

Creating A Txtly

URL to create a Txtly is as follows:

https://www.mysmsapp.in/api/push.json?method=txtly.create&api_key=Ad9e5XXXXXXXXXXXXX&url=https://www.google.co.in&format=json

NOTE: It is mandatory to either provide a url or attachment that has to be compressed to a short link

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Mobile number	to	Mobile number along with country prfix to which the SMS is to be sent.Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)

Optional Parameters

The Optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON
token	token	'http://msg.mn/heel' Here heel is the token. It is unique for each txtly	This can customized word representing your brand/compnay. If not provided a random unique token is generated
Title of the Txtly	title	A significant title to your txtly	If not provided, your txtly will not contain any title
Advanced Analytics Enable?	advanced	advanced analytics gives an option to track who (Recipient mobile numbers) visited the page	1- will enable advanced analytics/0(default) - will disable advanced analytics
Location Track?	track	Location Track gives the city and state details of URL visitor	1- will enable location tracking/0(default) - will disable location tracking
Attachment	attach	media file that requires to be compressed to a short link.	Provide the media file in a CURL request

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <message>Details saved Successfully</message>
  <token>5yx1</token>
  <txtly>http://msg.mn/heel</txtly> 
</api>

JSON

{
    "status": "OK",
    "message": "Details saved Successfully",
    "token": "5yx1",
    "txtly": "http://msg.mn/heel"  
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [message] => Details saved Successfully
    [token] => 5yx1
    [txtly] => http://msg.mn/heel
)

ERROR RESPONSE

{
    "status":"E501",
    "message":"Txtly Already Exists. Please try another one."
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
token	Returns the unique token of that txtly
txtly	compressed url that is ready to use

API Error Codes

The common error codes received while using the API to create a Txtly are as follows :

STATUS	MESSAGE
E500	Please provide url to redirect
E501	Txtly Already Exists. Please try another one.
E502	Please attach a file
E503	Invalid file format. Upload valid file.
E504	File size exceed. Maxmium 50000 Kb.
E505	File upload failed. Please try again.

Deleting A Txtly

URL to delete a Txtly is as follows:

https://www.mysmsapp.in/api/push.json? method=txtly&api_key=Ad9e5XXXXXXXXXXXXX&task=delete&format=json&id=123&app=1

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
task	task	Task to be performed on txtly	delete
id of the txtly	id	id of the txtly	123
Application	app	Application reference	1

Optional Parameters

The Optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <message>Deleted successfully..</message> 
</api>

JSON

{
    "status": "OK",
    "message": "Deleted successfully..", 
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [message] => Deleted successfully..
)

ERROR RESPONSE

{
    "status":"A401A",
    "message":"Method Not Implemented"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.

Txtly Reports Extraction - PULL

URL to Pull logs for all txtly in your account

https://www.mysmsapp.in/api/push.json?method=txtly&api_key=Ad9e5XXXXXXXXXXXXX&app=1&format=xml

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
URL	URL	URL of your SMS Service	URL
Method	method	Predefined method	sms
API/Working key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Mobile number	to	Mobile number along with country prfix to which the SMS is to be sent.Also provide multiple numbers in comma separated format.	Mobile number(GET-10numbers,POST-100numbers)

Optional Parameters

The Optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable	XML/PHP/JSON/JSONP. Default response will be in JSON

Example Responses

JSON

ERROR RESPONSE

JSON

{
    "status": "OK",
    "message": "OK",
    "data":{
        "txtlys":[
            {
            "link_id":"1568",
            "title":"sample txtly",
            "token":"ertr",
            "long_url":"https:\/\/accounts.google.com\/ServiceLogin?service=mail&rm=false",
            "advanced":"0",
            "link_type":"URL",
            "meta_value":"{\"track\":null}",
            "views":"0",
            "last_viewed":"0",
            "status":"1",
            "created":"1445937306",
            "serial":1,
            "short_url":"http:\/\/msg.mn\/ertr"
            },
            {
            .
            .
            .
            }
        ],
        "pagination":{
            "now":25,
            "next":2,
            "page":1,
            "limit":25,
            "limitstart":0,
            "total":42,
            "extra":null
        }
    }
}

ERROR RESPONSE

{
    "status":"A401A",
    "message":"Method Not Implemented"
}

Sending An SMS Using XML API

To send an SMS using XML API, the following format is used:

https://www.mysmsapp.in/api/push.json? method=sms.xml&api_key=Ad9e5XXXXXXXXXXXXX&format=json&xml=<Your XML_data or XML_url>

SMS can be sent using the XML API by posting values to the preceding URL by the POST method or the GET method.

API URL Parameter Specifications

The API URL parameter specifications are described in the following sections.

API URL Parameters

Parameter	Description	Expected Values	Type
URL	URL	URL of your SMS Service	Required
Method	Predefined method	sms.xml	Required
API/Working key	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel	Required
xml	You can provide either urlencoded XML data directly Or url of the XML file	Valid XML document or link of XML document	Required
format	Response format type	XML/PHP/JSON/JSONP. Default response will be in JSON	Optional
callback	Callback function for JSONP response format	Javascript function name standards	Optional

XML Tag Parameters

Note: If message,sender and dlrurl is specified within both SMS tag and XML tag, the former overrides the later.

Parameter	Description	Expected Values	Type
xml version="1.0" encoding="UTF-8"	XML Header	Version and Encoding	Required
api	Document Root	Document Root	Required
time	Global schedule time	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM	Optional
unicode	To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.	1/0/auto	Optional
flash	Global node for flash	1/0	Optional
sender	Sender ID assigned to your account	Sender ID	Required
message	Message to be sent. In case of any special characters in your message, enclose it within CDATA as in the example	Message text	Required
dlrurl	The URL to receive delivery reports.Spiffing reference id is mandatory	EX: http://www.example.com/dlr.php	Optional
campaign	Global campaign name tag	campaign name	Optional
sms	SMS Node(can repeat)	SMS Node	Required
to	Mobile number in sms node	Comma seperated 10 digit mobile numbers	Required
custom	Message ID for sms	comma seperated message ID's	Optional
custom1	Custom reference 1 (comma separate)	comma seperated custom 1 references	Optional
custom2	Custom reference 2 (comma separate)	omma seperated custom 2 references	Optional

Example Request

PHP

<?php
// STEP 1 : Prepare XML data
   $xmldata =  '<?xml version="1.0" encoding="UTF-8"?>
                <api>
                    <campaign>campaign</campaign>
                    <dlrurl>Delivery Url</dlrurl>
                    <time>2014-12-26 04:00pm</time>
                    <unicode>0</unicode>
                    <flash>0</flash>
                    <sender>senderid</sender>
                    <message><![CDATA[smstext]]></message>
                        <sms>
                            <to>9190********</to>
                        </sms>
                        <sms>
                            <to>9190********</to>
                        </sms>
                </api>';

// STEP 2 : Build the url with xml data - POST
    $api_url ='https://www.mysmsapp.in/api/push.json?method=sms.xml&api_key=Ad9e5XXXXXXXXXXXXX&format=xml&xml='
    .urlencode($xmldata);

// OR : Build the url with xml url - GET
    $url = 'Your xml data Url';
    $api_url ='https://www.mysmsapp.in/api/push.json?method=sms.xml&api_key=Ad9e5XXXXXXXXXXXXX&format=xml&xml='
    .urlencode($url);
    
NOTE : For better performance and large data use POST Method

//STEP 3 : Put the request to server 
    $response = file_get_contents($api_url);

// check the response and verify
    print_r($response);
?>

Sample Data

Sending to multiple numbers with different message

SAMPLE DATE1

SAMPLE DATE2

SAMPLE DATE1

<?xml version="1.0" encoding="UTF-8"?>
<api>
<campaign>campaign</campaign>
<dlrurl>Delivery Url</dlrurl>
<time>2014-12-26 04:00pm</time>
<unicode>0</unicode>
<flash>0</flash>
<sender>senderid</sender>
<message><![CDATA[smstext]]></message>
<sms>
    <to>9190********</to>
</sms>
<sms>
    <to>9191********</to>
</sms>
</api>

SAMPLE DATE2

<?xml version="1.0" encoding="UTF-8"?>
<api>
<campaign>campaign</campaign>
<time>2014-12-26 04:00pm</time>
<unicode>0</unicode>
<flash>0</flash>
<sms>
    <to>9190********</to>
    <sender>senderid</sender>
    <message>smstext</message>
    <custom>2</custom>
    <dlrurl>Delivery Url 1</dlrurl>
</sms>
<sms>
    <to>9191********</to>
    <sender>senderid</sender>
    <message><![CDATA[smstext]]></message>
    <custom>2</custom>
    <dlrurl>Delivery Url 2</dlrurl>
</sms>
</api>

NOTE: In case of special characters in the content within any of the XML tags , enclose it within CDATA as in the example

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
A411	Port number must be numeric
A415	Invalid xml/Invalid Json
A416	Invalid Message ID/Mobile
A417	Invalid Message ID/Mobile
A418	Invalid Group ID/Campaign
A419	Invalid Group ID/Campaign
A430	Invalid Group ID
A431	Invalid Group ID
A432	Campaign already completed/Campaign already cancelled
A433	Schedule time already passed
A434	Campaign within next 5 minutes cannot be modified/canceled.
A434	Invalid schedule time. Minimum 5 min time gap is required.
E601	Missing receipent
E603	Missing message
E602	Missing senderid
E604	Senderid must be less than 14 chars
E605	Invalid Sender or Sender not allowed
E606	Invalid schedule time. Minimum 15 min time gap is required.
E606A	Invalid schedule time. Minimum 15 min time gap is required.
E606A	Batch size should be greater or equal to 1000
E606B	Schedule minute should be in multiples of 15. minimum 15 minute
E612	Invalid Template Matched
E607	SMS length is exceeding 1000 characters
E607A	Unable to find gateway to sent sms.
E608	No Valid mobile numbers found
E608A	Your daily usage limit exceeded
E609	An error occured while saving group details
E610	Unable to write to temp files
E611	Unable to process your request. try again
H601	Insufficent credits. Total 1. Required 1 more credits.

Sending An SMS Using JSON API

To send an SMS using JSON API, the following format is used:

https://www.mysmsapp.in/api/push.json? method=sms.json&api_key=Ad9e5XXXXXXXXXXXXX&format=xml&json=<Your JSON_data or JSON_url

SMS can be sent using the JSON API by posting values to the preceding URL by the POST method or the GET method.

API URL Parameter Specifications

The API URL parameter specifications are described in the following sections.

API URL Parameters

Parameter	Description	Expected Values	Type
URL	URL	URL of your SMS Service	Required
Method	Predefined method	sms.xml	Required
API/Working key	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel	Required
xml	You can provide either urlencoded XML data directly Or url of the XML file	Valid XML document or link of XML document	Required
format	Response format type	XML/PHP/JSON/JSONP. Default response will be in JSON	Optional
callback	Callback function for JSONP response format	Javascript function name standards	Optional

JSON Tag Parameters

Note: If message,sender and dlrurl is specified within both SMS tag and JSON tag, the former overrides the later.

Parameter	Description	Expected Values	Type
xml version="1.0" encoding="UTF-8"	XML Header	Version and Encoding	Required
api	Document Root	Document Root	Required
time	Global schedule time	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM	Optional
unicode	To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.	1/0/auto	Optional
flash	Global node for flash	1/0	Optional
sender	Sender ID assigned to your account	Sender ID	Required
message	Message to be sent. In case of any special characters in your message, enclose it within CDATA as in the example	Message text	Required
dlrurl	The URL to receive delivery reports.Spiffing reference id is mandatory	EX: http://www.example.com/dlr.php	Optional
campaign	Global campaign name tag	campaign name	Optional
sms	SMS Node(can repeat)	SMS Node	Required
to	Mobile number in sms node	Comma seperated 10 digit mobile numbers	Required
custom	Message ID for sms	comma seperated message ID's	Optional
custom1	Custom reference 1 (comma separate)	comma seperated custom 1 references	Optional
custom2	Custom reference 2 (comma separate)	omma seperated custom 2 references	Optional

Example Request

PHP

<?php
// STEP 1 : Prepare XML data
   $xmldata =  '<?xml version="1.0" encoding="UTF-8"?>
                <api>
                    <campaign>campaign</campaign>
                    <dlrurl>Delivery Url</dlrurl>
                    <time>2014-12-26 04:00pm</time>
                    <unicode>0</unicode>
                    <flash>0</flash>
                    <sender>senderid</sender>
                    <message><![CDATA[smstext]]></message>
                        <sms>
                            <to>9190********</to>
                        </sms>
                        <sms>
                            <to>9190********</to>
                        </sms>
                </api>';

// STEP 2 : Build the url with xml data - POST
    $api_url ='https://www.mysmsapp.in/api/push.json?method=sms.xml&api_key=Ad9e5XXXXXXXXXXXXX&format=xml&xml='
    .urlencode($xmldata);

// OR : Build the url with xml url - GET
    $url = 'Your xml data Url';
    $api_url ='https://www.mysmsapp.in/api/push.json?method=sms.xml&api_key=Ad9e5XXXXXXXXXXXXX&format=xml&xml='
    .urlencode($url);
    
NOTE : For better performance and large data use POST Method

//STEP 3 : Put the request to server 
    $response = file_get_contents($api_url);

// check the response and verify
    print_r($response);
?>

Sample Data

Sending to multiple numbers with same message

SAMPLE DATE1

SAMPLE DATE2

SAMPLE DATE1

<?xml version="1.0" encoding="UTF-8"?>
<api>
<campaign>campaign</campaign>
<dlrurl>Delivery Url</dlrurl>
<time>2014-12-26 04:00pm</time>
<unicode>0</unicode>
<flash>0</flash>
<sender>senderid</sender>
<message><![CDATA[smstext]]></message>
<sms>
    <to>9190********</to>
</sms>
<sms>
    <to>9191********</to>
</sms>
</api>

SAMPLE DATE2

<?xml version="1.0" encoding="UTF-8"?>
<api>
<campaign>campaign</campaign>
<time>2014-12-26 04:00pm</time>
<unicode>0</unicode>
<flash>0</flash>
<sms>
    <to>9190********</to>
    <sender>senderid</sender>
    <message>smstext</message>
    <custom>2</custom>
    <dlrurl>Delivery Url 1</dlrurl>
</sms>
<sms>
    <to>9191********</to>
    <sender>senderid</sender>
    <message><![CDATA[smstext]]></message>
    <custom>2</custom>
    <dlrurl>Delivery Url 2</dlrurl>
</sms>
</api>

NOTE: In case of special characters in the content within any of the XML tags , enclose it within CDATA as in the example

Example Responses

XML

JSON

PHP

ERROR RESPONSE

XML

<api>
  <status>OK</status>
  <data>
    <group_id>2758</group_id>
    <sms>
      <id>2758-1</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
    <sms>
      <id>2758-2</id>
      <customid>1</customid>
      </customid1>
      </customid2>
      <mobile>9190********</mobile>
      <status>AWAITED-DLR</status>
    </sms>
      ...
  </data>
  <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

JSON

{
    "status": "OK",
    "data": 
    {
        "group_id":2758,
        "0":
        {
            "id": "2758-1",
            "customid": "1",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        },
        "1":
        {
            "id": "2758-2",
            "customid": "2",
            "customid1": "",
            "customid2": "",
            "mobile": "9190********",
            "status": "AWAITED-DLR",
        }
            ...
    }
    "message": "Campaign Submitted successfully"
}

PHP

NOTE : Output Obtained After print_r(unserialize($response))
Array
(
    [status] => OK
    [data] => Array
        (
            [group_id] => 2758
            [0] => Array
                (
                    [id] => 2758-6
                    [customid] => 1
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )
            [1] => Array
                (
                    [id] => 2758-7
                    [customid] => 2
                    [customid1] => 
                    [customid2] => 
                    [mobile] => 9190********
                    [status] => AWAITED-DLR
                )                    
             ...
        )
    [message] => Campaign Submitted successfully
)

ERROR RESPONSE

{
    "status":"A404",
    "message":"Your api account got suspended"
}

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
group_id	Website group id for your reference
data	All the response is wrapped in side data
sms	Each number will be wrapped inside sms
id	Website message id for your reference
customid	Custom message id if you provide one
customid1	Custom message id 1 if you provide one
customid2	Custom message id 2 if you provide one
mobile	Mobile number the sms will be sent
status	status of the message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
A411	Port number must be numeric
A415	Invalid xml/Invalid Json
A416	Invalid Message ID/Mobile
A417	Invalid Message ID/Mobile
A418	Invalid Group ID/Campaign
A419	Invalid Group ID/Campaign
A430	Invalid Group ID
A431	Invalid Group ID
A432	Campaign already completed/Campaign already cancelled
A433	Schedule time already passed
A434	Campaign within next 5 minutes cannot be modified/canceled.
A434	Invalid schedule time. Minimum 5 min time gap is required.
E601	Missing receipent
E603	Missing message
E602	Missing senderid
E604	Senderid must be less than 14 chars
E605	Invalid Sender or Sender not allowed
E606	Invalid schedule time. Minimum 15 min time gap is required.
E606A	Invalid schedule time. Minimum 15 min time gap is required.
E606A	Batch size should be greater or equal to 1000
E606B	Schedule minute should be in multiples of 15. minimum 15 minute
E612	Invalid Template Matched
E607	SMS length is exceeding 1000 characters
E607A	Unable to find gateway to sent sms.
E608	No Valid mobile numbers found
E608A	Your daily usage limit exceeded
E609	An error occured while saving group details
E610	Unable to write to temp files
E611	Unable to process your request. try again
H601	Insufficent credits. Total 1. Required 1 more credits.

Developers Guide

PHP

JAVA

PHP

<?php 
include 'sendsms.php';
$sendsms=new sendsms("https://www.mysmsapp.in/api/push.json?",'sms'
                      , "11XXXXXXXXXXX78", "SIXXXX");
$sendsms->send_sms("99XXXXXXXX", "message", 'http://www.yourdomainname.domain/yourdlrpage&custom=XX', 'xml');
$sendsms->schedule_sms("99XXXXXXXX", "message"
                     , "http://www.yourdomainname.domain/yourdlrpage&custom=XX", 'xml',
                      'YYYY-MM-DD HH:MM PM/AM');
$sendsms->unicode_sms("99XXXXXXXX","unicode message",
                      "http://www.yourdomainname.domain/yourdlrpage&custom=XX",'xml','1');
$sendsms->messagedelivery_status("99XXXXXX-X");
$sendsms->groupdelivery_status("99XXXXXX");
//$sendsms->setWorkingKey("1i6xxxxxxxxxxxxxx");
//$sendsms->setSenderId("BUxxxx");
//$sendsms->setapiurl("https://www.mysmsapp.in/api/push.json?");
?>  
Note  : Download the source code from here.  Download source code
Step 1: Extract the downloaded file
Step 2: Copy the above sample code and save it with extension .php (say trigger.php) in 
        extracted folder
Step 3: Now call trigger.php

JAVA

package com.si.api;
public class call
    {
    public static void main(String[] args) throws Exception
        {
        send_sms smsObj = new send_sms();
        smsObj.setparams("URL","method","1ixxxxxxxxxxxxxx","BUxxxx");
        smsObj.send_sms("99xxxxxxxx", "message", "http://www.yourdomainname.domain/yourdlrpage&custom=XX");
        smsObj.schedule_sms("99xxxxxxxx", "message", "http://www.yourdomainname.domain/yourdlrpage&custom=XX", 
                            "YYYY-MM-DD HH:MM:SS");
        smsObj.unicode_sms("99xxxxxxxx", "message", "http://www.yourdomainname.domain/yourdlrpage&custom=XX","1");
        smsObj.messagedelivery_status("1xxx-x");
        smsObj.groupdelivery_status("1xxx");
        //smsObj.setsender_id("txxxxx");
        //smsObj.setworking_key("1ixxxxxxxxxxxxxx");
        //smsObj.setapi_url("URL");
        }
    }
Note  : Download the source code from here.  Download source code
Step 1: Extract the downloaded file
Step 2: Copy the above sample code and save it with extension .java (say call.java) in 
        extracted folder
Step 3: Now call call.java