SMS HTTP API Documentation

Version 7.3
Introduction 3

API Functionality Overview 4

Bulk SMS 4

Single Scheduled SMS 4

Bulk Scheduled SMS 4

Modify Scheduled SMS 4

Delete Scheduled SMS 4

Enquire All Pending Scheduled SMS 4

Enquire All Sent Scheduled SMS 4

Enquire Single Scheduled SMS 4

Single WAP SMS 4

Pre-paid Credit Check 5

SMS Retrieval 5

Virtual Mobile Number Inbox Retrieval 5

Virtual Mobile Number SMS Deletion 5

Function Description and Definitions 6

Single SMS 7

Bulk SMS Sending 9

Single Scheduled SMS Sending 11

Bulk Scheduled SMS Sending 14

Modify Scheduled Message 17

Delete Scheduled SMS 19

Enquire All Pending Scheduled Messages 21

Enquire All Sent Scheduled Messages 23

Enquire Single Scheduled SMS 25

1
Pre-Paid Credit Check 28

SMS Retrieval 29

Virtual Mobile Number Inbox Retrieval 32

Virtual Mobile Number Message Removal 34

APPENDIX A: HTTP Character Encoding 36

2
Introduction
This document is dedicated for users who wish to use Exetel Pty Ltd’s gateway for sending
SMS messages. This gateway can be accessed by HTTP protocol by submitting values to the
HTTP API Server by the POST method.

Exetel Pty Ltd’s gateway can be used to send simple text messages.

This document gives a detailed explanation of using the gateway through HTTP protocol.

3
API Functionality Overview
The Exetel gateway allows the following functions;

Single SMS
Allows an SMS message to be sent to a single destination mobile number.

Bulk SMS
Allows an SMS message to be sent to multiple destination mobile numbers.

Single Scheduled SMS

Allows single SMS message to be sent at a scheduled date and time. The
scheduled time is according to Australian Eastern Standard Time (AEST)

Bulk Scheduled SMS

Allows the same SMS message to be sent to multiple recipients at a
scheduled date and time. The scheduled time is according to Australian Eastern Standard
Time (AEST)

Modify Scheduled SMS

Allows the modification of the scheduled date and time of a previously sent
SMS message.

Delete Scheduled SMS

Allows the deletion of a previously scheduled SMS message.

Enquire All Pending Scheduled SMS

Allows the return of all currently scheduled SMS messages that have not
been sent.

Enquire All Sent Scheduled SMS

Allows the return of all previously scheduled SMS messages that have been
sent.

Enquire Single Scheduled SMS

Allows the query of a single specific scheduled SMS message.

Single WAP SMS

Allows a single WAP SMS message to be sent. WAP SMS sends a URL to
the destination mobile number to download the content stored within the URL.

4
Pre-paid Credit Check
Allows pre-paid ONLY customers to retrieve the remaining credit amount
within their account.

SMS Retrieval
Allows previously sent SMS messages details such as delivery status to be
retrieved.

Virtual Mobile Number Inbox Retrieval

Allows SMS message sent to a Virtual Mobile Number to be retrieved.

Virtual Mobile Number SMS Deletion

Allows a SMS message stored within a Virtual Mobile Number to be
deleted.

5
Function Description and Definitions
The following section defines and describes the input and output parameters that are
required for each SMS API function. Unless specified, each listed input parameter is
mandatory when making a request to the SMS API.

Each function shall return a response indicating the outcome of the provided request.
Individual values are separated by the “|” character. Multiple responses are separated by a
newline.

Please also note that due to restrictions in the HTTP protocol format, special HTTP reserved
characters must be encoded to be interpreted correctly. Please see Appendix A for a list of
HTTP character encoding.

6
Single SMS

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

sender The name or number of the SMS sender - 04xxxxxxxx

that will appear on the destination mobile - 614xxxxxxxx
handset. Restricted to 11 alphanumeric - John
characters or 15 numerical characters.

mobilenumber The destination mobile number. Can only - 04xxxxxxxx

be a maximum of 15 numerical - 614xxxxxxxx
characters.
International (non-Australian) mobile
numbers must contain the country code.

message The message text to be sent to the Hello, this is a test

