Mercurial > prosody-wiki

annotate mod_sms_clickatell.wiki @ 170:646b770eb1c3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Created wiki page for mod_sms_clickatell through web user interface.
author phil.stewart@gmail.com
date Thu, 24 Mar 2011 20:20:15 +0000
parents
children 2830f393c193
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
170
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
1 #summary XMPP to SMS gateway using the Clickatell API
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
2 #labels Stage-Alpha
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
3
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
4 = Introduction =
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
5
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
6 This module provides and SMS gateway component which uses the Clickatell HTTP API to deliver text messages. See clickatell.com for details on their services. Note that at present, this is entirely one way: replies will either go nowhere or as sms to the source number you specify.
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
7
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
8 = Configuration =
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
9
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
10 In prosody.cfg.lua:
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
11
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
12 {{{
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
13 Component "sms.example.com" "sms_clickatell"
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
14 clickatell_api_id = [api id]
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
15 sms_source_number = [source number]
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
16 sms_message_prefix = "some text"
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
17 }}}
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
18
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
19 The clickatell_api_id is a number which is your Clickatell HTTP API ID. In future this will likely be migrated out of config in to component
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
20 registration.
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
21
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
22 The sms_source_number is the mobile number you want messages to 'originate' from i.e. where your recipients see messages coming from. This should really be per-user configurable, so again will be moved tp component registration in future. The number should be in international format without leading plus sign, or you can use some other format if clickatell supports it.
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
23
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
24 The sms_message_prefix is a piece of text you want prefixing to all messages sent through the gateway. For example, I use the prefix "[Via XMPP] " to indicate to recipients that I've sent the message via the internet rather than the mobile network. Since my primary use case for this component is to be able to send messages to people only reachable via mobile when I myself only have internet access and no mobile reception, this option allows me to give a hint to my recipients that any reply they send may not reach me in a timely manner.
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
25
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
26 = Usage =
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
27
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
28 Once you've installed and configured, you should be able to use service discovery in your XMPP client to find the component service. Once found, you need to register with the service, supplying your Clickatell username and password (in future service registration will also include the API ID and the source number).
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
29
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
30 To send text messages to a target number, you need to add a contact in the form of [number]@sms.example.com, where [number] is the mobile number of the recipient, in international format without leading plus sign, and sms.example.com is the name for the component you configured above. For example:
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
31
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
32 447999000001@sms.yourdomain.com
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
33
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
34 You should then be able to send messages to this contact which get sent as text messages to the number by the component.
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
35
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
36 = Compatibility =
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
37
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
38 ||0.7||Works||
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
39
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
40 = Todo =
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
41
646b770eb1c3 Created wiki page for mod_sms_clickatell through web user interface.
phil.stewart@gmail.com
parents:
diff changeset
42 * Move API ID and sms source number out of config and in to component registration