-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathuser-guide.html
522 lines (401 loc) · 32.9 KB
/
user-guide.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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>User Guide — DialerAI 7.11.14 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/dialerai.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Quick Start" href="user-guide/quickstart.html" />
<link rel="prev" title="Introduction" href="introduction.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html">
<img src="_static/logo_dialerAI_negative.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#utility">Utility</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#pricing">Pricing</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#contact-us">Contact Us</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user-guide/quickstart.html">Quick Start</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/quickstart.html#create-phonebook">Create Phonebook</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/quickstart.html#add-contacts">Add Contacts</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/quickstart.html#add-survey">Add Survey</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/quickstart.html#configure-campaign">Configure Campaign</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/quickstart.html#start-the-campaign">Start The Campaign</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/customer-panel.html">Customer Panel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer-panel.html#login-page">Login Page</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer-panel.html#dashboards">Dashboards</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer-panel.html#campaign">Campaign</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer-panel.html#contacts">Contacts</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer-panel.html#reporting">Reporting</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer-panel.html#modules">Modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer-panel.html#user-account">User Account</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/survey-nodes.html">Survey & IVR Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#create-survey">Create Survey</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#survey-nodes">Survey Nodes</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#survey-completion-retry">Survey Completion Retry</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#dtmf-input-with-audio">DTMF input with Audio</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#tts-or-audio-file">TTS or Audio file</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#tag-substitution-with-tts">Tag Substitution with TTS</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#capture-digits">Capture Digits</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#conference">Conference</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#dnc">DNC</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#hangup">Hangup</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#multi-choice">Multi-Choice</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#play-message">Play Message</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#rating-question">Rating Question</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#record-message">Record Message</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#sms-message">SMS Message</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#call-transfer">Call Transfer</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#http-api">HTTP API</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#http-api-async-non-blocking">HTTP API Async (Non Blocking)</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#asr-speech-recognition">ASR (Speech Recognition)</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#survey-branching">Survey Branching</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/survey-nodes.html#uploading-audio-files">Uploading Audio Files</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/contacts.html">Contacts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/contacts.html#phonebook">Phonebook</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/contacts.html#contact">Contact</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/contacts.html#import-contacts">Import Contacts</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/contacts.html#alternative-numbers">Alternative Numbers</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/contacts.html#additional-parameters-json">Additional parameters (JSON)</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/contacts.html#special-function-additional-parameters-keywords-json">Special Function Additional parameters keywords (JSON)</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/contacts.html#failed-imports">Failed Imports</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/voice-campaign.html">Voice Campaign</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/voice-campaign.html#add-new-campaign">Add New Campaign</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/voice-campaign.html#dialer-tab">Dialer Tab</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/voice-campaign.html#voicemail-settings">Voicemail Settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/voice-campaign.html#schedule">Schedule</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/voice-campaign.html#extra">Extra</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/voice-campaign.html#list-campaigns">List Campaigns</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/sms-campaign.html">SMS Campaign</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/sms-campaign.html#create-a-phonebook">Create a Phonebook</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/sms-campaign.html#add-or-import-contacts">Add or Import Contacts</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/sms-campaign.html#add-sms-campaign">Add SMS Campaign</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/sms-campaign.html#reporting">Reporting</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/inbound.html">Inbound Calling</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/inbound.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/inbound.html#did-configuration">DID Configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/inbound.html#inbound-campaign">Inbound Campaign</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/reports.html">Reports</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/reports.html#call-detail-reports-cdr">Call Detail Reports (CDR)</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/reports.html#survey-reports">Survey Reports</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/reports.html#subscriber-reports">Subscriber Reports</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/reports.html#sms-reports">SMS Reports</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/dashboard.html">Dashboard</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/dashboard.html#voice-dashboard">Voice Dashboard</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/dashboard.html#definitions">Definitions:</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/dashboard.html#sms-dashboard">SMS Dashboard</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/customer_faq.html">Customer FAQ</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer_faq.html#campaign-won-t-start">Campaign won’t start</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer_faq.html#i-ve-edited-the-survey-but-changes-aren-t-applied-to-my-running-campaign">I’ve Edited the Survey, but Changes Aren’t Applied to my Running Campaign</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer_faq.html#i-ve-started-the-campaign-but-it-s-not-made-any-calls">I’ve started the campaign, but it’s not made any calls.</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/customer_faq.html#i-want-to-call-my-contacts-at-sociable-times-across-multiple-time-zones">I Want to Call my Contacts at Sociable Times Across Multiple Time Zones.</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/call-center.html">Call-Center</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#overview">1. Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#agents">2. Agents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#editing-the-agent">Editing the Agent</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#registering-a-sip-phone">Registering a SIP Phone</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#short-codes">Short Codes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#transfer-list">3. Transfer List</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#call-center-config">4. Call-Center Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#agent-s-lead-dispostions">5. Agent’s Lead Dispostions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#outbound-calling">Outbound Calling</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#queue">6. Queue</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#callcenter-campaign">7. Callcenter Campaign</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#tab-general-settings">Tab general settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#tab-dialer-settings">Tab dialer settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#tab-retry-settings">Tab retry settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#tab-voicemail-settings">Tab voicemail settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#tab-schedule-settings">Tab schedule settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-guide/call-center.html#tab-extra-settings">Tab extra settings</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#use-queue-within-an-ivr">8. Use Queue within an IVR</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#regulating-calls-according-to-agents-available">9. Regulating Calls According to Agents available</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-guide/call-center.html#reporting">10. Reporting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="agentui/agentui.html">CallCenter Agent Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="agentui/agentui.html#introduction-to-the-agent-interface">Introduction to the Agent Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="agentui/agentui.html#logging-on-to-the-agent-interface">Logging on to the Agent Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="agentui/agentui.html#logging-on-to-the-queue-1001">Logging on to the Queue (1001)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="agentui/agentui.html#instant-answer-1002-1004">Instant Answer (1002 & 1004)</a></li>
<li class="toctree-l3"><a class="reference internal" href="agentui/agentui.html#logging-out-1000">Logging Out (1000)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="agentui/agentui.html#receiving-calls">Receiving Calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="agentui/agentui.html#agent-interface-functions">Agent Interface Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="agentui/agentui.html#agent-interface-sidebar">Agent Interface Sidebar</a><ul>
<li class="toctree-l3"><a class="reference internal" href="agentui/agentui.html#xfer">Xfer</a></li>
<li class="toctree-l3"><a class="reference internal" href="agentui/agentui.html#making-calls-with-the-webphone">Making Calls with the Webphone</a></li>
<li class="toctree-l3"><a class="reference internal" href="agentui/agentui.html#external-sip-phone">External SIP Phone</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="admin-guide.html">Admin Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="admin-guide/SMS-config.html">SMS Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/SMS-config.html#configuration">Configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/SMS-config.html#messages">Messages</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="admin-guide/billing-module.html">SMS & Call Billing Module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/billing-module.html#sms-call-billing">SMS & Call Billing</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/billing-module.html#payments">Payments</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/billing-module.html#braintree">Braintree</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/billing-module.html#technical">Technical</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="admin-guide/dialer-settings.html">Dialer Settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/dialer-settings.html#add-dialer-settings">Add Dialer Settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/dialer-settings.html#apply-dialer-settings-and-gateway-to-use">Apply Dialer Settings and Gateway to Use</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="admin-guide/add-user.html">Add User</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/add-user.html#add-manager">Add Manager</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/add-user.html#hijack-user">Hijack User</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="admin-guide/admin-panel.html">Admin Panel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#dashboard">Dashboard</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#admin-user-management">Admin User Management</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#customers">Customers</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#sites">Sites</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#phonebook">Phonebook</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#contact">Contact</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#campaign">Campaign</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#subscriber">Subscriber</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#dialer-settings">Dialer Settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#dialer-gateway">Dialer Gateway</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#survey">Survey</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#call-request">Call Request</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#call-contacts-subscribers">Call contacts/subscribers</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin-guide/admin-panel.html#voip-call-report">VoIP Call Report</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configuration/advanced-configuration-guide.html">Advanced</a><ul>
<li class="toctree-l3"><a class="reference internal" href="advanced-configuration/microsoft-tts-asr.html">Setting up Microsoft Azure Speech Services (ASR/TTS)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="advanced-dev/streaming-callcenter-events.html">Streaming Call-Center Events</a><ul>
<li class="toctree-l3"><a class="reference internal" href="advanced-dev/streaming-callcenter-events.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="advanced-dev/streaming-callcenter-events.html#pub-sub-redis">Pub/Sub Redis</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="gateway-config.html">Setting up VoIP Telecoms Carriers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gateway-config.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="gateway-config.html#terms-and-conditions">Terms and Conditions</a></li>
<li class="toctree-l2"><a class="reference internal" href="gateway-config.html#voxtelesys">Voxtelesys</a></li>
<li class="toctree-l2"><a class="reference internal" href="gateway-config.html#twilio">Twilio</a></li>
<li class="toctree-l2"><a class="reference internal" href="gateway-config.html#telnyx">Telnyx</a></li>
<li class="toctree-l2"><a class="reference internal" href="gateway-config.html#voxbeam">Voxbeam</a></li>
<li class="toctree-l2"><a class="reference internal" href="gateway-config.html#vitelity-inteliquent">Vitelity / Inteliquent</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-reference.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api-doc/contact_serializers.html"><cite>Contact API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/phonebook_serializers.html"><cite>Phonebook API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/campaign_serializers.html"><cite>Campaign API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/cdr_serializers.html"><cite>CDR API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/subscriber_list_serializers.html"><cite>SubscriberList API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/user_serializers.html"><cite>User API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/dnc_serializers.html"><cite>DNC API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/dnc_contact_serializers.html"><cite>DNCContact API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/callerid_serializers.html"><cite>CallerID API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/callerid_group_serializers.html"><cite>CallerID Group API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/gateway_serializers.html"><cite>Gateway API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/callcenter_config_serializers.html"><cite>Callcenter Config API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/queue_serializers.html"><cite>Queue API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/agent_serializers.html"><cite>Agent API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/survey_template_serializers.html"><cite>Survey Template API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/section_template_serializers.html"><cite>SectionTemplateSerializer</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/section_template_serializers.html#section-template-api"><cite>Section Template API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/branching_template_serializers.html"><cite>Branching Template API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/survey_serializers.html"><cite>Survey API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/sms_campaign_serializers.html"><cite>SMS Campaign API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/sms_gateway_serializers.html"><cite>SMSGateway API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/payment_serializers.html"><cite>Payment API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/audiofile_serializers.html"><cite>Audio API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/userprofile_serializers.html"><cite>UserProfile API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/content_type_serializers.html"><cite>Content Type API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/did_serializers.html"><cite>DID API</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/how_create_survey_campaign_via_api.html">How to create an IVR/Survey via API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api-doc/how_create_survey_campaign_via_api.html#upload-audio-via-api">1) Upload audio Via API</a></li>
<li class="toctree-l3"><a class="reference internal" href="api-doc/how_create_survey_campaign_via_api.html#create-a-survey-template">2) Create a Survey Template</a></li>
<li class="toctree-l3"><a class="reference internal" href="api-doc/how_create_survey_campaign_via_api.html#create-a-section-into-your-survey-template">3) Create a Section into your Survey Template</a></li>
<li class="toctree-l3"><a class="reference internal" href="api-doc/how_create_survey_campaign_via_api.html#create-a-campaign-for-the-previously-created-survey-template">4) Create a campaign for the previously created Survey Template</a></li>
<li class="toctree-l3"><a class="reference internal" href="api-doc/how_create_survey_campaign_via_api.html#start-the-campaign-via-api">5) Start the campaign via API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api-doc/create_more_complex_ivr_api.html">Create a complex IVR/Survey via API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api-doc/create_more_complex_ivr_api.html#create-a-section-into-your-survey-template">1) Create a Section into your Survey Template</a></li>
<li class="toctree-l3"><a class="reference internal" href="api-doc/create_more_complex_ivr_api.html#create-branching-into-your-survey-template">2) Create Branching into your Survey Template</a></li>
<li class="toctree-l3"><a class="reference internal" href="api-doc/create_more_complex_ivr_api.html#closing-remark">3) Closing remark</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="webhook.html">Webhook</a><ul>
<li class="toctree-l2"><a class="reference internal" href="webhook.html#fields-information">Fields information</a></li>
<li class="toctree-l2"><a class="reference internal" href="webhook.html#payload-sample">Payload sample</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">DialerAI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>User Guide</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="user-guide">
<span id="id1"></span><h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h1>
<p>DialerAI is a powerful SMS and Voice Broadcasting system which can be installed on dedicated servers or cloud servers. The underlying telephony engine is Freeswitch, and it is designed to send calls via VoIP using the SIP protocol and is compatible with nearly all SIP carriers.</p>
<p>DialerAI comes installed with a web interface to allow the easy configuration of market messages, surveys and campaigns.</p>
<p><strong>Features</strong></p>
<blockquote>
<div><ul class="simple">
<li>Restful-API based to easily integrate the platform dialer with third-party applications</li>
<li>Web-based administrative/customer interfaces</li>
<li>Lower operating costs</li>
<li>Calls are made through Internet VoIP. No need for telephony hardware</li>
<li>Call reports and Statistics</li>
</ul>
</div></blockquote>
<p>The following user documentation will cover:</p>
<blockquote>
<div><ul class="simple">
<li>A quick start guide to cover the basics</li>
<li>A detailed guide to the purpose of all the survey nodes</li>
<li>The customer panel</li>
<li>Creating phonebooks and contacts</li>
<li>Configuring voice and SMS campaigns</li>
<li>Reports</li>
<li>The dashboard</li>
</ul>
</div></blockquote>
<p>We suggest you follow the quick start guide to get an overview of the system, then start creating your own surveys and campaigns.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="user-guide/quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/customer-panel.html">Customer Panel</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/survey-nodes.html">Survey & IVR Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/contacts.html">Contacts</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/voice-campaign.html">Voice Campaign</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/sms-campaign.html">SMS Campaign</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/inbound.html">Inbound Calling</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/reports.html">Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/dashboard.html">Dashboard</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/customer_faq.html">Customer FAQ</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="user-guide/quickstart.html" class="btn btn-neutral float-right" title="Quick Start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="introduction.html" class="btn btn-neutral" title="Introduction" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2011-2022, DialerAI Inbound & Outbuond Call-Center Solution <sales@dialer.ai>
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-325034-18");
pageTracker._trackPageview();
} catch(err) {}</script>
</body>
</html>