destination mobile number. Can be a message.
maximum size of 612 characters.
Messages
greater than 160 characters will appear as
a single message on the destination
handset.

messagetype Messages can be either “Text” or - Text

“Unicode” - Unicode
types. Unicode type messages are used
for
messages containing text other than
English.

referencenumber A unique identifier that can be attached to - 12345

(optional) each message. Can be a maximum of 50 - Xref1
alphanumeric characters

Single SMS Sending Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms.php?username=xxxxxxxx&password=
xxxxxxxx&mobilenumber=xxxxxxxx&message=xxxxxxxx&sender=xxxxxxxxx&messagetyp
e=Text&referencenumber=xxxxxx
7
Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS - 0

message request. - 1
- 2
0: SMS Request Rejected
1: Sent
2: Failed

Mobile Number The destination mobile number - 04xxxxxxxx

provided - 614xxxxxxxx

Reference Number The previously provided unique - 12345

identfied attached. - Xref1

Exetel ID A unique identification number - 123

assigned to each message by Exetel

Exetel Notes Additional details regarding the

request.

Possible descriptions:
- Sent
- Incorrect login name and/or password
- Insufficient Credit Amount
- Invalid Customer Reference
- Invalid Message Type
- Invalid Message
- Invalid Mobile Number List
- Invalid Sender

Single SMS Example Return Response:

1|0400000000|123|1|Sent
2|9878987888|123||Failed
0|0400000000|123||Invalid Sender

8
Bulk SMS Sending

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

sender The name or number of the SMS sender that - 04xxxxxxxx

will appear on the destination mobile handset. - 614xxxxxxxx
Restricted to 11 alphanumeric characters or 15 - John
numerical characters.

mobilenumber The destination mobile numbers. Each mobile - 04xxxxxxxx,

number can only be a maximum of 15 614xxxxxxxx
numerical characters. International , 04xxxxxxxx
(non-Australian) mobile numbers must contain
the country code. Multiple mobile numbers
can be supplied by separating each mobile
number by a comma “,” A maximum of 5000
mobile number can be supplied.

message The message text to be sent to the destination Hello, this is a

mobile number. Can be a maximum size of test message.
612 characters. Messages greater than 160
characters will appear as a single message on
the destination handset.

messagetype Messages can be either “Text” or “Unicode” - Text

types. Unicode type messages are used for - Unicode
messages containing text other than English.

referencenumber A unique identifier that can be attached to - 12345

(optional) each message. Can be a maximum of 50 - Xref1
alphanumeric characters

Bulk SMS Sending Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms.php?username=xxxxxxxx&password=
xxxxxxxx&mobilenumber=xxxxxxxx,xxxxxxxx,xxxxxxxx&message=xxxxxxxx&sender=xx
xxxxxxx&messagetype=Text&referencenumber=xxxxxx

9
Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS message - 0

request. - 1
- 2
0: SMS Request Rejected
1: Sent
2: Failed

Mobile Number The destination mobile number provided - 04xxxxxxxx

- 614xxxxxxxx

Reference Number The previously provided unique identified - 12345

attached. - Xref1

Exetel ID A unique identification number assigned to

each message by Exetel

Exetel Notes Additional details regarding the request.

Possible descriptions:
- Sent
- Incorrect login name and/or password
- Insufficient Credit Amount
- Invalid Customer Reference
- Invalid Message Type
- Invalid Message
- Invalid Mobile Number List
- Invalid Sender

Bulk SMS Sending Example Return Response:

1|0400000000|123|1|Sent
2|9878987888|123||Failed
0|0200000000,ABC,9878987888|123||Invalid mobile number list

10
Single Scheduled SMS Sending

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

sender The name or number of the SMS sender - 04xxxxxxxx

that - 614xxxxxxxx
will appear on the destination mobile - John
handset. Restricted to 11 alphanumeric
characters or 15 numerical characters.

mobilenumber The destination mobile numbers. Each - 04xxxxxxxx

mobile number can only be a maximum of - 614xxxxxxxx
15 numerical characters. International
(non-
Australian) mobile numbers must contain
the country code.

message The message text to be sent to the Hello, this is a

destination mobile number. Can be a test message.
maximum size of 612 characters. Messages
greater than 160 characters will appear as
a
single message on the destination handset.

