Heullo, Developers
API Guide
Heullo API Guide is the technical guideline for developers which include SMS Gateway HTTP API for sending messages. It consists of various programming methods and commands for using current API.
The HTTP API is the most popular API, because there are many ways to utilize it for low or high-volume message sending. As HTTP is a means for relaying information, the HTTP API can be used with practically any web-service application. This is particularly useful for high-volume message sending.
When you sign up for an HTTP account, you will be given a username, password and API-id: keep these at hand. Once you have registered and been activated you will receive 10 free credits with which to test our service. Messages sent with these credits contain a pre-populated SMS Gateway message. You can test the API using these credits, and purchase credits to start sending your own, customized messages.
This document is dedicated for users who wish to use https://sms.heullo.com gateway for sending SMS messages. This gateway can be accessed by HTTP protocol by submitting values to the HTTP API Server by the GET/POST Method.
Accessing gateway through HTTP protocol is one of the best and the fastest ways to deliver SMS Messages. This https://sms.heullo.com’s gateway can be used to send various types of SMS Messages including normal text messages, Unicode messages and flash messages. This document gives a detailed explanation of using the gateway through HTTP protocol.
Introduction
In order to use the https://sms.heullo.com SMS Gateway you need a SMS account and at least one registered connection (API sub-product instance) between your application and our gateway. Each connection method is known as a sub-product (of our API product). You can follow these steps to get started:
1.1 Step 1 – Register for Account:
If you do not already have a Developers’ Central account, you need to register for one. If you already have a user account, proceed to Step 2 for instructions on how to edit an API connection on your account.
https://sms.heullo.com/WebSMS/Signup.aspx
Enter your personal information to complete the registration form
Accept Terms & Conditions
Click the ‘Create my Account’ button – an email containing your login details will be sent to the email address you have provided.
1.2 Step 2 – Activating your Account:
When you have logged in you will be on the https://sms.heullo.com landing page. You will receive 10 free credits which you can use to test the Heullo SMS Gateway. Please note that for security reasons these 10 credits contain pre-set SMS content.
A HTTP API will be added to your account for you. This will allow you to start testing the SMS Gateway immediately. You can purchase credits when you are ready to start sending personalized messages.
Send Message
2.1 Sending a Single Message:
To send a single message of any type (normal text messages, Unicode messages and flash messages), the gateway requires parameters like user and password (as described in the table above) for authentication purpose.
If you are not using a Static IP option, the following URL, along with the required parameters, needs to be accessed –
https://sms.heullo.com/Websms/sendsms.aspx?User=xxxxxx&passwd=xxxxxxxxxxxx&mobilenumber=xxxxxxxxxx&message=xxxxxxxxx&senderid=xxxxxxxx&type=0
Heullo single SMS sending limits:
You can send up to 100 mobile numbers at a time with a daily limit of 500 SMS. The SMS time validity is set 2 hrs-which means we will try to deliver the SMS within 2 hrs.
To keep our systems healthy and your accounts safe, Heullo limits the amount of SMS one user can send. Limits restrict the number of messages sent per day and the number of recipients per message. After reaching one of these limits, a user can’t send new messages for up to 24 hours, but they can still access their account.
These limits may change without notice to protect Heullo’s infrastructure. Limits per day are applied over a rolling 24-hour period rather than a set time of day.
2.2 Illustrative Example for Sending Single SMS:
2.2.1 SMS containing normal text message
https://sms.heullo.com/websms/sendsms.aspx?User=wworks&passwd=5hdshj3&mobilenumber=9198356272,91944362623,91985352323&message=testinghttps://sms.heullo.com&senderid=wworks&type=0
2.2.2 SMS containing Unicode message (UCS-2)
This is basically used to support languages with characters not included in default GSM 7-bit character set that should be converted in to hexadecimal number.
For sending a message in Arabic
https://sms.heullo.com/Websms/sendsms.aspx?User=wworks&passwd=5hdshj3&mobilenumber=9198356272&message=062A06450020062A0633062C064A06440643002006280646062C0627062D00200641064A0020062E062F0645062900200631063306270626064400200627064406470627062A064100&type=2
2.3 Bulk Messaging:
For sending Bulk SMS messages, the following URL, along with the required parameters, needs to be accessed –
https://sms.heullo.com/WebSMS/SendBulkSMS.aspx?user=xxxx&passwd=xxxx&ContactGroups=xxx&senderid=xx&message=xxxx&type=0
Parameters for Send Messages
3 Parameters Definition for Send Messages:
3.1 Username: user
When you sign up at https://sms.heullo.com, you will choose your username at the time of account creation. The user parameter cannot be more than 20 characters long and can only contain alphabets and numbers, with no blank spaces or special characters.
3.2 Password: password
When you sign up at https://sms.heullo.com, you will choose your password at the time of account creation. The password parameter cannot be more than 20 characters long and can only contain alphabets and numbers, with no blank spaces or special characters.
3.3 Sender-Id / Name of Sender: sundered
The Sender-Id refers to the Alphanumeric Identity of the Sender. Only GSM technology supports an alphanumeric sender-id (maximum 11 characters only). The others like CDMA support only a numeric sender-id (maximum 15 characters only).
3.4 Mobile Number: mobile number
This parameter refers to the destination mobile number(s) to which the message is to be sent. It must include the country code appended before the mobile number (e.g. 44798xxxxxxx, 4478xxxxxxxx, 6591xxxxx). Any error in this parameter value would lead to non-delivery of the message. The mobile number should contain only numbers and no symbols like “+”, “-” etc.
3.5 Send Later: – sendlater
(Optional Parameter) sendlater parameter is used to send scheduled message, if parameter provided then valid Date time should be provided in the format “yyyy-MM-dd hh:mm”. The date and time will be considered in your time zone which you set in your profile.
3.6 Message: message
The message parameter refers to the actual message that is to be sent to the destination mobile number. The format of the message differs depending on the type of message being sent.
For simple text messages, the message can contain numbers, alphabets, spaces and certain special characters. The message can contain a maximum of 160 characters, including spaces.
In case of Unicode messaging, the message can contain only numbers in the form of Unicode digits. Further, it can have a maximum of 70 characters i.e. 70 x 4 Unicode digits for each character that means 280 digits.
In case of sending GREEK capital letters by using MESSAGE TYPE = 8 the message can contain a maximum of 160 characters, including spaces.
In case of binary messaging, the message can contain only valid 8-bit data string. The binary message can be a maximum of 140 characters only for each SMS.
Due to restrictions in the HTTP protocol format; the following special characters must be encoded, as shown below, to avoid collision with reserved HTTP characters.
S.NO CHARACTER HEXA-DECIMAL ENCODED STRING
1. & %26
2. + %2B
3. % %25
4. # %23
5. = %3D
3.7 Message Type: type
Message Type is to identify the type of message being sent. The default value of message type is 0, which refers to Normal text message. https://sms.heullo.com Gateway classifies the type of messages to be sent on the basis of this parameter and pushes them accordingly.
TYPE DESCRIPTION
0 Normal text message
1 Flash message
2 Unicode message
8 Greek CAPITAL letters
3.8 Contacts Group: Contact Groups
Contacts’ group is group of contacts which you want to send the bulk sms, contact group created by user like (working Group) in which save the multiple contacts are grouped, when select contacts group in sending bulk sms, message send to all contacts in the group.
3.9 Error Codes:
1701:Success, Message Submitted Successfully, In this case you will receive the response
1701||, the message Id can then be used later to map the delivery reports to this message.
1702: Invalid URL Error, This means that one of the parameters was not provided or left blank
1703: Invalid value in username or password field
1704: Invalid value in “type” field
1705: Invalid Message
1706: Invalid Destination
1707: Invalid Source (Sender)
1708: Invalid value for “dlr” field
1709: User validation failed
1710: Internal Error
1025: Insufficient Credit
Note:
_ Along with the above errors codes, standard SMPP v3.4 error codes may also be returned where applicable.
_ Apart from 1709, please DO NOT RETRY re-sending the message for
Any other error code (including SMPP v3.4 Error codes).
Bulk SMS API Reply Format:
||,||…
Exceptional Situation:
A request containing multiple destinations will be aborted immediately if any error other than “Invalid Destination” is found, in case an invalid destination is found we just skip that destination and proceed to the next destination. If while processing the request the SMPP Server goes down, the HTTP API will retry a fixed number (with a gap of ten milliseconds between consecutive retries) of times to reconnect to the SMPP server and submit the message. In case the SMPP server does not come up before the fixed number of attempts are exhausted, the batch will be aborted at that destination and a message will be returned in following format:||,||,1709|
The third and final situation which can arise is the the credits can get exhausted in the middle of a request being serviced. In case such a situation occurs we will be aborting the batch on the destination at which we got the “Insufficient_Credit” error, and a response in the following format will be returned to the client: ||,||,1025|
Delivery Receipt
During account set-up, you will be asked to supply Heullo a CallBack URL for Delivery Receipt to which we will send a delivery receipt for each of your SMS submissions. This will confirm whether your message reached the recipient’s handset. The request parameters are sent via a GET (default) to your Callback URL and Heullo will be expecting response “OK” (just the word OK), or it will keep retrying (if Ok it will stop) until the Receipt expires (up to 24 hour).
http:/www.yoururl.com/callback
The Delivery reports will be send by the system with source IP address 216.144.236.86. This IP should be whitelisted on your side.
The following parameters will be returned:
TYPE DESCRIPTION
UID Unique Identifier return by API Response at the time of submission
Mobile Mobile Number where message sent
Status The status of delivery DELIVERED,UNKNOWN,EXPIRED,DELETED,UNDELIV,REJECTD,
ENROUTE,ACKED
Inbox Receipt
During account set-up, you will be asked to supply Heullo a CallBack URL for Inbox Receipt to which you will receive a delivery receipt for each inbound SMS. The request parameters are sent via a GET (default) to your Callback URL and Heullo will be expecting response “OK” (just the word OK), or it will keep retrying (if Ok it will stop) until the Receipt expires (up to 24 hour).
http:/www.yoururl.com/callback
The Delivery reports will be send by the system with source IP address 216.144.236.86. This IP should be whitelisted on your side.
The following parameters will be returned:
From Sender mobile number
ReceiveDate Date
ReceiveTime Time
Message SMS Message
Reports
6.1 Delivery Reports:
If an SMS message is sent using https://sms.heullo.com API, the message delivery report will be sent to the user registered URL (the URL user has registered in his/her account) with the attached parameters shown in following table.
S.NO Parameter Description
1. UID A unique ID which is sent after successful submission of message
2. Mobile Destination mobile number
3. Status a) (1) (PENDING)
b) (2) (SENT)
c) (3) (FAILED)
d) (4) (DELIVERED)
e) (5) (SCHEDULED)
f) (6) (UNKNOWN)
g) (7) (EXPIRED)
h) (8) (DELETED)
i) (9) (UNDELIVERED)
j) (10) (REJECTED)
k) (11) (ENROUTE)
l) (12) (ACKED)
(Note: https://sms.heullo.com will try to fetch delivery report for three times (if delivery report fetch failed) with 15 minutes interval in each attempt. After that https://sms.heullo.com will not send the delivery report.)
Contacts
7.1 Add Example Contact:
Add Contact.ashx
URL https://sms.heullo.com/websms/mobile/apis/addcontact.ashx
Description Add a contact for a specific user under a specified group and country.
Parameters user, userid, groupid, contactname, mobile, countryid, countrycode
Status Success : 1
Error : 2
Validation Failed : 3
Required Parameter Missing : 4
Empty Parameter Value : 5
Record Not Found : 6
Invalid Parameter Value : 7
Invalid Mobile Number : 8
Mobile Number Already Exist In Group : 9
Country Validation Failed : 10
Group Validation Failed : 11
No Country Exits To Add Contact : 12
Example Request https://sms.heullo.com/websms/mobile/apis/addcontact.ashx?user=test&userid=1&groupid=1&contactname=test%20contact&mobile=6110050000&countryid=15&countrycode=61
Example Response {“Description”:”success”,”status”:1}
7.2 Edit Contact:
Edit Contact.ashx
URL https://sms.heullo.com/websms/mobile/apis/editcontact.ashx
Description Edit a specific contact for a specified user.
Parameters user, userid, contactid, contactname, mobile
Status Success : 1
Error : 2
Validation Failed : 3
Required Parameter Missing : 4
Empty Parameter Value : 5
Record Not Found : 6
Invalid Parameter Value : 7
Invalid Mobile Number : 8
Mobile Number Already Exist In Group : 9
Country Validation Failed : 10
Group Validation Failed : 11
No Country Exits To Add Contact : 12
Example Request https://sms.heullo.com/websms/mobile/apis/editcontact.ashx?user=test&userid=1&contactid=1&contactname=test&mobile=61500000000
Example Response {“Description”:”success”,”status”:1}
7.3 Delete Contact:
DeleteContact.ashx
URL https://sms.heullo.com/websms/mobile/apis/deletecontact.ashx
Description Delete a specific contact for a specified user.
Parameters user, userid, contactid
Status Success : 1
Error : 2
Validation Failed : 3
Required Parameter Missing : 4
Empty Parameter Value : 5
Record Not Found : 6
Invalid Parameter Value : 7
Invalid Mobile Number : 8
Mobile Number Already Exist In Group : 9
Country Validation Failed : 10
Group Validation Failed : 11
No Country Exits To Add Contact : 12
Example Request https://sms.heullo.com/websms/mobile/apis/deletecontact.ashx?user=test&userid=1&contactid=1
Example Response {“Description”:”success”,”status”:1}
User
12.1 Get Login:
getLogin.ashx
URL https://sms.heullo.com/websms/mobile/apis/getlogin.ashx
Description Provide basic account detail for a specific user.
Parameters user, password
Status Success : 1
Error : 2
Validation Failed : 3
Required Parameter Missing : 4
Empty Parameter Value : 5
Example Request https://sms.heullo.com/websms/mobile/apis/getlogin.ashx?user=test&password=testpass
Example Response {“Description”:”Success”,”LoginDetail”:{“CountryID”:”15″,”DynamicSender”:false,”UserID”:”1″},”status”:1}
12.2 Sign Up:
getLogin.ashx
URL https:/sms.heullo.com/websms/mobile/apis/signup.ashx
Description Signup a user with given detail.
Parameters user, firstname, email, countryid, countrycode, countryname, mobile, password, confirmpassword, timezonecode
Status Success : 1
Error : 2
Validation Failed : 3
Required Parameter Missing : 4
Empty Parameter Value : 5
Record Not Found : 6
Invalid Parameter Value : 7
User Name Already In Use : 8
Invalid Email Address : 9
Email Already In Use : 10
Invalid Mobile Number : 11
Mobile Number Already In Use : 12
No Country Exits To Add Contact : 13
Incorrect Password : 14
Invalid Time Zone : 15
Country Validation Failed : 16
TimeZone Validation Failed : 17
Example Request https://sms.heullo.com/websms/mobile/apis/signup.ashx?user=test&firstname=test%20first%20name&email=test@gmail.com&countryid=15&countrycode=61&countryname=test%20country&mobile=61526545652&password=testpass&confirmpassword=testpass&timezonecode=test%20time%20zone%20
Example Response {“Description”:”success”,”status”:1}
12.3 Forgot Password:
ForgotPassword.ashx
URL https://sms.heullo.com/websms/mobile/apis/ForgotPassword.ashx
Description Send password to the register email address against users.
Parameters Email
Status Success = 1,
Error = 2,
Validation Failed = 3,
Required Parameter Missing = 4,
Empty Parameter Value = 5,
Record Not Found = 6,
User Name Already In Use = 7,
Invalid Email Address = 8,
Email Server Settings Not Found = 9,
Email Content Settings Not Found = 10
Example Request https://sms.heullo.com/websms/mobile/apis/ForgotPassword.ashx?Email=abc@live.com
Example Response {“Description”:”Success”,”status”:1}
User profile
8.1 Edit Profile:
EditProfile.ashx
URL https://sms.heullo.com/websms/mobile/apis/editprofile.ashx
Description Edit a specific user profile.
Parameters user, userid, countryid, countrycode, stateid, cityid, mobile, timezonecode
Status Success : 1
Error : 2
Validation Failed : 3
Required Parameter Missing : 4
Empty Parameter Value : 5
Record Not Found : 6
Invalid Parameter Value : 7
User Name Already In Use = 8
Invalid Email Address = 9
Email Already In Use = 10
Invalid Mobile Number = 11
Mobile Number Already In Use = 12
No Country Exits To Add Contact = 13
Incorrect Password = 14
Invalid Time Zone = 15
Country Validation Failed = 16
TimeZone Validation Failed = 17
State Validation Failed = 18
City Validation Failed = 19
Example Request https://sms.heullo.com/websms/mobile/apis/editprofile.ashx?user=test&userid=15&countryid=1&countrycode=61&stateid=1&cityid=1&mobile=6110000000&timezonecode=Tasmania%20Standard%20Time
Example Response {“Description”:”success”,”status”:1}
Fetching Data
9. 1 Get All Countries:
getAllCountries.ashx
URL https://sms.heullo.com/websms/mobile/apis/getallcountries.ashx
Description Lists all the countries available.
Parameters No Parameter
Status Success : 1
Error : 2
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getallcountries.ashx
Example Response {“ClsCountry”:[{“CountryCode”:”93 “,”CountryID”:”5″,”CountryName”:”Afghanistan”},{“CountryCode”:”355 “,”CountryID”:”6″,”CountryName”:”Albania”}],”Description”:”Success”,”status”:1}
9. 2 Get Country Code:
getCountryCode.ashx
URL https://sms.heullo.com/websms/mobile/apis/getcountrycode.ashx
Description Fetch the country code for a specified country.
Parameters countryid
Status Success : 1
Error : 2
Required Parameter Missing : 4
Empty Parameter Value : 5
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getcountrycode.ashx?countryid=15
Example Response {“Description”:”Success”,”countryCode”:”61 “,”status”:1}
9.3 Get Country States:
GetCountryStates.ashx
URL https://sms.heullo.com/websms/mobile/apis/getcountrystates.ashx
Description Lists all states for a specified country.
Parameters countryid
Status Success : 1
Error : 2
Required Parameter Missing : 4
Empty Parameter Value : 5
Example Request https://sms.heullo.com/websms/mobile/apis/getcountrystates.ashx?countryid=15%20
Example Response {“Description”:”Success”,”States”:[{“StateID”:”325″,”StateName”:”Australian Capital Territory”},{“StateID”:”326″,”StateName”:”New South Wales”}],”status”:1}
9.4 Get Country Time Zone:
GetCountryStates.ashx
URL https://sms.heullo.com/websms/mobile/apis/getcountrytimezones.ashx
Description Lists all time zones for a specified country.
Parameters countryid
Status Success : 1
Error : 2
Required Parameter Missing : 4
Empty Parameter Value : 5
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getcountrytimezones.ashx?countryid=15
Example Response {“Description”:”Success”,”TimeZones”:[{“TimeZoneID”:”10235″,”TimeZoneName”:”(UTC+08:00) Perth”},{“TimeZoneID”:”10236″,”TimeZoneName”:”(UTC+09:30) Adelaide”}],”status”:1}
9.5 Get Groups:
getGroups.ashx
URL https://sms.heullo.com/websms/mobile/apis/getgroups.ashx
Description Lists all contact groups for a specific user and also optionally for a specified country.
Parameters user, userid, countryid (optional)
(Note: If countryid is not supplied, then all groups of the specified user will be returned. If countryid is supplied, then all groups of the specified user and country will be returned.)
Status Success : 1
Error : 2
Validation Failed : 3
Required Parameter Missing : 4
Empty Parameter Value : 5
Invalid Parameter Value : 7
Example Request https://sms.heullo.com/websms/mobile/apis/getgroups.ashx?user=test&userid=1&countryid=15%20
Example Response {“Description”:”Success”,”Groups”:[{“GroupContacts”:”0″,”GroupCountryID”:”15″,”GroupCountryName”:”Australia”,”GroupID”:”1″,”GroupName”:”Default”},{“GroupContacts”:”0″,”GroupCountryID”:”15″,”GroupCountryName”:”Australia”,”GroupID”:”26″,”GroupName”:”test”}],”status”:1}
9.6 Get State Cities:
getStateCities.ashx
URL https://sms.heullo.com/websms/mobile/apis/getstatecities.ashx
Description Lists all cities for a specific state.
Parameters stateid
Status Success : 1
Error : 2
Required Parameter Missing : 4
Empty Parameter Value : 5
Example Request https://sms.heullo.com/websms/mobile/apis/getstatecities.ashx?stateid=1
Example Response {“Cities”:[{“CityID”:”1467699″,”CityName”:”\u001bKot Chandi”},{“CityID”:”1467700″,”CityName”:” Mir Khanwala”}],”Description”:”Success”,”status”:1}
9.7 Get API Info:
getAPIInfo.ashx
URL https://sms.heullo.com/websms/mobile/apis/getapiinfo.ashx
Description Fetch information for a specific API.
Parameters apiid
Status Success : 1
Error : 2
Required Parameter Missing : 4
Empty Parameter Value : 5
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getapiinfo.ashx?apiid=123
Example Response {“APIInfo”:{“APIURL”:”My.com/API/URL/API”,”APPName”:”My APP Name”,”CompanyName”:”My Company Name”,”Logo”:”MyLogo.jpg”},”Description”:”Success”,”status”:1}
9.8 Get Contacts:
getContacts.ashx
URL https://sms.heullo.com/websms/mobile/apis/getContacts.ashx
Description Lists all contact for a specific user under a specified group.
Parameters user, userid, groupID
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getContacts.ashx?user=abc&userid=123456&groupID=00
Example Response {“ContactDetails”:[{“CGID”:”15″,”CGName”:”Default”,”ContactMobile”:”923004461058″,”ContactName”:”Moazzam”,”CountryCode”:”92 “,”CountryID”:”156″,”CountryName”:”Pakistan”},{“CGID”:”15″,”CGName”:”Default”,”ContactMobile”:”923324132528″,”ContactName”:”Moazzam Ufone”,”CountryCode”:”92 “,”CountryID”:”156″,”CountryName”:”Pakistan”}],”Description”:”Success”,”status”:1}
9.9 Get Balance:
getBalance.ashx
URL https://sms.heullo.com/websms/mobile/apis/getBalance.ashx
Description Fetch the account balance of a specific user.
Parameters user , userid
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getBalance.ashx?user=abc&userid=123456
Example Response {“Balance”:”111.92″,”Description”:”Success”,”status”:1}
9.10 Get Countries:
getCountries.ashx
URL https://sms.heullo.com/websms/mobile/apis/getCountries.ashx
Description Lists all the countries associated with a specific user.
Parameters user , userid
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getCountries.ashx?user=abc&userid=123456
Example Response {“ClsCountry”:[{“CountryCode”:”92 “,”CountryID”:”156″,”CountryName”:”Pakistan”}],”Description”:”Success”,”status”:1}
9.11 Get Drafts:
getDrafts.ashx
URL https://sms.heullo.com/websms/mobile/apis/getDrafts.ashx
Description Lists all drafts for a specific user.
Parameters user , userid
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getDrafts.ashx?user=abc&userid=123456
Example Response {“Description”:”Success”,”Draft”:[{“Draft”:”hi tehre”,”DraftTitle”:”test message”},{“Draft”:”Attn Trilogy Techs: Changes are being made to your email on Monday, you will need to reconfigure on your phone. Visit http://tscgroup.com.au/info.html for help”,”DraftTitle”:”trilogy”}],”status”:1}
9.12 Get Inbox:
getInbox.ashx
URL https://sms.heullo.com/websms/mobile/apis/getInbox.ashx
Description Lists the inbox of a specific user.
Parameters user ,userid, Optional (dateFrom , dateTo,pageNo,pageSize), when user want to visit the specific page number record then pageSize and pageNo parameter are used , same in the case of dateFrom and dateTo parameter.
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getInbox.ashx?user=abc,cba&userid=123,456
Example Response {“Description”:”Success”,”inbox”:[{“From”:”+61401935100″,”Message”:”Stop”,”MessageDate”:”14\/Jul\/2017 09:07 AM”},{“From”:”+61401935100″,”Message”:”Stop”,”MessageDate”:”14\/Jul\/2016 09:07 PM”}],”status”:1}
9.13 Get Message Types:
getMessageTypes.ashx
URL https://sms.heullo.com/websms/mobile/apis/getMessageTypes.ashx
Description Lists all messages types available in the system.
Parameters [No Parameter]
Status Record not Found : 1
Example Request https://sms.heullo.com/websms/mobile/apis/getMessageTypes.ashx
Example Response {“Description”:”Success”,”MessageType”:[{“Description”:”Plain Text”,”MessageTypeID”:”0″},{“Description”:”Flash Message (GSM 3.38 Character encoding)”,”MessageTypeID”:”1″}],”status”:1}
9.14 Get Sender IDs:
getSenderIDs.ashx
URL https://sms.heullo.com/websms/mobile/apis/getSenderIDs.ashx
Description Lists all sender ids for a specific user and country.
Parameters userid , countryid
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getSenderIDs.ashx?userid=00&countryid=00
Example Response {“Description”:”Success”,”sender”:[{“SID”:”HEULLO”,”SenderID”:”HEULLO(GSM)”},{“SID”:”61404666536″,”SenderID”:”61404666536(CDMA)”}], “status”:1}
Draft Messages
10.1 Add Drafts:
AddDrafts.ashx
URL https://sms.heullo.com/websms/mobile/apis/AddDrafts.ashx
Description To save drafts into messages
Parameters user, userid, subject, message
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6,
Invalid Parameters Values:7
Example Request https://sms.heullo.com/websms/mobile/apis/AddDrafts.ashx?user=xyz&userid=00&subject=messageSubject&message=DraftMessage
Example Response {“Description”:”Success”, “status”:1}
10.2 Edit Drafts:
EditDrafts.ashx
URL https://sms.heullo.com/websms/mobile/apis/EditDrafts.ashx
Description Edit already saved drafts into messages
Parameters user, userid, subject, message , draftid
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6,
Invalid Parameters Values:7
Example Request https://sms.heullo.com/websms/mobile/apis/EditDrafts.ashx?user=xyz&userid=00&subject=messageSubject&message=DraftMessage&draftid=00
Example Response {“Description”:”Success”, “status”:1}
10.3 Delete Drafts:
DeleteDrafts.ashx
URL https://sms.heullo.com/websms/mobile/apis/DeleteDrafts.ashx
Description Delete drafts messages
Parameters user, userid, draftid
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6,
Invalid Parameters Values:7
Example Request https://sms.heullo.com/websms/mobile/apis/DeleteDrafts.ashx?user=xyz&userid=00&draftid=00
Example Response {“Description”:”Success”, “status”:1}
User Report Generated
11.1 Get SMS Report:
getSMSReport.ashx
URL https://sms.heullo.com/websms/mobile/apis/getSMSReport.ashx
Description List all SMS report generate against specific user with optional parameter count.
Parameters user, userid status, optional {page} , set the limit of pageSize is 20 when enter page number multiply with pageSize and added next 19 record for page.
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6
Example Request https://sms.heullo.com/websms/mobile/apis/getSMSReport.ashx?user=abc&userid=123456&page=1&status=1
Example Response {“Description”:”Success”,”Report”:[{“Country”:”Australia”,”DeliveryDate”:”15\/Aug\/2014 05:48 PM”,”Message”:”SMS to Email from HEULLOtest”,”RecNumber”:”1″,”SMSCost”:”0.110″,”SenderID”:”HEULLO”,”Status”:”DELIVERED”,”SubmitDate”:”15\/Aug\/2014 05:32 AM”,”TargetMobile”:”61401935100″},{“Country”:”Australia”,”DeliveryDate”:”28\/Jul\/2014 05:39 PM”,”Message”:”SMPP test from HEULLOsite”,”RecNumber”:”2″,”SMSCost”:”0.110″,”SenderID”:”HEULLO”,”Status”:”FAILED”,”SubmitDate”:”28\/Jul\/2014 05:35 PM”,”TargetMobile”:”61401935100″}],”status”:1}
Address Group
13.1 Add Address Group:
AddAddressGroup.ashx
URL https://sms.heullo.com/websms/mobile/apis/AddAddressGroup.ashx
Description Add an address group for a specific user under a specified country.
Parameters user, userid, groupname, countryid
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6,
Invalid Parameter Value : 7,
Invalid Mobile Number : 8,
Mobile Number Already Exist In Group : 9,
Contact Group Validation Failed : 10,
Country Code Validation Failed : 11
No Country Exits To Add Contact : 12
Example Request https://sms.heullo.com/websms/mobile/apis/AddAddressGroup.ashx?user=abc&userid=00,countryid=00,groupname=TestingGroup
Example Response {“Description”:”Success”,”status”:1}
13.2 Edit Address Group:
EditAddressGroup.ashx
URL https://sms.heullo.com/websms/mobile/apis/EditAddressGroup.ashx
Description Edit a specific address group.
Parameters user, userid, cgID, groupname
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6,
Invalid Parameter Value : 7,
Invalid Mobile Number : 8,
Mobile Number Already Exist In Group : 9,
Contact Group Validation Failed : 10,
Country Code Validation Failed : 11
No Country Exits To Add Contact : 12
Example Request https://sms.heullo.com/websms/mobile/apis/EditAddressGroup.ashx?user=abc&userid=00&groupname=TestingGroupEdit&cgID=00
Example Response {“Description”:”Success”,”status”:1}
13.3 Delete Address Group:
DeleteAddressGroup.ashx
URL https://sms.heullo.com/websms/mobile/apis/DeleteContactGroup.ashx
Description Delete a specific address group.
Parameters user , userid ,cgID
Status Success : 1,
Error : 2,
Validation Failed : 3,
Required Parameter Missing : 4,
Empty Parameter Value : 5,
Record Not Found : 6,
Invalid Parameter Value : 7,
Invalid Mobile Number : 8,
Mobile Number Already Exist In Group : 9,
Contact Group Validation Failed : 10,
Country Code Validation Failed : 11
No Country Exits To Add Contact : 12
Example Request https://sms.heullo.com/websms/mobile/apis/%20DeleteContactGroup.ashx?user=abc&userid=00&cgID=00
Example Response {“Description”:”Success”,”status”:1}
SMPP Bind return codes
ID Error Description
0 ESME_ROK Ok – Message Acceptable
1 ESME_RINVMSGLEN Invalid Message Length
2 ESME_RINVCMDLEN Invalid Command Length
3 ESME_RINVCMDID Invalid Command ID
4 ESME_RINVBNDSTS Invalid bind status
5 ESME_RALYBND Bind attempted when already bound
6 ESME_RINVPRTFLG Invalid priority flag
7 ESME_RINVREGDLVFLG Invalid registered-delivery flag
8 ESME_RSYSERR SMSC system error
10 ESME_RINVSRCADR Invalid source address
11 ESME_RINVDSTADR Invalid destination address
12 ESME_RINVMSGID Invalid message-id
13 ESME_RBINDFAIL Generic bind failure
14 ESME_RINVPASWD Invalid password
15 ESME_RINVSYSID Invalid System-ID
17 ESME_RCANCELFAIL Cancel failure
19 ESME_RREPLACEFAIL Replace failure
21 ESME_RMSGQFUL Too many messages in queue, at present
22 ESME_RINVSERTYP Invalid services type
51 ESME_RINVNUMDESTS Invalid number of destination addresses
52 ESME_RINVDLNAME Invalid name
64 ESME_RINVDESTFLAG Invalid Destination Flag Option
66 ESME_RINVSUBREP Invalid value for submit with replace option
67 ESME_RINVESMCLASS Invalid value for esm_class field
68 ESME_RCNTSUBDL Cannot submit to a distribution list
69 ESME_RSUBMITFAIL Generic submission failure
72 ESME_RINVSRCTON Invalid type of number for source
73 ESME_RINVSRCNPI Invalid numbering plan indicator for source
74 ESME_RINVDSTTON Invalid type of number for destination
75 ESME_RINVDSTNPI Invalid numbering plan indicator for destination
77 ESME_RINVSYSTYP Invalid esm type
78 ESME_RINVREPFLAG Invalid submit with replace flag option
85 ESME_RINVNUMMSGS Invalid number of messages specified for query_last_msgs primitive
88 ESME_RTHROTTLED SMSC is throttling inbound messages
97 ESME_RINVSCHED Invalid Schedule Date
98 ESME_RINVEXPIRY Invalid Validity Date
99 ESME_RINVDFTMSGID Invalid sm_default_msg_id Parameter
100 ESME_RX_T_APPN ESME Receiver Temporary App Error Code
101 ESME_RX_P_APPN ESME Receiver Permanent App Error Code
102 ESME_RX_R_APPN ESME Receiver Reject Message Error Code
103 ESME_RQUERYFAIL Query failure
192 ESME_RINVOPTPARSTREAM Error in the optional TLV parameter encoding
193 ESME_ROPTPARNOTALLWD An optional TLV parameter was specified which is not allowed
194 ESME_RINVPARLEN Invalid optional parameter length
195 ESME_RMISSINGOPTPARAM Missing optional parameter
196 ESME_RINVOPTPARAMVAL Invalid optional parameter value
254 ESME_RDELIVERYFAILURE Generic delivery failure
255 ESME_RUNKNOWNERR Unknown Error
https://www.world-text.com/docs/interfaces/SMPP/#err-code
System Status
The system is currently under construction.
Blog
Heullo single SMS sending limits
You can send up to 100 mobile numbers at a time with a daily limit of 500 SMS. To keep our systems healthy and your accounts safe, Heullo limits the amount of SMS one user can send. Limits restrict the number of messages sent per day and the number of recipients per message. After reaching one of these limits, a user can’t send new messages for up to 24 hours, but they can still access their account.
These limits may change without notice to protect Heullo’s infrastructure. Limits per day are applied over a rolling 24-hour period rather than a set time of day.