Mercurial > prosody-modules
comparison mod_sms_clickatell/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 28 Aug 2015 18:03:58 +0200 |
| parents | mod_sms_clickatell/README.wiki@29f3d6b7ad16 |
| children |
comparison
equal
deleted
inserted
replaced
| 1802:0ab737feada6 | 1803:4d73a1a6ba68 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Alpha' | |
| 4 summary: XMPP to SMS gateway using the Clickatell API | |
| 5 ... | |
| 6 | |
| 7 Introduction | |
| 8 ============ | |
| 9 | |
| 10 This module provides and SMS gateway component which uses the Clickatell | |
| 11 HTTP API to deliver text messages. See clickatell.com for details on | |
| 12 their services. Note that at present, this is entirely one way: replies | |
| 13 will either go nowhere or as sms to the source number you specify. | |
| 14 | |
| 15 Configuration | |
| 16 ============= | |
| 17 | |
| 18 In prosody.cfg.lua: | |
| 19 | |
| 20 Component "sms.example.com" "sms_clickatell" | |
| 21 sms_message_prefix = "some text" | |
| 22 | |
| 23 The sms\_message\_prefix is a piece of text you want prefixing to all | |
| 24 messages sent through the gateway. For example, I use the prefix | |
| 25 "`[Via XMPP]` " to indicate to recipients that I've sent the message via | |
| 26 the internet rather than the mobile network. Since my primary use case | |
| 27 for this component is to be able to send messages to people only | |
| 28 reachable via mobile when I myself only have internet access and no | |
| 29 mobile reception, this option allows me to give a hint to my recipients | |
| 30 that any reply they send may not reach me in a timely manner. | |
| 31 | |
| 32 Usage | |
| 33 ===== | |
| 34 | |
| 35 Once you've installed and configured, you should be able to use service | |
| 36 discovery in your XMPP client to find the component service. Once found, | |
| 37 you need to register with the service, supplying your Clickatell | |
| 38 username, password, API ID, and a source number for your text messages. | |
| 39 | |
| 40 The source number is the mobile number you want messages to 'originate' | |
| 41 from i.e. where your recipients see messages coming from. The number | |
| 42 should be in international format without leading plus sign, or you can | |
| 43 use some other format if clickatell supports it. | |
| 44 | |
| 45 To send text messages to a target number, you need to add a contact in | |
| 46 the form of `[number]@sms.example.com`, where `[number]` is the mobile | |
| 47 number of the recipient, in international format without leading plus | |
| 48 sign, and sms.example.com is the name for the component you configured | |
| 49 above. For example: | |
| 50 | |
| 51 447999000001@sms.yourdomain.com | |
| 52 | |
| 53 You should then be able to send messages to this contact which get sent | |
| 54 as text messages to the number by the component. | |
| 55 | |
| 56 Compatibility | |
| 57 ============= | |
| 58 | |
| 59 ----- ------- | |
| 60 0.7 Works | |
| 61 ----- ------- | |
| 62 | |
| 63 Todo | |
| 64 ==== | |
| 65 | |
| 66 - Refactor to create a framework for multiple sms gateway back ends, | |
| 67 and split Clickatell specific code in to its own back end |