messagetype Messages can be either “Text” or “Unicode” - Text

types. Unicode type messages are used for - Unicode
messages containing text other than
English.

referencenumber A unique identifier that can be attached to - 12345

(optional) each message. Can be a maximum of 50 - Xref1
alphanumeric characters

requesttype The type of schedule request that is too be - ADD

performed. Must be set to “ADD” for new
scheduled messages

scheduledday The day of the month to deliver the - 01

scheduled message. The value must be - 31
between 01 and 31.

11
 scheduledmonth The month to deliver the scheduled - 01
message. The value must be between 01 - 12
and
12. Please note that an SMS message can
only be scheduled 3 months in advance.

scheduledyear The year to deliver the scheduled message. - 2008

- 2009

scheduledhour The hour to deliver the scheduled message. - 00

The value must be between 00 and 23. - 12
Time must be expressed in 24 hour time - 23

scheduledminute The minute to deliver the scheduled - 00

message. The value must be between 00 - 31
and - 59
59.

Scheduled SMS Sending Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_schedule.php?username=xxxxxxxx&
password=xxxxxxxx&mobilenumber=xxxxxxxx&message=xxxxxxxx&sender=xxxxxxxxx&m
essagetype=Text&referencenumber=xxxxxx&requesttype=ADD&scheduledday=01&sche
duledmonth=01&scheduledyear=2008&scheduledhour=06&scheduledminute=00

12
Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS - 0

message request. - 1
0: SMS Request Rejected - 2
1: Sent
2: Failed

Mobile Number The destination mobile number provided - 04xxxxxxxx

- 614xxxxxxx
x

Reference Number The previously provided unique identified - 12345

attached. - Xref1

Exetel ID A unique identification number assigned to

each message by Exetel

Exetel Notes Additional details regarding the request.

Possible descriptions:
- OK
- Incorrect login name and/or password
- Insufficient Credit Amount
- Invalid Customer Reference
- Invalid Message Type
- Invalid Message
- Invalid Mobile Number List
- Invalid Sender
- Incomplete or Empty Scheduled Date/Time
- Invalid Schedule Date/Time
- Schedule Date/Time has passed
- Scheduled Date/Time is to far ahead. The Date/Time can
only
- be three months ahead
- Too many days in the selected month

Single Scheduled SMS Sending Example Return Response:

1|0400000000|123|1|OK
2|9878987888|123||Failed
0|0200000000,ABC,9878987888|123||Invalid mobile number list

13
Bulk Scheduled SMS Sending

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

sender The name or number of the SMS sender that - 04xxxxxxxx

will appear on the destination mobile - 614xxxxxxxx
handset. Restricted to 11 alphanumeric - John
characters or 15 numerical characters.

mobilenumber The destination mobile numbers. Each 04xxxxxxxx,614xxxxx

mobile number can only be a maximum of xxx,04xxxxxxxx
15 numerical characters. International
(non-Australian) mobile numbers must
contain the country code. Multiple mobile
numbers can be supplied by separating each
mobile number by a comma “,” A maximum
of 5000 mobile number can be supplied.

message The message text to be sent to the Hello, this is a

destination mobile number. Can be a test message.
maximum size of 612 characters. Messages
greater than 160 characters will appear as a
single message on the destination handset.

messagetype Messages can be either “Text” or “Unicode” - Text

types. Unicode type messages are used for - Unicode
messages containing text other than English.

referencenumber A unique identifier that can be attached to - 12345

(optional) each message. Can be a maximum of 50 - Xref1
alphanumeric characters.

requesttype The type of schedule request that is too be - ADD

performed. Must be set to “ADD” for new
scheduled messages.

scheduledday The day of the month to deliver the - 01

scheduled message. The value must be - 31
between 01 and 31.

14
 scheduledmonth The month to deliver the scheduled - 01
message. The value must be between 01 and - 12
12. Please note that an SMS message can
only be scheduled 3 months in advance.

scheduledyear The year to deliver the scheduled message. - 2008

- 2009

scheduledhour The hour to deliver the scheduled message. - 00

The value must be between 00 and 23. Time - 12
must be expressed in 24 hour time. - 23

scheduledminute The minute to deliver the scheduled - 00

message. The value must be between 00 and - 31
59. - 59

