| ||||||||||||||||||||||||||||
|
» 160.com.au » Developer SMS » SMS API
The process of enabling your website or application to send SMS using our service is easy. We have included a PHP example to help you. Our API supports 4 ways of connectivity - GET & POST requests, SOAP 1.1 & 1.2 protocols. Our staging system makes your coding painless. Please, see below for more details:
Staging system detailsThe staging system recognizes 9 special phone numbers. SMS sent to these numbers are not chargeable and not sent on air. Moreover the last digit in the numbers allows you to define what status a sent message will have. These numbers also work on our sms gateway, so you can use them to test site features such as Email2SMS as well as our API.
GetCreditBalance
SOAP 1.1The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.160.com.au/api/GetCreditBalance"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetCreditBalance xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
</GetCreditBalance>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetCreditBalanceResponse xmlns="www.160.com.au/api">
<GetCreditBalanceResult>string</GetCreditBalanceResult>
</GetCreditBalanceResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetCreditBalance xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
</GetCreditBalance>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetCreditBalanceResponse xmlns="www.160.com.au/api">
<GetCreditBalanceResult>string</GetCreditBalanceResult>
</GetCreditBalanceResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GETThe following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values. GET /api/sms.asmx/GetCreditBalance?username=string&password=string HTTP/1.1 Host: www.160.com.au HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <string xmlns="www.160.com.au/api">string</string> HTTP POSTThe following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx/GetCreditBalance HTTP/1.1 Host: www.160.com.au Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&password=string HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <string xmlns="www.160.com.au/api">string</string> SendMessage
Multiple SMS: InputYou can send more than one SMS at once with our API. To do this you should list the recipient's mobile numbers in the mobileNumber fields, with a unique id defined in the square brackets. The id should be alphanumeric. For example, a request below will send "text_here" SMS to 2 mobile number 0417027121 and 0413456787messageText=text_here&mobileNumber[1]=0417027121&mobileNumber[test1]=0413456787&... Note: In our example above we have used [1] and [test1] as our id, but it can be alphanumeric value. You can also send each recipient their own unique SMS. To do this, you need to use messageText fields in the same format as mobileNumber. The id, assigned to the mobileNumber, should be the same id, assigned to the messageText. For example, a request below will send "Hi Michael" to the 0417027121, and "Hi Andrew" to the 0413456787. messageText[1]=Hi%20Michael&messageText[test1]=Hi%20Andrew&mobileNumber[1]=0417027121&mobileNumber[test1]=0413456787&... The same technique can be used for senderName, sms2way and the delay field(s). In the SOAP versions, you need to group uncommon values to the <sms> container. The container should be repeated one time minimum. So, the examples above will look like:
Multiple SMS: OutputThe status tag can only have 2 values, OK or NOK. If the value is OK, all SMS were sent. NOK value means none of SMS were sent.<sms> container keeps id and messageId in case of success, or error descriptions in case of failure. There is a special id - COMMON - which indicates common errors if any. SOAP 1.1The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.160.com.au/api/SendMessage"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendMessage xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
<mobileNumber>string</mobileNumber>
<messageText>string</messageText>
</SendMessage>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendMessageResponse xmlns="www.160.com.au/api">
<SendMessageResult>string</SendMessageResult>
</SendMessageResponse>
</soap:Body>
</soap:Envelope>
POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.160.com.au/api/SendMessage"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendMessage xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
<sms>
<id>string</id>
<mobileNumber>string</mobileNumber>
<messageText>string</messageText>
</sms>
</SendMessage>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendMessageResponse xmlns="www.160.com.au/api">
<SendMessageResult>
<status>string</status>
<sms>
<id>string</id>
<message>string</message>
</sms>
</SendMessageResult>
</SendMessageResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendMessage xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
<mobileNumber>string</mobileNumber>
<messageText>string</messageText>
</SendMessage>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendMessageResponse xmlns="www.160.com.au/api">
<SendMessageResult>string</SendMessageResult>
</SendMessageResponse>
</soap12:Body>
</soap12:Envelope>
POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendMessage xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
<sms>
<id>string</id>
<mobileNumber>string</mobileNumber>
<messageText>string</messageText>
</sms>
</SendMessage>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendMessageResponse xmlns="www.160.com.au/api">
<SendMessageResult>
<status>string</status>
<sms>
<id>string</id>
<message>string</message>
</sms>
</SendMessageResult>
</SendMessageResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GETThe following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values. GET /api/sms.asmx/SendMessage?username=string&password=string&mobileNumber=string&messageText=string HTTP/1.1 Host: www.160.com.au HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <string xmlns="www.160.com.au/api">string</string> GET /api/sms.asmx/SendMessage?username=string&password=string&mobileNumber[id]=string&messageText[id]=string HTTP/1.1 Host: www.160.com.au HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<result>
<status>string</status>
<sms>
<id>string</id>
<message>string</message>
</sms>
</result>
HTTP POSTThe following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx/SendMessage HTTP/1.1 Host: www.160.com.au Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&password=string&mobileNumber=string&messageText=string HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <string xmlns="www.160.com.au/api">string</string> POST /api/sms.asmx/SendMessage HTTP/1.1 Host: www.160.com.au Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&password=string&mobileNumber[id]=string&messageText[id]=string HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<result>
<status>string</status>
<sms>
<id>string</id>
<message>string</message>
</sms>
</result>
GetMessageStatus
Multiple SMS: InputYou can retrieve the status of multiple SMS. To do this list message id in the messageId fields which have unique id defined in the square brackets. Please note that id must be alphanumeric. For example, a request below will return data for 2 messages.messageId[1]=api123&messageId[test1]=api124&... Multiple SMS: OutputThere is a common tag status which is always OK.<sms> container keeps id, code and message. message contains the same info as a string tag in the previous version. code can have 4 values:
SOAP 1.1The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.160.com.au/api/GetMessageStatus"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetMessageStatus xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
<messageId>string</messageId>
</GetMessageStatus>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetMessageStatusResponse xmlns="www.160.com.au/api">
<GetMessageStatusResult>string</GetMessageStatusResult>
</GetMessageStatusResponse>
</soap:Body>
</soap:Envelope>
POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.160.com.au/api/GetMessageStatus"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetMessageStatus xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
<sms>
<id>string</id>
<messageId>string</messageId>
</sms>
</GetMessageStatus>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetMessageStatusResponse xmlns="www.160.com.au/api">
<GetMessageStatusResult>
<sms>
<id>string</id>
<code>string</code>
<message>string</message>
</sms>
</GetMessageStatusResult>
</GetMessageStatusResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetMessageStatus xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
<messageId>string</messageId>
</GetMessageStatus>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetMessageStatusResponse xmlns="www.160.com.au/api">
<GetMessageStatusResult>string</GetMessageStatusResult>
</GetMessageStatusResponse>
</soap12:Body>
</soap12:Envelope>
POST /api/sms.asmx HTTP/1.1
Host: www.160.com.au
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetMessageStatus xmlns="www.160.com.au/api">
<username>string</username>
<password>string</password>
<sms>
<id>string</id>
<messageId>string</messageId>
</sms>
</GetMessageStatus>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetMessageStatusResponse xmlns="www.160.com.au/api">
<GetMessageStatusResult>
<sms>
<id>string</id>
<code>string</code>
<message>string</message>
</sms>
</GetMessageStatusResult>
</GetMessageStatusResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GETThe following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values. GET /api/sms.asmx/GetMessageStatus?username=string&password=string&messageId=string HTTP/1.1 Host: www.160.com.au HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <string xmlns="www.160.com.au/api">string</string> GET /api/sms.asmx/GetMessageStatus?username=string&password=string&messageId[id]=string HTTP/1.1 Host: www.160.com.au HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<result>
<sms>
<id>string</id>
<code>string</code>
<message>string</message>
</sms>
</result>
HTTP POSTThe following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values. POST /api/sms.asmx/GetMessageStatus HTTP/1.1 Host: www.160.com.au Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&password=string&messageId=string HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <string xmlns="www.160.com.au/api">string</string> POST /api/sms.asmx/GetMessageStatus HTTP/1.1 Host: www.160.com.au Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&password=string&messageId[id]=string HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<result>
<sms>
<id>string</id>
<code>string</code>
<message>string</message>
</sms>
</result>
| ||||||||||||||||||||||||||||
Copyright © 160.com.au 2000 - 2020. All Rights Reserved. Disclaimer and Terms & Conditions. ABN 34 101 997 175
| ||||||||||||||||||||||||||||
