forked from newfies-dialer/newfies-dialer-enterprise
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sms-configure.html
206 lines (195 loc) · 11.1 KB
/
sms-configure.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>SMS Configuration — Newfies-Dialer 3.0.4 documentation</title>
<link rel="stylesheet" href="_static/newfies-dialer.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Newfies-Dialer 3.0.4 documentation" href="index.html" />
<link rel="next" title="User Guide" href="user-guide.html" />
<link rel="prev" title="Voice Configuration" href="configuration.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="user-guide.html" title="User Guide"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="configuration.html" title="Voice Configuration"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Newfies-Dialer 3.0.4 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="sms-configuration">
<span id="sms-configure"></span><h1>SMS Configuration<a class="headerlink" href="#sms-configuration" title="Permalink to this headline">¶</a></h1>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p>SMS braodcasting is supported as standard by Newfies-Dialer, allowing Newfies-Dialer to send out thousands or millions of SMS messages to contacts.</p>
<p>The SMS gateway supports the following gateways, Clickatell (<a class="reference external" href="http://www.clickatell.com/">http://www.clickatell.com/</a>) and SMSGlobal (<a class="reference external" href="http://www.smsglobal.com">http://www.smsglobal.com</a>). Additionally, Khomp hardware is supported to allow the use of SIM cards in house. See <a class="reference external" href="http://www.khomp.com.br/">http://www.khomp.com.br/</a> for more details.</p>
<p>Go to the Admin interface and identify the SMS Gateway section, and click on Gateways. Listed by default are three gateways, Clickatell, SMSGlobal and Khomp. Those that you don’t want to be configured can be deleted.</p>
<p>Click the gateway to be configured and edit the pre-filled settings and populate the fields with the credentials supplied by your SMS provider:</p>
<p><strong>URL</strong>:</p>
<div class="highlight-python"><div class="highlight"><pre>* http://localhost:8000/admin/sms/gateway/
* http://localhost:8000/admin/sms/gateway/add/
</pre></div>
</div>
<img alt="../_static/images/admin/sms_gateway_list.png" src="../_static/images/admin/sms_gateway_list.png" />
<img alt="../_static/images/admin/update_sms_gateway.png" src="../_static/images/admin/update_sms_gateway.png" />
<div class="section" id="clickatell">
<h3>Clickatell<a class="headerlink" href="#clickatell" title="Permalink to this headline">¶</a></h3>
<p>Clickatell settings:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">"api_id"</span><span class="p">:</span> <span class="s">"_API_ID_"</span><span class="p">,</span>
<span class="s">"password"</span><span class="p">:</span> <span class="s">"_PASSWORD_"</span><span class="p">,</span>
<span class="s">"from"</span><span class="p">:</span> <span class="s">"_SENDER_ID_"</span><span class="p">,</span>
<span class="s">"user"</span><span class="p">:</span> <span class="s">"_USERNAME_"</span><span class="p">,</span>
<span class="s">"concat"</span><span class="p">:</span> <span class="s">"3"</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Edit _API_ID_, _Sender_ID_, _USERNAME_ and _PASSWORD_ to the credentials provided by Clickatell and leave everything else as it is, and click save.</p>
</div>
<div class="section" id="smsglobal">
<h3>SMSGlobal<a class="headerlink" href="#smsglobal" title="Permalink to this headline">¶</a></h3>
<p>The default settings are as follows:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">"from"</span><span class="p">:</span> <span class="s">"_SENDER_ID_"</span><span class="p">,</span>
<span class="s">"maxsplit"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
<span class="s">"api"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s">"user"</span><span class="p">:</span> <span class="s">"_USERNAME_"</span><span class="p">,</span>
<span class="s">"action"</span><span class="p">:</span> <span class="s">"sendsms"</span><span class="p">,</span>
<span class="s">"password"</span><span class="p">:</span> <span class="s">"_PASSWORD_"</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Edit _Sender_ID_, _USERNAME_ and _PASSWORD_ to match the credetials issued by SMSGlobal, leave everything else unchanged and save.</p>
</div>
<div class="section" id="vitelity">
<h3>Vitelity<a class="headerlink" href="#vitelity" title="Permalink to this headline">¶</a></h3>
<p>Vitelity: <a class="reference external" href="http://www.vitelity.com/services_sms/">http://www.vitelity.com/services_sms/</a></p>
<p>You will need to turn on API access for whatever IP your Newfies-Dialer
installation is hosted on, create a shortcode keyword, and set a default
response to that keyword.</p>
<p>Here it’s how you should configure the new SMS Gateway to support Vitelity:</p>
<p>Name:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">SMSvitelity</span>
</pre></div>
</div>
<p>Base URL:</p>
<div class="highlight-python"><div class="highlight"><pre>http://smsout-api.vitelity.net/api.php
</pre></div>
</div>
<p>Set the <cite>Settings</cite> as follow:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">"xml"</span><span class="p">:</span> <span class="s">"yes"</span><span class="p">,</span>
<span class="s">"src"</span><span class="p">:</span> <span class="s">"99629"</span><span class="p">,</span>
<span class="s">"login"</span><span class="p">:</span> <span class="s">"YOUR_VITELITY_API_LOGIN"</span><span class="p">,</span>
<span class="s">"cmd"</span><span class="p">:</span> <span class="s">"sendshort"</span><span class="p">,</span>
<span class="s">"pass"</span><span class="p">:</span> <span class="s">"YOUR_VITELITY_API_PASSWORD"</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Recipient keyword:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">dst</span>
</pre></div>
</div>
<p>Content keyword:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">msg</span>
</pre></div>
</div>
<p>Status mapping:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">"fail"</span><span class="p">:</span> <span class="s">"Error"</span><span class="p">,</span>
<span class="s">"ok"</span><span class="p">:</span> <span class="s">"Sent"</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Success format:</p>
<div class="highlight-python"><div class="highlight"><pre>.*\n*.*\n*.*<status>(?P<status_message>.+)</status>\n*<response>(?P<status_code>.+)</response>(?P<gateway_message_id>.+)
</pre></div>
</div>
</div>
</div>
<div class="section" id="messages">
<h2>Messages<a class="headerlink" href="#messages" title="Permalink to this headline">¶</a></h2>
<p>The messages section in the admin screens shows the status of the messages, e.g. success or failure as well as the status message.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><p class="logo"><a href="index.html">
<img class="logo" src="https://github.com/newfies-dialer/newfies-dialer/raw/develop/newfies/resources/images/newfies-dialer-180.png" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="configuration.html"
title="previous chapter">Voice Configuration</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="user-guide.html"
title="next chapter">User Guide</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="user-guide.html" title="User Guide"
>next</a> |</li>
<li class="right" >
<a href="configuration.html" title="Voice Configuration"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Newfies-Dialer 3.0.4 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011-2015, Arezqui Belaid <info@star2billing.com>.
</div>
</body>
</html>