Bulk Scheduled SMS Sending Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_schedule.php?username=xxxxxxxx&
password=xxxxxxxx&mobilenumber=xxxxxxxx&message=xxxxxxxx&sender=xxxxxxxxx&m
essagetype=Text&referencenumber=xxxxxx&requesttype=ADD&scheduledday=01&sche
duledmonth=01&scheduledyear=2008&scheduledhour=06&scheduledminute=00

15
Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS - 0

message request. - 1
- 2
0: SMS Request Rejected
1: Scheduled
2: Failed

Mobile Number The destination mobile number provided. - 04xxxxxxxx

- 614xxxxxxx
x

Reference Number The previously provided unique identified - 12345

attached. - Xref1

Schedule ID A unique identification number assigned to

each scheduled message by Exetel.

Exetel Notes Additional details regarding the request.

Possible descriptions:
- OK
- Incorrect login name and/or password
- Invalid Customer Reference
- Invalid Message Type
- Invalid Message
- Invalid Mobile Number List
- Invalid Sender
- Incomplete or Empty Scheduled Date/Time
- Invalid Schedule Date/Time
- Schedule Date/Time has passed
- Scheduled Date/Time is to far ahead. The Date/Time can
only
- be three months ahead
- Too many days in the selected month

Bulk Scheduled SMS Sending Example Return Response:

1|0400000000|123|1|OK
2|9878987888|123||Failed
0|0200000000,ABC,9878987888|123||Invalid mobile number list

16
Modify Scheduled Message

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

scheduleid The unique identification number assigned by - 123

Exetel to the scheduled message.

requesttype The type of schedule request that is too be - MODIFY

performed. Must be set to “MODIFY” to modify
existing scheduled messages.

scheduledday The day of the month to deliver the scheduled - 01

message. The value must be between 01 and - 31
31.

scheduledmonth The month to deliver the scheduled message. - 01

The value must be between 01 and 12. Please - 12
note that an SMS message can only be
scheduled 3 months in advance.

scheduledyear The year to deliver the scheduled message. - 2008

- 2009

scheduledhour The hour to deliver the scheduled message. The - 00

value must be between 00 and 23. Time must - 12
be expressed in 24 hour time. - 23

scheduledminute The minute to deliver the scheduled message. - 00

The value must be between 00 and 59. - 31
- 59

Modify Scheduled SMS Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_schedule.php?username=xxxxxxxx&
password=xxxxxxxx&scheduleid=123&requesttype=MODIFY&scheduledday=01&schedul
edmonth=01&scheduledyear=2008&scheduledhour=06&scheduledminute=00

17
Output Parameters

Parameter Parameter Description Example

Name

Status The outcome descriptor of the SMS message request. - 0

- 1
0: SMS Request Rejected - 2
1: OK
2: Failed

Exetel Notes Additional details regarding the request.

Possible descriptions:

- OK
- Incorrect login name and/or password
- Incomplete or Empty Scheduled Date/Time
- Invalid Schedule Date/Time
- Schedule Date/Time has passed
- Scheduled Date/Time is to far ahead. The Date/Time can only
- be three months ahead
- Too many days in the selected month
- Message has already been sent.
- No message found unable to modify

Modify Scheduled SMS Example Return Response:

1|OK
2|No message found unable to modify
0|Invalid Schedule Date/Time

18
Delete Scheduled SMS

Input Parameters

Parameter Parameter Description Example

Name

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

scheduleid The unique identification number - 123

assigned
by Exetel to the scheduled message.

requesttype The type of schedule request that is too - DELETE

be
performed. Must be set to “DELETE” to
delete existing scheduled messages.

Delete Scheduled SMS Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_schedule.php?username=xxxxxxxx&
password=xxxxxxxx&scheduleid=123&requesttype=DELETE

19
Output Parameters

Parameter Parameter Description Example

Name

Status The outcome descriptor of the SMS message request. - 0

- 1
0: SMS Request Rejected - 2
1: OK
2: Failed

Exetel Notes Additional details regarding the request.

Possible descriptions:

- OK
- Incorrect login name and/or password
- Message could not be deleted, please try again
- Message has already been sent.
- No message found unable to delete.

Delete Scheduled SMS Example Return Response:

0|Invalid Schedule Date/Time

