forked from usecallmanagernz/usecallmanagernz.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentation-overview.html
More file actions
241 lines (240 loc) · 13 KB
/
documentation-overview.html
File metadata and controls
241 lines (240 loc) · 13 KB
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
<!DOCTYPE html>
<html lang="en">
<head>
<title>Documentation Overview</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no">
<link rel="shortcut icon" href="images/logo.svg">
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto">
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:FILL@0..1">
<link rel="stylesheet" href="includes/theme.css">
<link rel="stylesheet" href="includes/prettify.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<style>
main > article table tr td {
vertical-align: top;
}
main > article table tr + tr td {
padding-top: 25px;
}
</style>
</head>
<body>
<header>
<a href="/"><img src="images/logo.svg" alt=""></a>
<h2><<span>proxy</span>></h2><h1><span>USECALLMANAGER</span>.nz</h1><h2></<span>proxy</span>></h2>
</header>
<main>
<nav>
<ul>
<li><span class="icon selected">home</span> <b>Documentation Overview</b></li>
<li><a href="patching-asterisk.html"><span class="icon">build</span> Patching Asterisk</a></li>
<li><a href="change-log.html"><span class="icon">news</span> Change Log</a></li>
</ul>
<ul>
<li><h3>Network Configuration</h3></li>
<li><a href="dhcp-options.html"><span class="icon">settings_ethernet</span> DHCP Options</a></li>
<li><a href="http-provisioning.html"><span class="icon">file_download</span> HTTP Provisioning</a></li>
<li><a href="tftp-provisioning.html"><span class="icon">file_download</span> TFTP Provisioning</a></li>
</ul>
<ul>
<li><h3>Phone Configuration</h3></li>
<li><a href="sepmac-cnf-xml.html"><span class="icon">settings_phone</span> SEPMAC.cnf.xml</a></li>
<li><a href="dial-template.html"><span class="icon">dialpad</span> Dial Template</a></li>
<li><a href="application-dial-rules.html"><span class="icon">bluetooth</span> Application Dial Rules</a></li>
<li><a href="soft-keys.html"><span class="icon">power_input</span> Soft Keys</a></li>
<li><a href="line-keys.html"><span class="icon">format_list_bulleted</span> Line Keys</a></li>
<li><a href="feature-policy.html"><span class="icon">fact_check</span> Feature Policy</a></li>
<li><a href="network-locale.html"><span class="icon">language</span> Network Locale</a></li>
<li><a href="user-locale.html"><span class="icon">face</span> User Locale</a></li>
<li><a href="load-information.html"><span class="icon">file_upload</span> Firmware Load Information</a></li>
<li><a href="background-images.html"><span class="icon">wallpaper</span> Background Images</a></li>
<li><a href="ring-tones.html"><span class="icon">ring_volume</span> Ring Tones</a></li>
<li><a href="device-security.html"><span class="icon">security</span> Device Security</a></li>
<li><a href="trust-verification.html"><span class="icon">verified</span> Trust Verification</a></li>
<li><a href="certificate-enrollment.html"><span class="icon">card_membership</span> Certificate Enrollment</a></li>
<li><a href="vpn-connection.html"><span class="icon">vpn_key</span> VPN Connection</a></li>
</ul>
<ul>
<li><h3>Asterisk Configuration</h3></li>
<li><a href="sip-peers.html"><span class="icon">dialer_sip</span> SIP Peers</a></li>
<li><a href="sip-notify-commands.html"><span class="icon">settings_power</span> SIP Notify Commands</a></li>
<li><a href="dialplan-extensions.html"><span class="icon">format_list_numbered</span> Dialplan Extensions</a></li>
<li><a href="call-parking.html"><span class="icon">local_parking</span> Call Parking</a></li>
<li><a href="sip-peer-options.html"><span class="icon">code</span> SIPPEER Options</a></li>
<li><a href="rtp-streaming.html"><span class="icon">volume_up</span> RTP Streaming</a></li>
<li><a href="command-line.html"><span class="icon">keyboard_arrow_right</span> Command Line</a></li>
<li><a href="freepbx-integration.html"><span class="icon">view_kanban</span> FreePBX Integration</a></li>
</ul>
<ul>
<li><h3>XML Services</h3></li>
<li><a href="phone-services.html"><span class="icon">settings</span> Phone Services</a></li>
<li><a href="cgi-execute.html"><span class="icon">phone_forwarded</span> CGI Execute</a></li>
</ul>
<ul>
<li><h3>Additional Features</h3></li>
<li><a href="as-feature-events.html"><span class="icon">extension</span> AS Feature Events</a></li>
</ul>
</nav>
<article>
<h1>Documentation Overview</h1>
This documentation describes how to patch Asterisk to support Cisco SIP IP phones as well as how to configure the various features available on those devices. These IP phones require additional proprietary extensions to the SIP protocol to operate correctly and are only designed to operate with Cisco Unified Call Manager.<br>
<br>
Supported devices are the <b>6900</b> series, <b>7800</b> series, <b>7900</b> series, <b>8800</b> series, <b>894X</b> models and <b>9900</b> series.<br>
<br>
Questions may be sent to <a href="mailto:gareth.palmer3@gmail.com"><span class="icon">mail</span> gareth.palmer3@gmail.com</a>. Source code for the project (patch, utilities and documentation) is also available on <a href="https://github.com/usecallmanagernz"><span class="icon">open_in_browser</span> GitHub</a>. If you find this work useful you can make a donation via <a href="https://github.com/sponsors/usecallmanagernz"><span class="icon">favorite</span> GitHub Sponsorship</a>.<br>
<br>
<div class="horizontal-rule"></div>
The patch provides the following features required by the Cisco IP phones that are not available in standard Asterisk.<br>
<br>
<table width="100%">
<tbody>
<tr>
<td width="50%">
<h2>Busy Lamp Field</h2>
Support for busy-lamp-field using unsolicited notifications as the phones do not subscribe to hints. Extensions to PIDF XML support allow representation of ringing and Do Not Disturb states.
</td>
<td width="50%">
<h2>Off Hook Notification</h2>
When taken off-hook the phone will show as being in-use prior to making a call.
</td>
</tr>
<tr>
<td width="50%">
<h2>Call Forward Synchronization</h2>
The Call Forward target is recorded in Asterisk and is set back on the phone when it registers. It is also stored in Asterisk's database and will persist across restarts.
</td>
<td width="50%">
<h2>Do Not Disturb Synchronization</h2>
Publish requests from the phone to change the Do Not Disturb state is now handled by Asterisk and will be set back on the phone when it registers. It is also stored in Asterisk's database and will persist across restarts.
</td>
</tr>
<tr>
<td width="50%">
<h2>Ad-Hoc Conferencing</h2>
Dynamic server-side conferences can be created allowing more than 3 participants. Other Cisco phones can be made administrators when they join the conference.
</td>
<td width="50%">
<h2>Conference Management</h2>
Participants in ad-hoc conferences can be added, viewed, muted or removed from the conference by any of the conference administrators.
</td>
</tr>
<tr>
<td width="50%">
<h2>Call Parking</h2>
Both Park and Park Monitor methods are supported allowing single button parking. The parking extension is displayed on the phone's screen.
</td>
<td width="50%">
<h2>Hunt Group Login</h2>
Hunt-group login state is recorded in Asterisk and made available to the dial-plan. It will be set back on the phone when it registers. It is also stored in Asterisk's database and will persists across restarts.
</td>
</tr>
<tr>
<td width="50%">
<h2>Immediate Divert</h2>
Incoming calls can be sent a busy signal, connected calls can be diverted to specific extension.
</td>
<td width="50%">
<h2>Call Recording</h2>
Call recording can be initiated from the phone and does not require Asterisk to be in the media path.
</td>
</tr>
<tr>
<td width="50%">
<h2>Multiple Lines</h2>
Support for multiple lines using bulk-registration as the phones only register their first line. Additional secondary lines are automatically registered.
</td>
<td width="50%">
<h2>Call Pickup Notification</h2>
Display the from and to caller-ID numbers and play a beep tone when there an incoming call available for pickup on another phone.
</td>
</tr>
<tr>
<td width="50%">
<h2>RTP Streaming</h2>
Stream audio to multiple phones either via unicast or multicast RTP.
</td>
<td width="50%">
<h2>Command Line</h2>
Call Forward, Do Not Disturb and Hunt Group Login states can be changed using Asterisk CLI. Changes will automatically update the phone.
</td>
</tr>
<tr>
<td width="50%">
<h2>Device Secuirty</h2>
Phones can load X509 certificates to verify SIP-TLS and HTTPS connections.
</td>
<td width="50%">
<h2>Fail-over</h2>
Phones can automatically switch to a standby Asterisk if the connection to the primary fails. When the primary Asterisk becomes available the phone will revert back.
</td>
</tr>
<tr>
<td width="50%">
<h2>VPN Connection</h2>
Phone can connect to an OpenConnect Server VPN either automatically or on-demand.
</td>
<td width="50%">
<h2>SIPPEER Options</h2>
Call Forward, Do Not Disturb and Hunt Group Login states can be queried and set using this function. Changing the value automatically updates the phone.
</td>
</tr>
<tr>
<td width="50%">
<h2>Restart and Reset</h2>
Phones can be restarted or reset using SIP notify either via AMI or the CLI.
</td>
<td width="50%">
<h2>AS Feature Events</h2>
Call Forward and Do Not Disturb synchronization for phones from other vendors.
</td>
</tr>
<tr>
<td width="50%">
<h2>Trust Verification</h2>
Verify arbitrary SSL connections via a network service.
</td>
<td width="50%">
<h2>Certificate Enrollment</h2>
Install an certificate signed by a local authority on to the phone.
</td>
</tr>
<tr>
<td width="50%">
<h2>Malicious Call</h2>
Call can be identified as being malicious.
</td>
<td width="50%">
<h2>Quality Reporting Tool</h2>
RTP call statistics are logged to the messages log and further information can be optionally gathered via XML service URL.
</td>
</tr>
<tr>
<td width="50%">
<h2>CallBack</h2>
Schedule a notification when an previously called phone is no longer busy.
</td>
<td width="50%">
<h2>Select and Join</h2>
Select and Join support required by the 7900 series to conference-in already established calls.
</td>
</tr>
<tr>
<td width="50%">
<h2>Selective Auto-Answer</h2>
Make the phone auto-answer a call based on a dial-plan variable.
</td>
<td width="50%">
<h2>Callback Number</h2>
Specify a different number to store in the phone's Received Calls history via a dial-plan variable.
</td>
</tr>
</tbody>
</table>
</article>
</main>
<footer>
<span class="icon">copyright</span> Gareth Palmer and individual contributors. Documentation distributed under <a href="LICENSE">CC BY 4.0</a>.
</footer>
</body>
</html>