-
Notifications
You must be signed in to change notification settings - Fork 18
/
dialer.py
199 lines (171 loc) · 7.15 KB
/
dialer.py
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
"""
An example auto-dialer
"""
# Author: Nenad Corbic <[email protected]>
#
# IVR Dialer demonstrates how to launch one or more outbound campaigns using
# FreeSWITCH or Sangoma NetBorder Appliance.
# IVR Dialer peformsn the following
# 1. Connect to Sangoma NetBorder VoIP Gateway
# 2. Load user defined IVRCallControl application that
# will be in charge of the each connected call.
# 3. Accept user camapign configuration
# Number of calls to dial, what did to user per call
# Number of calls per sec
# 4. Call IVRCallControl applicatoin per call.
#
# All user logic should be defined in IVRCallLogic Class!
# The IVRCallLogic is defined in ivr_call_logic.py example.
#
# License:
# BSD License
# http://opensource.org/licenses/bsd-license.php
#
# Copyright (c) 2015, Sangoma Technologies Inc
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 1. Developer makes use of Sangoma NetBorder Gateway or Sangoma Session
# Border Controller
# 2. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# 3. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
import time
import switchy
from switchy import get_originator
from call_logic import IVRCallLogic
def create_url():
"""Replacement field callback
NOTE: Developer is suppose to supply their own DID from a list or DB
Make an outbound call
This function will be called by originator for each call
User is supposed to provide the outbound DID or SIP URL for each call
SIP Call:
dest_url='[email protected]' Remote SIP URI
dest_profile='internal' NSG defined SIP profile name
dest_endpoint='sofia' For SIP calls one MUST set sofia
FreeTDM Call:
dest_url='[A,a]/did' A=ascending hunt, a=descending hunt, DID number
dest_profile='g1' profile is used as trunk group definition
(eg. g1 == group 1)
endpoint='freetdm" For TDM calls on MUST set freetdm
In this example we are making a FreeTDM Call.
Change True to False in order to make SIP calls.
"""
# if statement is just an easy way to switch between one or the other
if True:
# Make a FreeTDM SS7/PRI Call
# Adding F at the end of the DID disables remote SS7 overlap dialing
# which can add 5 sec to the incoming call setup time.
return {
'dest_url': 'a/1000F',
'dest_profile': 'g1',
'dest_endpoint': 'freetdm',
'caller_id': "'Sangoma Technologies'",
'caller_id_num': '9054741990'
}
else:
# Make a SIP Call
return {
'dest_url': '[email protected]:6060',
'dest_profile': 'internal',
'dest_endpoint': 'sofia',
'caller_id': "'Sangoma Technologies'",
'caller_id_num': '9054741990'
}
def main(
# Specify FreeSWITCH or Sangoma NSG IP information.
# In this example the sample app is running on
# Sangoma NSG appliance hence the use of local loopback address
host="127.0.0.1",
port=8821,
# Specify campaign settings
max_calls_per_campaign=1,
max_call_attempts_per_sec=1,
max_campaigns=1,
):
"""Run an auto-dialer and manage campaigns.
Create an 'originator' to use as an auto-dialer.
You can tell it how many calls to make and at what frequency.
After the first batch of calls are complete, you can choose to start
dialing again.
There are 3 configurable dialer variables:
- max_calls_per_campaign
- max_call_attempts_per_sec
- max_campaigns
In this example the dialer will by default make 1 outbound call on the
first campaign. The `max_campaigns` variable, determines the number of
times the dialer will repeat campaigns.
"""
# Enable logging to stderr
# Debug levels: 'INFO' for production, 'DEBUG' for development
loglevel = 'INFO'
log = switchy.utils.log_to_stderr(loglevel)
# create an auto-dialer and load our IVRCallLogic switchy app
originator = get_originator(
[(host, port)],
apps=(IVRCallLogic,),
auto_duration=False,
rep_fields_func=create_url
)
# Initialize dial variables in order for switchy to trigger create_url()
# function above.
# The create_url function is a callback which has the task of specifying
# the dial information per call (i.e. it is called once for each call).
originator.pool.evals(
("""client.set_orig_cmd(
dest_url='{dest_url}',
profile='{dest_profile}',
endpoint='{dest_endpoint}',
caller_id='{caller_id}',
caller_id_num='{caller_id_num}',
app_name='park')""")
)
# Enables debugging on NetBorder VoIP Gateway
if loglevel == 'DEBUG':
originator.pool.evals(
("""client.set_loglevel('DEBUG')""")
)
# Setup calls per sec
originator.rate = max_call_attempts_per_sec
# Setup maximum number of calls to make
# max erlangs / simultaneous calls
originator.limit = max_calls_per_campaign
# Maximum number of calls to dial out
originator.max_offered = max_calls_per_campaign
# Start the initial campaign - Originator will start making outbound calls
originator.start()
# Keeps a count of campaigns
campaign_cnt = 0
# Here is an example of how to keep an eye on the campaign.
# After the campaign is over, check to see if another campaign should start
while (True):
if originator.stopped() and originator.count_calls() == 0:
log.info(originator) # log state info and current load
# Check to see if we should run another camapign
campaign_cnt += 1
if campaign_cnt >= max_campaigns:
break
log.info("Starting new campaign\n")
# We must increase the max allowed calls in order
# for dialer to initiate another max_calls_per_campaign
originator.max_offered += max_calls_per_campaign
originator.start()
time.sleep(1)
log.info("All campaigns done: stopping...\n")
originator.shutdown()