Textit - Biz HTTP API Technical Manual Rev 1 - 7
Textit - Biz HTTP API Technical Manual Rev 1 - 7
TEXTIT.BIZ
HTTP(S) API ‐ TECHNICAL MANUAL
[SMS]
Rev 1.7 [21‐01‐2021]
The TEXTIT.BIZ HTTP API has been designed to provide a straightforward method of integrating 3rd party applications
with the TEXTIT.BIZ messaging platform. Such integration requires skills and knowledge that are familiar to web‐
developers/programmers alike, and this manual provides the technical guidance required.
ENSURE THAT THIS MANUAL IS READ BEFORE YOU COMMENCE THE DEVELOPMENT OR MODIFICATION OF YOUR
APPLICATION.
The information in this document is subject to change without notice. Although TEXTIT.BIZ has taken reasonable steps to ensure
the accuracy and completeness of this document, it shall not be liable for any losses whatsoever, whether direct or indirect,
including without limitation any loss of profit, loss of use, or loss of data, as a result of any errors or omissions contained herein.
The information or statements in this document concerning the specification or performance of TEXTIT.BIZ does not constitute
any binding promise or warranty.
This API Reference lays out the specifications for the TEXTIT.BIZ HTTP API which describes the routines initiated by
Client Applications:
Calling a Routine
The first step is to compile all of the routine's associated parameter names and their corresponding URL
encoded values in the form of a query string.
Once the query string has been compiled, the Client Application should issue an HTTP Request (containing the
query string) to the given URL in the corresponding section
All HTTP Requests can be made using either GET or POST methods.
Once issued, the Client Application should use the header of the API’s HTTP Response to identify whether the
request was issued successfully or not. That is to say, the Client Application should only consider a request as
having been delivered successfully when a "200 OK" status is returned, in which case the body of our HTTP
Response will contain the outcome of the routine.
Client Requests
URL : http://www.textit.biz/sendmsg/index.php
url Replies will be URL Optional Replies will be posted to the given
posted to given url URL with GET method variables,
phone & text
schd Schedule SMS YYYY‐MM‐ Optional Delivery Delivery Date / Time in below
Delivery Time DD_HH:MM formats
Or Eg.
YYYYMMDDHHMM schd=2021‐01‐31_23:59
or
schd=202101312359
If the routine was executed successfully, first 2 characters of the body will be the word 'OK' followed by Route Identifier
, unique Message Identifier code and recipient mobile number. For example:
Broadcast Examples
Example 1
http://www.textit.biz/sendmsg/index.php?id=000000000&password=0000&text=This+is+a+sample+mess
age.&to=9876543210&from=OurCompany
In this example, a plain SMS “This is a sample message” is being sent to Mobile Number 9876543210 from
senderID ‘OurCompany’ a random number will be displayed on unsupported networks.
Example 2
http://www.textit.biz/sendmsg/index.php?id=000000000&password=0000&text=This+is+a+sample+mess
age.&to=9876543210,8765432101,7654321012
Example 3
http://www.textit.biz/sendmsg/index.php?id=000000000&password=0000&text=This+is+a+sample+mess
age.&to=9876543210,8765432101,7654321012&url=www.mywebsite.com/example.php
eg. if the recipient “9876543210” reply to this SMS with the text “MY REPLY”, the gateway will post the reply
to the given url as below
http://www.mywebsite.com/example.php?phone=987654321&text=MY+REPLY
http://www.textit.biz/sendmsg/index.php?id=000000000&password=0000&text=This+is+a+sample+mess
age.&to=9876543210&reply=Y
In this example, if the recipient reply to the SMS, the reply will be forwarded to the registered phone number.
Example 5
http://www.textit.biz/sendmsg/index.php?id=000000000&password=0000&text=This+is+a+sample+mess
age.&to=9876543210&reply=94123456789
In this example, if the recipient reply to the SMS, the reply will be forwarded to the ‘94123456789’ Phone
Number
Example 6
http://www.textit.biz/sendmsg/index.php?id=000000000&password=0000&text=This+is+a+sample+mess
age.&to=9876543210&schd=2021‐01‐31_23:59
In this example, the message will be delivered on or after 31st January 2021, 11.59PM
Multi Language messages can be used if you need to send characters not available within an ordinary text
message (e.g. Sinhalese, Arabic, Hindi, Tamil, Japanese). A Multi Language SMS can contain maximum 60
characters per message. Multi Language messages are sent by using UTF‐8 charset.
Please also be aware that while most mobile phones support the usage of multi‐language characters, there
are some exceptions with older feature phones, which may have trouble displaying them in the correct format.
http://textit.biz/sendmsg/index.php?id=0000000000&pw=0000&to=123456789&text=%E0%B7%83%E0%
B7%92%E0%B6%82%E0%B7%84%E0%B6%BD
If the recipient number is a Sri Lankan phone number, all below formats are supported.
[InternationalPrefix][CountryCode][AreaCode][PhoneNumber]
Eg. 0094772823050
[CountryCode][AreaCode][PhoneNumber]
Eg. 94772823050
[AreaCode][PhoneNumber]
Eg. 0772823050
International Recipients
If the recipient number is a Non‐Sri Lankan phone number, below format must be used to
ensure delivery.
[InternationalPrefix][CountryCode][AreaCode][PhoneNumber]
Eg. 0094772823050
Client Request
API Response
Assuming that the Check_Credit routine was executed successfully, the body of the API’s response (i.e. the result) will
contains the credit available on your account. The value is numeric and may contain decimal points.
If the routine failed, the response (i.e the result) will contain the error code.
Example
http://www.textit.biz/creditchk/index.php?id=000000000&pw=0000
Error:Ins_Crd
Insufficient credits on the relevant balance.
Error:to_invalid
An invalid destination number or a blank value has been supplied.
Error:Auth_Fail
The account's credentials could not be verified.
Error:Usr_Invalid
The format of the supplied User ID is Invalid.
Error:NotFound
No record found in the query