forked from usecallmanagernz/usecallmanagernz.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsepmac-cnf-xml.html
More file actions
2844 lines (2844 loc) · 129 KB
/
sepmac-cnf-xml.html
File metadata and controls
2844 lines (2844 loc) · 129 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
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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<title>SEPMAC.cnf.xml</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>
<script src="includes/prettify.js"></script>
<script>
jQuery(window).on("load", function () {
prettyPrint();
});
</script>
</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><a href="documentation-overview.html"><span class="icon">home</span> Documentation Overview</a></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><span class="icon selected">settings_phone</span> <b>SEPMAC.cnf.xml</b></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>SEPMAC.cnf.xml</h1>
The main configuration file for the phone. The actual name of the file is based on the MAC address of the phone, eg: <code class="literal">SEP58971ECC97C1.cnf.xml</code>. An sample version of this file is included in the sample tftpboot directory from <a href="http-provisioning.html">HTTP Provisioning</a>.<br>
<br>
<code class="prettify lang-xml"><device>
<fullConfig>true</fullConfig>
<deviceProtocol>SIP</deviceProtocol></code>
<br>
<h2 id="ipAddresMode">ipAddressMode <a href="#ipAddresMode" title="Link">link</a></h2>
IP address family to use on the phone.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>IPv4</td>
<td class="vertical-rule"><b>1</b></td>
<td>IPv6</td>
<td class="vertical-rule"><b>2</b></td>
<td>IPv4 and IPv6</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <ipAddressMode>0</ipAddressMode></code>
<br>
<h2 id="allowAutoConfig">allowAutoConfig <a href="#allowAutoConfig" title="Link">link</a></h2>
Allow IPv6 auto-configuration.<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <allowAutoConfig>true</allowAutoConfig></code>
<br>
<h2 id="dadEnable">dadEnable <a href="#dadEnable" title="Link">link</a></h2>
IPv6 Duplicate IP address Detection.<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <dadEnable>true</dadEnable>
<redirectEnable>false</redirectEnable>
<echoMultiEnable>false</echoMultiEnable></code>
<br>
<h2 id="ipPreferenceModeControl">ipPreferenceModeControl <a href="#ipPreferenceModeControl" title="Link">link</a></h2>
Preferred IP address family for signalling.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>IPv4</td>
<td class="vertical-rule"><b>1</b></td>
<td>IPv6</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <ipPreferenceModeControl>0</ipPreferenceModeControl></code>
<br>
<h2 id="ipMediaAddressFamilyPreference">ipMediaAddressFamilyPreference <a href="#ipMediaAddressFamilyPreference" title="Link">link</a></h2>
Preferred IP address family for media.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>IPv4</td>
<td class="vertical-rule"><b>1</b></td>
<td>IPv6</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <ipMediaAddressFamilyPreference>0</ipMediaAddressFamilyPreference>
<devicePool>
<dateTimeSetting></code>
<br>
<h2 id="dateTimeSetting.dateTemplate">dateTemplate <a href="#dateTimeSetting.dateTemplate" title="Link">link</a></h2>
How the date and time is displayed. Alternate date field delimiters are <code class="literal">-</code> (dash) and <code class="literal">.</code> (period). <code class="literal">D</code> and <code class="literal">M</code> fields can be swapped to display date in American format.<br>
<br>
<table>
<tbody>
<tr>
<td><b>D/M/Y</b></td>
<td>2 Digit Year, 24 Hour Time</td>
<td class="vertical-rule"><b>D/M/YY</b></td>
<td>4 Digit Year, 24 Hour Time</td>
</tr>
<tr>
<td><b>D/M/YA</b></td>
<td>2 Digit Year, 12 Hour Time</td>
<td class="vertical-rule"><b>D/M/YYA</b></td>
<td>4 Digit Year, 12 Hour Time</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <dateTemplate>D/M/Y</dateTemplate></code>
<br>
<h2 id="dateTimeSetting.timeZone">timeZone <a href="#dateTimeSetting.timeZone" title="Link">link</a></h2>
Name of the local time zone. Display time is adjusted by the number of minutes from UTC.<br>
<br>
<table>
<tbody>
<tr>
<td><b>Dateline Standard Time</b></td><td>-720</td>
<td class="vertical-rule"><b>Samoa Standard Time</b></td><td>-660</td>
<td class="vertical-rule"><b>Hawaiian Standard Time</b></td><td>-600</td>
</tr>
<tr>
<td><b>Alaskan Standard/Daylight Time</b></td><td>-540</td>
<td class="vertical-rule"><b>Pacific Standard/Daylight Time</b></td><td>-480</td>
<td class="vertical-rule"><b>Mountain Standard/Daylight Time</b></td><td>-420</td>
</tr>
<tr>
<td><b>US Mountain Standard Time</b></td><td>-420</td>
<td class="vertical-rule"><b>Central Standard/Daylight Time</b></td><td>-360</td>
<td class="vertical-rule"><b>Mexico Standard/Daylight Time</b></td><td>-360</td>
</tr>
<tr>
<td><b>Canada Central Standard Time</b></td><td>-360</td>
<td class="vertical-rule"><b>SA Pacific Standard Time</b></td><td>-300</td>
<td class="vertical-rule"><b>Eastern Standard/Daylight Time</b></td><td>-300</td>
</tr>
<tr>
<td><b>US Eastern Standard Time</b></td><td>-300</td>
<td class="vertical-rule"><b>Atlantic Standard/Daylight Time</b></td><td>-240</td>
<td class="vertical-rule"><b>SA Western Standard Time</b></td><td>-240</td>
</tr>
<tr>
<td><b>Pacific SA Standard Time</b></td><td>-240</td>
<td class="vertical-rule"><b>Newfoundland Standard/Daylight Time</b></td><td>-210</td>
<td class="vertical-rule"><b>E. South America Standard/Daylight Time</b></td><td>-180</td>
</tr>
<tr>
<td><b>SA Eastern Standard Time</b></td><td>-180</td>
<td class="vertical-rule"><b>Pacific SA Daylight Time</b></td><td>-180</td>
<td class="vertical-rule"><b>Mid-Atlantic Standard/Daylight Time</b></td><td>-120</td>
</tr>
<tr>
<td><b>Azores Standard/Daylight Time</b></td><td>-60</td>
<td class="vertical-rule"><b>GMT Standard/Daylight Time</b></td><td>+0</td>
<td class="vertical-rule"><b>Greenwich Standard Time</b></td><td>+0</td>
</tr>
<tr>
<td><b>W. Europe Standard/Daylight Time</b></td><td>+60</td>
<td class="vertical-rule"><b>GTB Standard/Daylight Time</b></td><td>+60</td>
<td class="vertical-rule"><b>Egypt Standard/Daylight Time</b></td><td>+60</td>
</tr>
<tr>
<td><b>E. Europe Standard/Daylight Time</b></td><td>+60</td>
<td class="vertical-rule"><b>Romance Standard/Daylight Time</b></td><td>+120</td>
<td class="vertical-rule"><b>Central Europe Standard/Daylight Time</b></td><td>+120</td>
</tr>
<tr>
<td><b>South Africa Standard Time</b></td><td>+120</td>
<td class="vertical-rule"><b>Jerusalem Standard/Daylight Time</b></td><td>+120</td>
<td class="vertical-rule"><b>Saudi Arabia Standard Time</b></td><td>+180</td>
</tr>
<tr>
<td><b>Russian Standard/Daylight Time</b></td><td>+180</td>
<td class="vertical-rule"><b>Iran Standard/Daylight Time</b></td><td>+210</td>
<td class="vertical-rule"><b>Caucasus Standard/Daylight Time</b></td><td>+240</td>
</tr>
<tr>
<td><b>Arabian Standard Time</b></td><td>+240</td>
<td class="vertical-rule"><b>Afghanistan Standard Time</b></td><td>+270</td>
<td class="vertical-rule"><b>West Asia Standard Time</b></td><td>+300</td>
</tr>
<tr>
<td><b>Ekaterinburg Standard Time</b></td><td>+300</td>
<td class="vertical-rule"><b>India Standard Time</b></td><td>+330</td>
<td class="vertical-rule"><b>Central Asia Standard Time</b></td><td>+360</td>
</tr>
<tr>
<td><b>SE Asia Standard Time</b></td><td>+420</td>
<td class="vertical-rule"><b>China Standard/Daylight Time</b></td><td>+480</td>
<td class="vertical-rule"><b>Taipei Standard Time</b></td><td>+480</td>
</tr>
<tr>
<td><b>Tokyo Standard Time</b></td><td>+540</td>
<td class="vertical-rule"><b>Cen. Australia Standard/Daylight Time</b></td><td>+570</td>
<td class="vertical-rule"><b>AUS Central Standard Time</b></td><td>+570</td>
</tr>
<tr>
<td><b>E. Australia Standard Time</b></td><td>+600</td>
<td class="vertical-rule"><b>AUS Eastern Standard/Daylight Time</b></td><td>+600</td>
<td class="vertical-rule"><b>West Pacific Standard Time</b></td><td>+600</td>
</tr>
<tr>
<td><b>Tasmania Standard/Daylight Time</b></td><td>+600</td>
<td class="vertical-rule"><b>Central Pacific Standard Time</b></td><td>+660</td>
<td class="vertical-rule"><b>Fiji Standard Time</b></td><td>+720</td>
</tr>
<tr>
<td><b>New Zealand Standard/Daylight Time</b></td><td>+720</td>
<td></td><td></td>
<td></td><td></td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <timeZone><i>TIME ZONE</i></timeZone>
<ntps>
<ntp></code>
<br>
<h2 id="ntp.name">name <a href="#ntp.name" title="Link">link</a></h2>
Host name or IP address of the NTP server when using <code class="literal">unicast</code> mode. Maximum length of 50 characters.<br>
<br>
<code class="prettify lang-xml"> <name><i>HOST</i></name></code>
<br>
<h2 id="ntp.ntpMode">ntpMode <a href="#ntp.ntpMode" title="Link">link</a></h2>
How the phone synchronises the clock.<br>
<br>
<table>
<tbody>
<tr>
<td><b>unicast</b></td>
<td>Query the NTP server specified in <<code class="tag">name</code>> for the current time</td>
</tr>
<tr>
<td><b>directedbroadcast</b></td>
<td>Listen to broadcasts from NTP servers for the current time</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <ntpMode>unicast</ntpMode>
</ntp>
</ntps>
</dateTimeSetting>
<callManagerGroup>
<members></code>
<br>
<h2 id="callManagerGroup.member">member <a href="#callManagerGroup.member" title="Link">link</a></h2>
Specifies the host name or IP address and SIP port of the server running Asterisk. Up to <code class="literal">5</code> members can be defined with the phone will automatically failing-over to a member with a higher priority when it is disconnected from the current member.<br>
<br>
<table>
<tbody>
<tr>
<td><b>priority</b></td>
<td><code class="literal">0</code> to <code class="literal">4</code>, the connection priority of this member, lower priorities are tried first.</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <member priority="0">
<callManager>
<ports></code>
<br>
<h2 id="callManager.sipPort">sipPort <a href="#callManager.sipPort" title="Link">link</a></h2>
SIP port to connect to on the server running Asterisk.<br>
<br>
<code class="prettify lang-xml"> <sipPort>5060</sipPort></code>
<br>
<h2 id="callManager.securedSipPort">securedSipPort <a href="#callManager.securedSipPort" title="Link">link</a></h2>
SIP-TLS port to connect to on the server running Asterisk.<br>
<br>
<code class="prettify lang-xml"> <securedSipPort>5061</securedSipPort>
</ports></code>
<br>
<h2 id="callManager.processNodeName">processNodeName <a href="#callManager.processNodeName" title="Link">link</a></h2>
Host name or IP address of the server running Asterisk. Maximum length of 50 characters.<br>
<br>
<code class="prettify lang-xml"> <processNodeName><i>HOST</i></processNodeName>
</callManager>
</member>
</members>
</callManagerGroup>
</devicePool>
<TVS>
<members></code>
<br>
<h2 id="TVS.member">member <a href="#TVS.member" title="Link">link</a></h2>
Specifies the host name or IP address and port of the server running the Trust Verification Service. Up to <code class="literal">5</code> members can be defined with the phone will automatically failing-over to a member with a higher priority when it cannot connect to a member. Maximum length of 50 characters.<br>
<br>
<table>
<tbody>
<tr>
<td><b>priority</b></td>
<td><code class="literal">0</code> to <code class="literal">4</code>, the connection priority of this member, lower priorities are tried first.</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <member priority="0"></code>
<br>
<h2 id="TVS.port">port <a href="#TVS.port" title="Link">link</a></h2>
Port to connect to on the server running the Trust Verification Service.<br>
<br>
<code class="prettify lang-xml"> <port>2445</port></code>
<br>
<h2 id="TVS.address">address <a href="#TVS.address" title="Link">link</a></h2>
Host name or IP address of the server running the Trust Verification Service.<br>
<br>
<code class="prettify lang-xml"> <address><i>HOST</i></address>
</member>
</members>
<TVS>
<vpnGroup>
<mtu>1290</mtu>
<failConnectTime>30</failConnectTime></code>
<br>
<h2 id="vpnGroup.authMethod">authMethod <a href="#vpnGroup.authMethod" title="Link">link</a></h2>
Method the phone uses to authenticate to the VPN server.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>User name and password</td>
<td class="vertical-rule"><b>1</b></td>
<td>Password only</td>
<td class="vertical-rule"><b>2</b></td>
<td>Certificate (MIC or LSC)</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <authMethod>0</authMethod></code>
<br>
<h2 id="vpnGroup.pswdPersistent">pswdPersistent <a href="#vpnGroup.pswdPersistent" title="Link">link</a></h2>
Locally store the password entered by the user. If disabled the user has to re-enter the password if the phone is reset.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <pswdPersistent>1</pswdPersistent></code>
<br>
<h2 id="vpnGroup.autoNetDetect">autoNetDetect <a href="#vpnGroup.autoNetDetect" title="Link">link</a></h2>
When the phone starts it will attempt to ping the TFTP server. If it does not receive a response it will automatically connect to the VPN server.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <autoNetDetect>1</autoNetDetect></code>
<br>
<h2 id="vpnGroup.enableHostIDCheck">enableHostIDCheck <a href="#vpnGroup.enableHostIDCheck" title="Link">link</a></h2>
Compare the host name part of the URL set below to the name in the certificate that the VPN server uses and abort the connection if the do not match.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <enableHostIDCheck>0</enableHostIDCheck>
<addresses></code>
<br>
<h2 id="vpnGroup.url1">url1 <a href="#vpnGroup.url1" title="Link">link</a></h2>
URL of the VPN server using the format <b>https://<i>HOST</i>/svc</b>. Up to <code class="literal">3</code> URLs can be specified by including <<code class="tag">url2</code>> ... <<code class="tag">url3</code>>. Maximum length of 255 characters. <b>Note</b>: the path must be <code class="literal">/svc</code> when using OpenConnect Server.<br>
<br>
<code class="prettify lang-xml"> <url1><i>URL</i></url1>
</addresses>
<credentials>
<hashAlg>0</hashAlg></code>
<br>
<h2 id="vpnGroup.certHash1">certHash1 <a href="#vpnGroup.certHash1" title="Link">link</a></h2>
Encoded hash of the VPN server certificate generated by <code class="literal">certhash</code>. See <a href="vpn-connection.html#certhash">VPN Connection</a> for an archive containing scripts for managing certificates. Up to <code class="literal">10</code> hashes can be specified by including <<code class="tag">certHash2</code>> ... <<code class="tag">certHash10</code>><br>
<br>
<code class="prettify lang-xml"> <certHash1><i>HASH</i></certHash1>
</credentials>
</vpnGroup>
<sipProfile>
<sipProxies></code>
<br>
<h2 id="sipProxies.registerWithProxy">registerWithProxy <a href="#sipProxies.registerWithProxy" title="Link">link</a></h2>
Register with Asterisk, must be set to <code class="literal">true</code>.<br>
<br>
<code class="prettify lang-xml"> <registerWithProxy>true</registerWithProxy>
</sipProxies>
<sipCallFeatures>
<callForwardURI>x-cisco-serviceuri-cfwdall</callForwardURI>
<callPickupURI>x-cisco-serviceuri-pickup</callPickupURI>
<callPickupListURI>x-cisco-serviceuri-opickup</callPickupListURI>
<callPickupGroupURI>x-cisco-serviceuri-gpickup</callPickupGroupURI>
<meetMeServiceURI>x-cisco-serviceuri-meetme</meetMeServiceURI>
<abbreviatedDialURI>x-cisco-serviceuri-abbrdial</abbreviatedDialURI></code>
<br>
<h2 id="sipCalLFeatures.callHoldRingback">callHoldRingback <a href="#sipCallFeatures.callHoldRingback" title="Link">link</a></h2>
Have the phone ring if a user hangs up an while the phone has another call on hold.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <callHoldRingback>1</callHoldRingback></code>
<br>
<h2 id="sipCalLFeatures.semiAttendedTransfer">semiAttendedTransfer <a href="#sipCalLFeatures.semiAttendedTransfer" title="Link">link</a></h2>
Allow transfers to be completed before the remote party has answered.<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <semiAttendedTransfer>true</semiAttendedTransfer></code>
<br>
<h2 id="sipCalLFeatures.anonymousCallBlock">anonymousCallBlock <a href="#sipCalLFeatures.anonymousCallBlock" title="Link">link</a></h2>
Whether the phone rejects incoming anonymous calls. Depending on the phone model, this setting is parsed differently.<br>
<br>
<table>
<tbody>
<tr>
<td colspan="8"><b>7900</b> series</td>
</tr>
<tr>
<td><b>0</b></td>
<td>Disabled (User Modifiable)</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled (User Modifiable)</td>
<td class="vertical-rule"><b>2</b></td>
<td>Disabled (Not User Modifiable)</td>
<td class="vertical-rule"><b>3</b></td>
<td>Enabled (Not User Modifiable)</td>
</tr>
<tr>
<td colspan="8"><b>6900</b>, <b>7800</b>, <b>8800</b>, <b>8900</b> and <b>9900</b> series</td>
</tr>
<tr>
<td><b>0</b> or <b>1</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>2</b> or <b>3</b></td>
<td>Enabled</td>
<td colspan="4"></td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <anonymousCallBlock>0</anonymousCallBlock></code>
<br>
<h2 id="sipCalLFeatures.callerIdBlocking">callerIdBlocking <a href="#sipCalLFeatures.callerIdBlocking" title="Link">link</a></h2>
Whether the phone hides the outgoing caller ID. Actual phone details will be included the Remote-Party-ID header. Depending on the phone model, this setting is parsed differently.<br>
<br>
<table>
<tbody>
<tr>
<td colspan="8"><b>7900</b> series</td>
</tr>
<tr>
<td><b>0</b></td>
<td>Disabled (User Modifiable)</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled (User Modifiable)</td>
<td class="vertical-rule"><b>2</b></td>
<td>Disabled (Not User Modifiable)</td>
<td class="vertical-rule"><b>3</b></td>
<td>Enabled (Not User Modifiable)</td>
</tr>
<tr>
<td colspan="8"><b>6900</b>, <b>7800</b>, <b>8800</b>, <b>8900</b> and <b>9900</b> series</td>
</tr>
<tr>
<td><b>0</b> or <b>1</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>2</b> or <b>3</b></td>
<td>Enabled</td>
<td colspan="4"></td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <callerIdBlocking>0</callerIdBlocking></code>
<br>
<h2 id="sipCalLFeatures.remoteCcEnable">remoteCcEnable <a href="#sipCalLFeatures.remoteCcEnable" title="Link">link</a></h2>
Enable remote call control. Must be set to <code class="literal">true</code>.<br>
<br>
<code class="prettify lang-xml"> <remoteCcEnable>true</remoteCcEnable>
<rfc2543Hold>false</rfc2543Hold>
<cnfJoinEnabled>true</cnfJoinEnabled>
<dndControl>0</dndControl>
<localCfwdEnable>true</localCfwdEnable>
<retainForwardInformation>false</retainForwardInformation></code>
<br>
<h2 id="sipCalLFeatures.uriDialingDisplayPreference">uriDialingDisplayPreference <a href="#sipCalLFeatures.uriDialingDisplayPreference" title="Link">link</a></h2>
Whether to display the full SIP user@domain URI or just the user part only.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Full user@domain URI</td>
<td class="vertical-rule"><b>1</b></td>
<td>User part only</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <uriDialingDisplayPreference>1</uriDialingDisplayPreference>
</sipCallFeatures>
<sipStack>
<sipInviteRetx>6</sipInviteRetx>
<sipRetx>10</sipRetx>
<timerInviteExpires>180</timerInviteExpires>
<timerRegisterExpires>3600</timerRegisterExpires>
<timerRegisterDelta>5</timerRegisterDelta>
<timerKeepAliveExpires>120</timerKeepAliveExpires>
<timerSubscribeExpires>120</timerSubscribeExpires>
<timerSubscribeDelta>5</timerSubscribeDelta>
<timerT1>500</timerT1>
<timerT2>4000</timerT2>
<maxRedirects>70</maxRedirects></code>
<br>
<h2 id="sipStack.remotePartyID">remotePartyID <a href="#sipStack.remotePartyID" title="Link">link</a></h2>
Send and receive the SIP Remote-Party-ID header, allows the called or calling party information to be updated by the ${<code class="literal">CONNECTEDLINE</code>()} function. Must be set to <code class="literal">true</code>.<br>
<br>
<code class="prettify lang-xml"> <remotePartyID>true</remotePartyID>
<userInfo>Phone</userInfo>
</sipStack></code>
<br>
<h2 id="autoAnswerTimer">autoAnswerTimer <a href="#autoAnswerTimer" title="Link">link</a></h2>
Seconds to wait before automatically answering the call for lines with <<code class="tag">autoAnswerEnabled</code>> set to <code class="literal">1</code>.<br>
<br>
<code class="prettify lang-xml"> <autoAnswerTimer>1</autoAnswerTimer></code>
<br>
<h2 id="autoAnswerAltBehavior">autoAnswerAltBehavior <a href="#autoAnswerAltBehavior" title="Link">link</a></h2>
Prevent automatically answering of a incoming call if the phone already has a call on any line.<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <autoAnswerAltBehavior>false</autoAnswerAltBehavior>
<autoAnswerOverride>true</autoAnswerOverride></code>
<br>
<h2 id="transferOnhookEnabled">transferOnhookEnabled <a href="#transferOnhookEnabled" title="Link">link</a></h2>
Allow transfers to be completed by placing the handset back on-hook.<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <transferOnhookEnabled>false</transferOnhookEnabled></code>
<br>
<h2 id="enableVad">enableVad <a href="#enableVad" title="Link">link</a></h2>
Enable support for Voice Activity Detection (also know as Silence Suppression).<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <enableVad>false</enableVad>
<preferredCodec>none</preferredCodec>
<dtmfAvtPayload>101</dtmfAvtPayload>
<dtmfDbLevel>3</dtmfDbLevel>
<dtmfOutofBand>avt</dtmfOutofBand></code>
<br>
<h2 id="alwaysUsePrimeLine">alwaysUsePrimeLine <a href="#alwaysUsePrimeLine" title="Link">link</a></h2>
Always select the primary line when the phone is taken off-hook. Incoming calls on any other lines would not be automatically answered.<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <alwaysUsePrimeLine>false</alwaysUsePrimeLine></code>
<br>
<h2 id="alwaysUsePrimeLineVoicemail">alwaysUsePrimeLineVoicemail <a href="#alwaysUsePrimeLineVoicemail" title="Link">link</a></h2>
Always select the primary line when the messages button is pressed while on-hook. Otherwise, the first line that has a message waiting is used.<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <alwaysUsePrimeLineVoiceMail>false</alwaysUsePrimeLineVoiceMail>
<kpml>0</kpml></code>
<br>
<h2 id="phoneLabel">phoneLabel <a href="#phoneLabel" title="Link">link</a></h2>
Label appears in the top of the phone's screen. Maximum length of 12 characters. <b>Note</b>: the <b>7900</b> series does not support spaces in the label.<br>
<br>
<code class="prettify lang-xml"> <phoneLabel><i>LABEL</i></phoneLabel>
<stutterMsgWaiting>0</stutterMsgWaiting></code>
<br>
<h2 id="callStats">callStats <a href="#callStats" title="Link">link</a></h2>
Include call statistics (packets sent and received, jitter) in SIP BYE message.<br>
<br>
<table>
<tbody>
<tr>
<td><b>false</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>true</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <callStats>true</callStats>
<offhookToFirstDigitTimer>15000</offhookToFirstDigitTimer>
<silentPeriodBetweenCallWaitingBursts>10</silentPeriodBetweenCallWaitingBursts>
<startMediaPort>16384</startMediaPort>
<stopMediaPort>32766</stopMediaPort>
<natEnabled>false</natEnabled>
<natReceivedProcessing>false</natReceivedProcessing>
<natAddress></natAddress>
<sipLines></code>
<br>
<h2 id="line">line <a href="#line" title="Link">link</a></h2>
Defines the line keys on the phone, you can specify as many lines as your phone has line keys. Line keys are used for phone lines, BLF speed dials, service URLs etc. There must be at least one line key of <<code class="tag">featureID</code>> type <code class="literal">9</code> defined. See <a href="line-keys.html">Line Keys</a> for examples for a list of available features.<br>
<br>
<table>
<tbody>
<tr>
<td><b>button</b></td>
<td>Button to assign this line definition to</td>
</tr>
<tr>
<td><b>lineIndex</b></td>
<td>Index for <<code class="tag">featureID</code>> type <code class="literal">9</code> buttons.</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <line button="1" lineIndex="1"></code>
<br>
<h2 id="line.featureID">featureID <a href="#line.featureID" title="Link">link</a></h2>
Number determining which feature is assigned to this line key.<br>
<br>
<code class="prettify lang-xml"> <featureID>9</featureID></code>
<br>
<h2 id="line.featureLabel">featureLabel <a href="#line.featureLabel" title="Link">link</a></h2>
Text label to display next to the line key. Maximum length of 30 characters.<br>
<br>
<code class="prettify lang-xml"> <featureLabel><i>PEERNAME</i></featureLabel></code>
<br>
<h2 id="line.proxy">proxy <a href="#line.proxy" title="Link">link</a></h2>
Proxy must be the keyword <code class="literal">USECALLMANAGER</code>.<br>
<br>
<code class="prettify lang-xml"> <proxy>USECALLMANAGER</proxy>
<port>5060</port></code>
<br>
<h2 id="line.name">name <a href="#line.name" title="Link">link</a></h2>
Name to use when registering. Maximum length of 30 characters. This is the name of the peer defined in <a href="sip-peers.html">sip.conf</a>.<br>
<br>
<code class="prettify lang-xml"> <name><i>PEERNAME</i></name></code>
<br>
<h2 id="line.displayName">displayName <a href="#line.displayName" title="Link">link</a></h2>
Name to use in SIP From header (optional). Maximum length of 30 characters.<br>
<br>
<code class="prettify lang-xml"> <displayName><i>NAME</i></displayName>
<autoAnswer></code>
<br>
<h2 id="line.autoAnswerEnabled">autoAnswerEnabled <a href="#line.autoAnswerEnabled" title="Link">link</a></h2>
Automatically answer incoming calls on this line.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <autoAnswerEnabled>0</autoAnswerEnabled></code>
<br>
<h2 id="line.autoAnswerMode">autoAnswerMode <a href="#line.autoAnswerMode" title="Link">link</a></h2>
Where to send the audio for automatically answered calls.<br>
<br>
<table>
<tbody>
<tr>
<td><b>Auto Answer with Speakerphone</b></td>
<td>Speakerphone</td>
<td class="vertical-rule"><b>Auto Answer with Headset</b></td>
<td>Headset</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <autoAnswerMode>Auto Answer with Headset</autoAnswerMode>
</autoAnswer></code>
<br>
<h2 id="line.callWaiting">callWaiting <a href="#line.callWaiting" title="Link">link</a></h2>
Enable call waiting.<br>
<br>
<table>
<tbody>
<tr>
<td colspan="8"><b>7900</b> series</td>
</tr>
<tr>
<td><b>0</b></td>
<td>Disabled (User Modifiable)</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled (User Modifiable)</td>
<td class="vertical-rule"><b>2</b></td>
<td>Disabled (Not User Modifiable)</td>
<td class="vertical-rule"><b>3</b></td>
<td>Enabled (Not User Modifiable)</td>
</tr>
<tr>
<td colspan="8"><b>6900</b>, <b>7800</b>, <b>8800</b>, <b>8900</b> and <b>9900</b> series</td>
</tr>
<tr>
<td><b>0</b> or <b>1</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>2</b> or <b>3</b></td>
<td>Enabled</td>
<td colspan="4"></td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <callWaiting>1</callWaiting></code>
<br>
<h2 id="line.authName">authName <a href="#line.authName" title="Link">link</a></h2>
Username to use when registering. Maximum length of 30 characters.<br>
<br>
<code class="prettify lang-xml"> <authName><i>PEERNAME</i></authName></code>
<br>
<h2 id="line.authPassword">authPassword <a href="#line.authPassword" title="Link">link</a></h2>
Password to use when registering. Maximum length of 30 characters. This is the secret for the peer defined in <a href="sip-peers.html">sip.conf</a>.<br>
<br>
<code class="prettify lang-xml"> <authPassword><i>SECRET</i></authPassword></code>
<br>
<h2 id="line.contact">contact <a href="#line.contact" title="Link">link</a></h2>
SIP contact header username to use (optional).<br>
<br>
<code class="prettify lang-xml"> <contact><i>PEERNAME</i></contact>
<sharedLine>false</sharedLine></code>
<br>
<h2 id="line.messageWaitingLampPolicy">messageWaitingLampPolicy <a href="#line.messageWaitingLampPolicy" title="Link">link</a></h2>
How the phone alerts the user to unheard voicemail messages.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Light Lamp and Display Prompt if message is waiting (Primary Line Only)</td>
</tr>
<tr>
<td><b>1</b></td>
<td>Display Prompt if message is waiting (Primary Line Only)</td>
</tr>
<tr>
<td><b>2</b></td>
<td>Light Lamp if message is waiting (Primary Line Only)</td>
</tr>
<tr>
<td><b>3</b></td>
<td>Light Lamp and Display Prompt if message is waiting</td>
</tr>
<tr>
<td><b>4</b></td>
<td>Display Prompt if message is waiting</td>
</tr>
<tr>
<td><b>5</b></td>
<td>Light Lamp if message is waiting</td>
</tr>
<tr>
<td><b>6</b></td>
<td>Do not Light Lamp or Display Prompt if a message is waiting</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <messageWaitingLampPolicy>3</messageWaitingLampPolicy></code>
<br>
<h2 id="line.messageWaitingAMWI">messageWaitingAMWI <a href="#line.messageWaitingAMWI" title="Link">link</a></h2>
Play an brief audible tone when the phone is taken off-hook and a there is an unheard voicemail message.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Disabled</td>
<td class="vertical-rule"><b>1</b></td>
<td>Enabled</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <messageWaitingAMWI>0</messageWaitingAMWI></code>
<br>
<h2 id="line.messagesNumber">messagesNumber <a href="#line.messagesNumber" title="Link">link</a></h2>
Number to dial when the messages key is pressed.<br>
<br>
<code class="prettify lang-xml"> <messagesNumber><i>VOICEMAIL EXTENSION</i></messagesNumber></code>
<br>
<h2 id="line.ringSettingIdle">ringSettingIdle <a href="#line.ringSettingIdle" title="Link">link</a></h2>
How the phone rings when not on a call.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Use System Default</td>
<td class="vertical-rule"><b>1</b></td>
<td>Disable</td>
<td class="vertical-rule"><b>2</b></td>
<td>Flash Only</td>
<td class="vertical-rule"><b>3</b></td>
<td>Ring Once</td>
<td class="vertical-rule"><b>4</b></td>
<td>Ring</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <ringSettingIdle>4</ringSettingIdle></code>
<br>
<h2 id="line.ringSettingActive">ringSettingActive <a href="#line.ringSettingActive" title="Link">link</a></h2>
How the phone rings when it already has a call.<br>
<br>
<table>
<tbody>
<tr>
<td><b>0</b></td>
<td>Use System Default</td>
<td class="vertical-rule"><b>1</b></td>
<td>Disable</td>
<td class="vertical-rule"><b>2</b></td>
<td>Flash Only</td>
<td class="vertical-rule"><b>3</b></td>
<td>Ring Once</td>
<td class="vertical-rule"><b>4</b></td>
<td>Ring</td>
<td class="vertical-rule"><b>5</b></td>
<td>Beep Only</td>
</tr>
</tbody>
</table>
<br>
<code class="prettify lang-xml"> <ringSettingActive>5</ringSettingActive>
<forwardCallInfoDisplay>
<callerName>true</callerName>
<callerNumber>true</callerNumber>
<redirectedNumber>true</redirectedNumber>
<dialedNumber>true</dialedNumber>
</forwardCallInfoDisplay></code>
<br>
<h2 id="line.maxNumCalls">maxNumCalls <a href="#line.maxNumCalls" title="Link">link</a></h2>
Maximum number of calls the line can have at a time. The table below shows the highest value that can be used for each phone model.<br>
<br>
<table>