Mercurial > prosody-wiki

comparison mod_sms_clickatell.wiki @ 177:2830f393c193

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_sms_clickatell: Update wiki to reflect changes to component config and registration
author phil.stewart@gmail.com
date Sun, 03 Apr 2011 21:53:55 +0000
parents 646b770eb1c3
children 6257b08d7b1f
comparison
equal deleted inserted replaced
176:8426db59abf0 177:2830f393c193
9 9
10 In prosody.cfg.lua: 10 In prosody.cfg.lua:
11 11
12 {{{ 12 {{{
13 Component "sms.example.com" "sms_clickatell" 13 Component "sms.example.com" "sms_clickatell"
14 clickatell_api_id = [api id]
15 sms_source_number = [source number]
16 sms_message_prefix = "some text" 14 sms_message_prefix = "some text"
17 }}} 15 }}}
18
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
20 registration.
21
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.
23 16
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. 17 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.
25 18
26 = Usage = 19 = Usage =
27 20
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). 21 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, password, API ID, and a source number for your text messages.
22
23 The source number is the mobile number you want messages to 'originate' from i.e. where your recipients see messages coming from. The number should be in international format without leading plus sign, or you can use some other format if clickatell supports it.
29 24
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: 25 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:
31 26
32 447999000001@sms.yourdomain.com 27 447999000001@sms.yourdomain.com
33 28
37 32
38 ||0.7||Works|| 33 ||0.7||Works||
39 34
40 = Todo = 35 = Todo =
41 36
42 * Move API ID and sms source number out of config and in to component registration 37 * Refactor to create a framework for multiple sms gateway back ends, and split Clickatell specific code in to its own back end