Text Message – send SMS

Occasionally the gateway will respond with a response code that is not documented in our site’s Common API responses.

When this happens the response will be coming directly from the mobile network provider rather than generated from our own gateway, as such this is not something that can be documented.

However, these response codes almost always resolve to the phone number you are trying to send an SMS to, check you are using the correct number, and if it is international number, be sure to take a look at the article on International SMS numbers.

As always, if you have any questions please comment below, or register on our forum.

admin SMS gateway API developement, text messages development error messages, result codes, SMS API, SMS gateway, text messages development, xml

Please find below a list of the most common API error responses, and possible reasons and corrections for them.

A response is defined as an error when the code is not 1, as result code 1 denotes an SMS succesfully delivered to the numbers network.

Message: Missing Required Fields Code: 501

Notes: This message means that the gateway did not receive enough information for an attempted delivery to be possible, this will occur when any of username, password, to and message are not supplied, if these are all sent, check that they are being sent as lowercase fields.

Message: Invalid Authentication Data Code: 502

Notes: This message means that either your submitted username was not found in the accounts, or the password supplied did not match the password for the username you sent. This would generally caused by invalid details, but these fields are case-sensitive, so check you sent them in the correct case.

Message: Insufficient Balance Code: 503

Notes: This message will only occur after you are succesfully logged into your account, and means that you do not have sufficient credits to send an SMS, this can only be corrected by topping up your credits balance.

Message: Invalid Recipient Code: 504

Notes: This error means that a problem was detected with the recipient number, most commonly caused by non-numeric characters in the to value.

Message: Error retrieving From Value Code: 511

Notes: This is an issue with the API, if this error is encountered an admin should be notified, along with the result ID.

There are other error messages that can be encountered, but it is unlikely that these will ever happen, if you do get an error that isn’t documented, and you are not sure what it means, please contact us, and we will help you understand the message.

As usual, you can contact us by commenting on these posts, in our forum, or by email to smsapi@hostingireland.ie

admin Uncategorized error messages, result codes, SMS API, text messages development, xml

It has become neccessary to have logs available to users, so that messages sent through our SMS gateway can be investigated in the future.

With this in mind a new feature has been added to the the API, you can now request logs of your messages, using the URL:

http://sms.hostingireland.ie/logRequest/?username=accountName&password=accountPassword[&messageId=messageId]

If messageId is not presented, you will be given the logs for the last 100 (or all if the total is less than or equal to 100) connections from your account.

These logs are presented in XML 1.0 format, and you can see an example log below:

<?xml version="1.0"?>
<logList>
	<log messageId="b7c10d6cbfe5496ec16acda8d0a187d0">
		<entry date="2009-04-21 13:15:27">logged in.</entry>
		<entry date="2009-04-21 13:15:27">999 SMS credits Left.</entry>
		<entry date="2009-04-21 13:15:27">to: 08fgh1414</entry>
		<entry date="2009-04-21 13:15:27">message: test</entry>
		<entry date="2009-04-21 13:15:27">from: 1890987000</entry>
		<entry date="2009-04-21 13:15:27">send result:  Invalid Destination Address</entry>
	</log>
</logList>

If the requested logfile is not in your account, or your login details are incorrect you will receive an error notifying you of the failure to receive a logList, you will also receive an error if you do not yet have any logs for any actions for your account.

Any comments on the logging system or the format of the XML should be entered through our forum, or in reply to this post.

admin SMS gateway API developement, text messages development logs, SMS API, text messages development, xml

For easier usage in automated implemenations the responses from the SMS gateway API will now be returned in XML 1.0.

An example response is below:

<smsapi>
	<result code="503" id="8dbcbdf843c817eed5f8898066184412">
		INSUFFICIENT BALANCE
	</result>
</smsapi>

This allows the response to be collected by an XML object and used more dynamic usage than the original error text.

If you have any comments on the XML response codes implementation, please send any information to us, either in our forum or in response to this post.

admin SMS gateway API developement, text messages development SMS API, SMS gateway, text messages development, xml