12,270
edits
SMS API: Difference between revisions
m
→Outbound messages
m (→Inbound) |
|||
| (17 intermediate revisions by 3 users not shown) | |||
|
This page contains technical details and as such may be quite long and hard to follow. If you cannot find the details you require please feel free to contact support who can explain things for you. You will also find many other customers on irc who can help with queries. Feel free to send us feedback if you think there are any errors in this page.
==Overview==
You can send SMS messages using our web form or our simple API.
You can use these systems to send an outgoing SMS, e.g. to a friend's mobile on another network. You can also use it to send an SMS message to a SIP2SIM mobile device.
You can also control how incoming SMS messages to your number or SIM are handled. For example, an incoming SMS to you can be sent onwards to your own HTTPS script.
==Inbound==
[[File:InboundSMS.png|none|frame|Inbound SMS option on Control Pages]]
===Email===
You may specify an email address and we'll send the messages by email.
===HTTP===
If you put an entry starting http:// or https:// then we will attempt to send the
The fields posted are as follows, but additional fields may be added from time to time.
{| class="wikitable"
|+Inbound SMS API Fields
|-
! username
We support UTF-8 coding of the full GSM 7 bit character set (including £$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæÉÄÖÑܧäöñüà€¡¿). Whilst one message is normally up to 160 characters some characters are coded using two characters using an ESC prefix in the 7 bit alphabet (€,[,\,],^,{,|,},~). The message will be coded as 7, 8 or 16 bit depending on what you include in the text, and this will impact the number of message parts that may be sent. If you include the invalid UTF-8 sequence 0xC0 0x80, then that includes a null in the message. If you include any unicode characters beyond U+0xFFFF then UTF-16 coding is used and sending of text in is UCS2 format. Not all interconnects or devices understand UTF-16 format.
The response text starts with either ERR: and an error message or OK:
example:
https://your.domain/yourscript.ext
We will then post or get using the field names as above.
==Outbound messages==
We operate an outbound text service that is available to all of our customers that have a VoIP number. To use this service you must have an outgoing password configured in the control pages for the VoIP number.
To send texts you need to issue an HTTP GET or POST to our outbound text gateway https://sms.aa.net.uk/sms.cgi with the following fields as if sent from a form. As the password is sent in plain text you may prefer to use https.
{|class="wikitable"
|+OUtbound SMS API Fields
|-
! username
| This is the phone number as shown on the control pages for your VoIP number in full international format with no spaces.
|-
! password
| The corresponding outgoing password for the <tt>username</tt> as set in the control pages for your VoIP number.
|-
! da
| This is the number to which the message is to be sent and should be a full international format number (however, national format is also accepted). This may be a SIP2SIM ICCID to send direct to a SIM.
|-
! ud
| This is the message to send, encoded in UTF-8.
|- class="e pro"
| ''limit''
| Set this to limit the number of parts that the message may be sent in.
|-
| ''costcentre''
| Optional, up to 10 characters, code that is included in the bill XML data.
|-
| ''private''
| Marks the message as private, see below
|-
| ''oa''
| Sets the sending number (see below). Normally not needed as your <tt>username</tt> is used.
|-
| ''udh''
| Hex UDH header, see [[UDH messages]].
|-
| ''srr''
| Email address or URL for delivery report, see below
|}
Note that we have, again, tried to use GSM 03.40 field names, but alternative field names are supported for now: destination, originator, message.
We support UTF-8 coding of the full GSM 7 bit character set (including £$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæÉÄÖÑܧäöñüà€¡¿). Whilst one message is normally up to 160 characters some characters are coded using two characters using an ESC prefix in the 7 bit alphabet (€,[,\,],^,{,|,},~). The message will be coded as 7, 8 or 16 bit depending on what you include in the text, and this will impact the number of message parts that may be sent. If you include the invalid UTF-8 sequence 0xC0 0x80, then that includes a null in the message. If you include any unicode characters beyond U+0xFFFF then UTF-16 coding is used and sending of text in is UCS2 format. Not all interconnects or devices understand UTF-16 format.
===Response===
The response text starts either ERR: and an error message or OK:
You can choose to have a response back in XML - this makes the service more compatible with Acrobits' Groundwire mobile phone app that is a softphone with SMS capability. Add &xml to the URL.
===Example===
Example, using curl on linux:
<syntaxhighlight lang="bash">
</syntaxhighlight>
Messages are charged per message part, see our main website for prices.
===Delivery reports===
In some cases we can provide a delivery report and indicate progress of a message. However this is not always possible and should not be relied on.
To use this, specify the srr either as an email address or a URL. The URL can include (typically after the ?) a string %code which will be replaced with a number that indicates progress. 1=Delivered, 2=Rejected, 4=Buffered, 8=Accepted by SMSC, and 16=Rejected by SMSC. Other % strings can be used such as %da or %dest as the original destination number, %oa for originator, %ud for the message.
[[Category:SMS]]
| |||