-
Notifications
You must be signed in to change notification settings - Fork 9
/
api-reference.html
163 lines (153 loc) · 9.7 KB
/
api-reference.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
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API Reference — Newfies-Dialer 7.11.14 documentation</title>
<link rel="stylesheet" href="_static/newfies-dialer.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/dialerai.css" />
<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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Contact API" href="api-doc/contact_serializers.html" />
<link rel="prev" title="Setting up VoIP Telecoms Carriers" href="gateway-config.html" />
</head><body>
<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="api-doc/contact_serializers.html" title="Contact API"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="gateway-config.html" title="Setting up VoIP Telecoms Carriers"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Newfies-Dialer 7.11.14 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="api-reference">
<span id="id1"></span><h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api-doc/contact_serializers.html"><cite>Contact API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/phonebook_serializers.html"><cite>Phonebook API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/campaign_serializers.html"><cite>Campaign API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/cdr_serializers.html"><cite>CDR API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/subscriber_list_serializers.html"><cite>SubscriberList API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/user_serializers.html"><cite>User API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/dnc_serializers.html"><cite>DNC API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/dnc_contact_serializers.html"><cite>DNCContact API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/callerid_serializers.html"><cite>CallerID API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/callerid_group_serializers.html"><cite>CallerID Group API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/gateway_serializers.html"><cite>Gateway API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/callcenter_config_serializers.html"><cite>Callcenter Config API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/queue_serializers.html"><cite>Queue API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/agent_serializers.html"><cite>Agent API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/survey_template_serializers.html"><cite>Survey Template API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/section_template_serializers.html"><cite>SectionTemplateSerializer</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/section_template_serializers.html#section-template-api"><cite>Section Template API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/branching_template_serializers.html"><cite>Branching Template API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/survey_serializers.html"><cite>Survey API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/sms_campaign_serializers.html"><cite>SMS Campaign API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/sms_gateway_serializers.html"><cite>SMSGateway API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/payment_serializers.html"><cite>Payment API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/audiofile_serializers.html"><cite>Audio API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/userprofile_serializers.html"><cite>UserProfile API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/content_type_serializers.html"><cite>Content Type API</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/did_serializers.html"><cite>DID API</cite></a></li>
</ul>
</div>
<p>Extended documentation on how to create an IVR/Survey via APIs:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api-doc/how_create_survey_campaign_via_api.html">How to create an IVR/Survey via API</a></li>
<li class="toctree-l1"><a class="reference internal" href="api-doc/create_more_complex_ivr_api.html">Create a complex IVR/Survey via API</a></li>
</ul>
</div>
<p>Testing console of APIs:</p>
<blockquote>
<div><strong>URL</strong> : <a class="reference external" href="http://HOSTNAME_IP/rest-api/">http://HOSTNAME_IP/rest-api/</a></div></blockquote>
<a class="reference internal image-reference" href="_images/list_of_api.png"><img alt="_images/list_of_api.png" src="_images/list_of_api.png" style="width: 700px;" /></a>
<p>To inspect the available APIs, click on a link from above API list:</p>
<blockquote>
<div><strong>URL</strong> : <a class="reference external" href="http://HOSTNAME_IP/rest-api/phonebook/">http://HOSTNAME_IP/rest-api/phonebook/</a></div></blockquote>
<a class="reference internal image-reference" href="_images/phonebook_playground.png"><img alt="_images/phonebook_playground.png" src="_images/phonebook_playground.png" style="width: 700px;" /></a>
</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="_static/logo-newfies-dialer-name-300.png" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="gateway-config.html"
title="previous chapter">Setting up VoIP Telecoms Carriers</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="api-doc/contact_serializers.html"
title="next chapter"><cite>Contact API</cite></a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<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>
</div>
</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="api-doc/contact_serializers.html" title="Contact API"
>next</a> |</li>
<li class="right" >
<a href="gateway-config.html" title="Setting up VoIP Telecoms Carriers"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Newfies-Dialer 7.11.14 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011-2022, Newfies-Dialer mass outbound calling, voice broadcasting, phone survey solution <[email protected]>.
</div>
<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>