1|OK
2|No message found unable to delete

20
Enquire All Pending Scheduled Messages

Input Parameters

Parameter Parameter Description Example

Name

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

requesttype The type of schedule request that is too - ENQUIRE_PENDING

be performed. Must be set to
“ENQUIRE_PENDING” to view all pending
messages.

Enquire All Pending Scheduled Messages Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_schedule.php?username=xxxxxxxx&
password=xxxxxxxx&requesttype=ENQUIRE_PENDING

21
Output Parameters

Parameter Parameter Description Example

Name

Status The outcome descriptor of the SMS message - 0

request. - 1
- 2
0: SMS Request Rejected
1: OK
2: No Results

Schedule ID The ID returned when making an SMS schedule - 123

message request.

Sender The name or number of the SMS sender that - 04xxxxxxxx

Name/Number will appear on the destination mobile handset. - John

Destination The destination mobile number. - 04xxxxxxxx

Mobile - 614xxxxxxx
Number

Message The message text to be sent to the destination - Test

mobile number.

Received Time The time when the schedule request was made. - 2008-01-19
(AEST) 10:30:00

Scheduled Time The scheduled time that the message was to be - 2008-01-20
(AEST) delivered 14:23:00

Exetel Notes Additional details regarding the request.

Possible descriptions:
- OK
- Incorrect login name and/or password
- There are currently no pending scheduled messages.

Enquire All Pending Scheduled SMS Example Return Response:

0||||||Incorrect login name and/or password

1|123|0400000000|0400000000|Test| 2008-01-19 10:30:00| 2008-01-20
14:23:00|OK
2||||||There are currently no pending scheduled messages.

22
Enquire All Sent Scheduled Messages

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API - username

access registration.

password Password chosen during API - password

access
registration.

requesttype The type of schedule request that - ENQUIRE_SENT

is too be performed. Must be set to
“ENQUIRE_SENT” to view all sent
messages.

Enquire All Sent Scheduled Messages Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_schedule.php?username=xxxxxxxx&
password=xxxxxxxx&requesttype=ENQUIRE_SENT

23
Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS - 0

message request. - 1
0: SMS Request Rejected - 2
1: OK
2: No Results

Schedule ID The ID returned when making an SMS - 123

schedule message request.

Sender The name or number of the SMS sender that - 04xxxxxxxx

Name/Number will appear on the destination mobile handset. - John

Destination Mobile The destination mobile number. - 04xxxxxxxx

Number - 614xxxxxxx

Message The message text to be sent to the destination - Test

mobile number.

Received Time The time when the schedule request was 2008-01-19
(AEST) made. 10:30:00

Scheduled Time The scheduled time that the message was to 2008-01-20
(AEST) be delivered. 14:23:00

Sent Time (AEST) The actual delivery time of the message. 2008-01-20
14:23:00

Exetel ID A unique identification number assigned to 4956

each message by Exetel. To be used when
making message delivery query.

Exetel Notes Additional details regarding the request.

Possible descriptions:
- OK
- Incorrect login name and/or password.
- There are currently no sent scheduled messages.

Enquire All Sent Scheduled SMS Example Return Response:

0|||||||||Incorrect login name and/or password

1|123|0400000000|0400000000|Test|2008-01-1910:30:00|2008-01-2014:23:00|2008
-01-2014:23:00|4956|OK

24
2|||||||||There are currently no sent scheduled messages.
Enquire Single Scheduled SMS

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API - username

access
registration.

password Password chosen during API access - password

registration.

scheduleid The unique identification number - 123

assigned by Exetel to the scheduled
message.

requesttype The type of schedule request that is - ENQUIRE_SENT

too be performed. Must be set to
“ENQUIRE_SENT” to view all sent
messages.

Enquire Single Scheduled Message Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_schedule.php?username=xxxxxxxx&
password=xxxxxxxx&requesttype=ENQUIRE_SINGLE

25
Output Parameters

Parameter Parameter Description Example

Name

Status The outcome descriptor of the SMS - 0

message request. - 1
- 2
0: SMS Request Rejected
1: OK
2: No Results

Schedule ID The ID returned when making an SMS - 123

schedule message request.

Sender The name or number of the SMS sender that - 04xxxxxxxx

