Editor, Interface administrators, Administrators
19
edits
This is the support site for Andrews & Arnold Ltd, a UK Internet provider. Information on these pages is generally for our customers but may be useful to others, enjoy!
m (→Overview: clean up, typos fixed: eg → e.g.) |
|||
(31 intermediate revisions by 4 users not shown) | |||
==Overview==
You can send SMS
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
You can also control how incoming
==Inbound==
[[File:InboundSMS.png|none|frame|Inbound SMS option on Control Pages]]
You list one or more ''targets'' for your SMS, separated by a space.
We work out what type of target from the format.
The targets can also be prefixed by a special character to impact the format of how the message is sent. These are currently +, *, or !. (This is an issue for an email address that starts with one of these, but for email the * prefix does nothing, so in the rare case of an email starting with *, !, or +, prefix with a *)
===Email===
You may specify an email address, e.g. ''localpart''@''hostname'' and we'll send the messages by email.
*The prefix format + may be used to force mobile numbers to be E.123 (+ prefix) formatted and an ISO8601 timestamp.
===Toot===
You may specify a fediverse address, e.g. @''name''@''hostname'' to get messages as a toot (''direct mention'').
*The prefix format + may be used to force mobile numbers to be E.123 (+ prefix) formatted and an ISO8601 timestamp.
===Mobile===
You may specify a mobile number (no spaces) to forward an SMS to another number (chargeable).
===HTTP===
If you put an entry starting http:// or https:// then we will attempt to send the
If the URL ends with a ? or & then an HTTP GET is done with a set of form fields (i.e. name=value) containing information about the text. Using & allows you to add some specific fields first (which may be sensible to test the HTTP request came from us). If the URL does not end ? or &, then an HTTP POST is done using URL encoded form data.
The fields posted are as follows, but additional fields may be added from time to time.
{| class="wikitable"
|+Inbound SMS API Fields
! scts
| Service Centre Time Stamp in ISO8601 format
|-
! da
| This is the number to which the message
|-
! ud
| This is the message
|-
!
|-
! ''via''
| (If relayed) the original ''da'' if the message has been forwarded by us from one mobile number to another.
|-
!
|
|-
!
| (If not zero) Data Coding Scheme which we provide in decimal (its a byte)
|-
!
| (If not zero) Protocol Identifier which we provide in decimal (its a byte)
▲| Hex UDH header, see below.
|}
You will note that we have tried to use field names to match GSM 03.40 values. Other values may be included
*The prefix format * may be used to also send the older field names of ''timestamp'', ''originator'', ''destination'', ''message'', but we recommend updating your scripts to use the new field names.
We support UTF-8 coding of the full GSM 7 bit character set (including £$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæÉÄÖÑܧäöñüà€¡¿) and from UCS16 messages and UTF-16 surrogates. Not all of our SMS interconnects handle all of the coding, so we send the message as best we can.
===SIM===
Where we offer SIM services (e.g. SIP2SIM) you can simply put the ICCID (long number starting 89) of the target SIM to have it delivered to the SIM.
==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.
*These can be sent as a URL encoded form data GET
*These can be sent as a URL encoded form data POST
*These can be sent as fields in a POST of a JSON object
{|class="wikitable"
|+
|-
! username
|-
| ''private''
| Marks the message as private,
|-
| ''oa''
| 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. Include a field called xml, e.g. add &xml to the URL for a GET.
===Example===
Example, using curl on linux:
<syntaxhighlight lang="bash">
curl --silent
</syntaxhighlight>
Messages are charged per message part, see our main website for prices.
|