Versions Compared

Version Old Version 5 New Version 6
Changes made by

Jan Varga (Unlicensed)

Jan Varga (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

The XML HTTP API has been deprecated.
Please ensure that all new customers us the Web Services API
The XML HTTP API is described here for customers who are already using it.

...

<SMS/>

 

<HEADER/>

this is the source address of the message
(this field should be set to the value
provided to you by Amethon)

<FOOTER/>

optional text to be appended to each message

...

<MESSAGE/>

id is for custom message id, optional.

<ADDRESS/>

id is for custom address id, optional.

  • role must have value TO.
  • type should be set to SMS.
  • value should contain the recipient phone
    number (in international format).

<BODY/>

(see examples)

<PAYLOAD/>

(see examples)

...

Element

Attributes

Type

Required

DEFAULT/(DESCRIPTION)

<DOCUMENT>
- <SENDER>
- <REPLYTO>?
- <SMS>?
- <MESSAGE>+

ID

STRING

No

(assigned by message core)

 

TIMESTAMP

STRING

No

(assigned by message core)

 

MODE

STRING
[NORMAL
|TEST]

No

NORMAL
(when MODE is set to TEST, message will not be delivered)

 

VERSION

STRING

No

 

 

STATUS

STRING
[ACCEPTED
|REJECTED]

No

 

 

REASON

STRING

No

 

<SENDER>
- <ADDRESS>

PASSWORD

STRING

No

(this is your Amethon password)

 

 

 

 

(the attributes TYPE, ROLE and VALUE in <ADDRESS> must be provided as follow:
TYPE = "EMAIL"
ROLE = "FROM"
VALUE = email address)

<REPLYTO>
- <ADDRESS>

 

 

 

(the attributes TYPE, ROLE and VALUE in <ADDRESS> must be provided as follow:
TYPE = "EMAIL"
ROLE = "REPLYTO"
VALUE = email address)

<SMS>
- <HEADER>
- <FOOTER>

 

 

 

(SMS specific features)

<HEADER>

 

STRING

No

(up to 11 ASCII characters that can be used instead of the senders mobile phone number (or instead of amethon.com). Dependent on carrier)

<FOOTER>

 

STRING

No

(appended to each message. Note that long messages will be truncated to accommodate the footer)

<MESSAGE>
- <ADDRESS>+
- <SUBJECT>?
- <BODY>

ID

STRING

No

 

 

PRIORITY

NUMBER

No

 

 

 

 

 

(the attributes TYPE, ROLE and VALUE in <ADDRESS> must be provided as follow:
TYPE = "SMS"
ROLE = "TO"
VALUE = recipient phone number starting 04)

<ADDRESS>

ID

STRING

No

 

 

TYPE

STRING
[SMS
|EMAIL
|FAX]

Yes

 

 

ROLE

STRING
[FROM
|TO
|CC
|BCC
|REPLYTO
|FORWARD]

Yes

 

 

VALUE

STRING

Yes

 

 

TIMESTAMP

STRING

No

 

 

STATUS

STRING
[INIT
|ACK
|DELIVERED]

No

 

 

REASON

STRING

No

 

 

PRIORITY

NUMBER

No

 

<SUBJECT>

 

STRING

No

(email subject(not used for SMS))

<BODY>
- <PAYLOAD>

TYPE

STRING
[TEXT
|IMAGE]

Yes

TEXT

<PAYLOAD>

 

STRING

Yes

(body payload – the actual data. text of message to send. Note max message + footer = 160 chars)

 

type

STRING
[TEXT
|RINGTONE
|LOGO
|MOTOROLA
|OTT
|RTTTL
|GIF
|BITMAP]

Yes

 

 

encoding

STRING
[ASCII
|BASE64
|HEX]

Yes

 

 

width

NUMBER

For LOGO, GIF & BITMAP

Width in pixels. Normally 72 for Nokia phones

 

height

NUMBER

 

Height in pixels. Normally 14 for LOGO or 28 for PICTURE message

 

depth

NUMBER

 

Bits per pixel. Normally 1

 

mcc

NUMBER

For LOGO

Country code:
For example:
505: Australia

 

mnc

NUMBER

 

Network code:
For example:
01: Telstra
02: Optus
03: Vodafone


-