Name/Number will appear on the destination mobile - John
handset.

Destination The destination mobile number. - 04xxxxxxxx

Mobile - 614xxxxxxx
Number

Message The message text to be sent to the - Test

destination mobile number.

Received Time The time when the schedule request was 2008-01-19 10:30:00
(AEST) made.

Scheduled Time The scheduled time that the message was to 2008-01-20 14:23:00
(AEST) be delivered.

Sent Time (AEST) The actual delivery time of the message. 2008-01-20 14:23:00

Exetel ID A unique identification number assigned to 4956

each message by Exetel. To be used when
making message delivery query.

Exetel Notes Additional details regarding the request.

Possible descriptions:

- OK
- Incorrect login name and/or password.
- Unable to find scheduled message.

26
Enquire Single Scheduled SMS Example Return Response:

0|||||||||Incorrect login name and/or password

1|123|0400000000|0400000000|Test|2008-01-19 10:30:00|2008-01-20 14:23:00|
2008-01-20 14:23:00|4956|OK
2|||||||||Unable to find scheduled message

27
Pre-Paid Credit Check

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

Prepaid Account Credit Check Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_credit.php?username=xxxxxxxx&pa
ssword=xxxxxxxx

Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS - 0

message request. - 1
0: SMS Request Rejected - 2
1: Sent
2: Failed

Credit Limit The amount of credit remaining - 100

within the
pre-paid account.

Exetel Notes Additional details regarding the request.

Possible descriptions:

- OK
- Account is post-paid
- Incorrect login name and/or password

Credit Check Example Return Response:

1|100|OK
2||Account is post-paid
0||Incorrect login name and/or password

28
SMS Retrieval

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

exetelreference Unique identification number assigned to - 123

each message by Exetel that is returned
when
a send request is made. Must be provided if
referencenumber is not supplied. Can be
used
in conjunction with referencenumber.

referencenumber Unique identifier attached to each message. - Xref1

Optional field when sending a message. Must
be provided if exetelreference is not
supplied.
Can be used in conjunction with
exetelreference.

SMS Retrieval Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_detail.php?username=xxxxxxxx&pa
ssword=xxxxxxxx&exetelreference=123&referencenumber=Xref1

29
Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS - 0

message request. - 1
- 2
0: SMS Request Rejected
1: Sent
2: Failed

Exetel ID A unique identification number - 123

assigned to each message by Exetel.

Customer ID Exetel assigned customer - 100001

identification
number.

Sender The name or number of the SMS - 04xxxxxxxx

Name/Number sender that will appear on the - John
destination mobile handset.

Destination Mobile The destination mobile number. - 04xxxxxxxx

Number - 614xxxxxxx

Received Time The time when the SMS request was 2008-01-19 10:30:00
(AEST) made and sent.

Message Status The current status of the SMS - Delivered

message. - Sent
- Queued
- Failed

Charge The total cost of the SMS message. 0.05

Exetel Notes Additional details regarding the request.

Possible descriptions:

- OK
- Incorrect login name and/or password
- No search criteria supplied
- Invalid customer reference
- Invalid Exetel Reference
- No results returned

30
SMS Retrieval Example Return Response:

1|123|100001|040000000|040000000|2008-01-19 10:30:00|Delivered|0.03|OK
2||||||||No results returned
0||||||||Incorrect login name and/or password

31
Virtual Mobile Number Inbox Retrieval

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access username

registration.

password Password chosen during API access password

registration.

mobilenumber The Virtual Mobile Number that you wish to 04xxxxxxxx

retrieve message from.

Virtual Mobile Number Inbox Retrieval Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_mvn_inbox.php?username=xxxxxxxx
&password=xxxxxxxx&mobilenumber=04xxxxxxxx

32
Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS - 0

message request. - 1
- 2
0: SMS Request Rejected
1: Sent
2: Failed

Exetel ID A unique identification number assigned to - 123

each message within the Virtual Mobile
Number inbox by Exetel.

Message Originator The mobile number of the SMS sender. - 04xxxxxxxx

- 614xxxxxxxx

Received Time The time when the SMS message was 2008-01-19 10:30:00
(AEST) received.

Exetel Notes Additional details regarding the request.

Possible descriptions:

- Found
- Incorrect login name and/or password
- No mobile visual number supplied or invalid mobile visual
- number supplied
- Mobile Virtual Number is disabled or does not belong to you
- No results returned

Message Text The received message text. Hello

Virtual Mobile Number Inbox Retrieval Example Return Response:

1|123|04xxxxxxxx|2008-01-19 10:30:00|OK|Hello
2|||||No results returned
0|||||Incorrect login name and/or password

33
Virtual Mobile Number Message Removal

Input Parameters

Parameter Name Parameter Description Example

username Username chosen during API access - username

registration.

password Password chosen during API access - password

registration.

mobilenumber The Virtual Mobile Number that you wish to - 04xxxxxxxx

retrieve message from.

messageid Exetel ID returned for a specific message - 2345

when using the Virtual Mobile Number In
Retrieval function.

Virtual Mobile Number Message Removal Example Request:

https://smsgw.exetel.com.au/sendsms/api_sms_mvn_delete.php?username=xxxxxxx
x&password=xxxxxxxx&mobilenumber=04xxxxxxxx&messageid=2345

34
Output Parameters

Parameter Name Parameter Description Example

Status The outcome descriptor of the SMS - 0

message request. - 1
- 2
0: SMS Request Rejected
1: Successfully Deleted
2: Failed

Exetel Notes Additional details regarding the request.

Possible descriptions:
- Deleted
- Mobile Visual Number is disabled
- No mobile virtual number supplied or invalid mobile virtual
- number supplied
- No results returned
- Invalid Message ID
- Incorrect login name and/or password

Virtual Mobile Number Message Removal Example Return Response:

1|Deleted
2|No results returned
0|Incorrect login name and/or password

35
APPENDIX A: HTTP Character Encoding

ASCII Value URL-encode ASCII Value URL-encode

backspace %08 A %41

tab %09 B %42
linefeed %0A C %43
creturn %0D D %44
space %20 E %45
! %21 F %46
" %22 G %47
# %23 H %48
$ %24 I %49
% %25 J %4A
& %26 K %4B
' %27 L %4C
( %28 M %4D
) %29 N %4E
* %2A O %4F
+ %2B P %50
, %2C Q %51
- %2D R %52
. %2E S %53
/ %2F T %54
0 %30 U %55
1 %31 V %56
2 %32 W %57
3 %33 X %58
4 %34 Y %59
5 %35 Z %5A
6 %36 [ %5B
7 %37 \ %5C
8 %38 ] %5D
9 %39 ^ %5E
: %3A _ %5F
; %3B ` %60
< %3C
= %3D
> %3E
? %3F
@ %40

36
 ASCII Value URL-encode ASCII Value URL-encode

a %61 ¼ %BC
b %62 ½ %BD
c %63 ¿ %BF
d %64 À %C0
e %65 Á %C1
f %66 Â %C2
g %67 Ã %C3
h %68 Ä %C4
i %69 Å %C5
j %6A Æ %C6
k %6B Ç %C7
l %6C È %C8
m %6D É %C9
n %6E Ê %CA
o %6F Ë %CB
p %70 Ì %CC
q %71 Í %CD
r %72 Î %CE
s %73 Ï %CF
t %74 Ð %D0
u %75 Ñ %D1
v %76 Ò %D2
w %77 Ó %D3
x %78 Ô %D4
y %79 Õ %D5
z %7A Ö %D6
{ %7B Ø %D8
| %7C Ù %D9
} %7D Ú %DA
~ %7E Û %DB
¢ %A2 Ü %DC
£ %A3 Ý %DD
¥ %A5 Þ %DE
| %A6 ß %DF
§ %A7 à %E0
« %AB á %E1
¬ %AC â %E2
¯ %AD ã %E3
º %B0 ä %E4
± %B1 å %E5
ª %B2 æ %E6
, %B4 ç %E7
µ %B5 è %E8
» %BB é %E9

37
 ASCII ​
Value URL-encode ASCII Value URL-encode

ê %EA ö %F6
ë %EB ÷ %F7
ì %EC ø %F8
í %ED ù %F9
î %EE ú %FA
ï %EF û %FB
ð %F0 ü %FC
ñ %F1 ý %FD
ò %F2 þ %FE
ó %F3 ÿ %FF
ô %F4 õ %F5

38