forked from asterisk/asterisk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathUPGRADE.txt
2735 lines (2172 loc) · 129 KB
/
UPGRADE.txt
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
===========================================================
===
=== THIS FILE IS AUTOMATICALLY GENERATED DURING THE RELEASE
=== PROCESS. DO NOT MAKE CHANGES HERE. INSTEAD, REFER TO
=== doc/UPGRADE-staging/README.md FOR MORE DETAILS.
===
=== Information for upgrading between Asterisk versions
===
=== This file documents all the changes that MUST be taken
=== into account when upgrading between certain Asterisk
=== versions. These changes may require that you modify
=== your configuration files, dialplan or (in some cases)
=== source code if you have your own Asterisk modules or
=== patches. This file also includes advance notice of any
=== functionality that has been marked as 'deprecated' and
=== may be removed in a future release, along with the
=== suggested replacement functionality.
===
===========================================================
------------------------------------------------------------------------------
--- Functionality changes from Asterisk 16.9.0 to Asterisk 16.10.0 -----------
------------------------------------------------------------------------------
Core
------------------
* The streams API function ast_stream_get_formats is
now defined as returning the format capabilities const.
This has always been the case but was never enforced
through the API itself. Any consumer of this API that
is not treating the formats as immutable should update
their code to create a new format capabilities and set
it on the stream instead.
------------------------------------------------------------------------------
--- Functionality changes from Asterisk 16.8.0 to Asterisk 16.9.0 ------------
------------------------------------------------------------------------------
ARI
------------------
* The "TextMessageReceived" event used to include a list of "TextMessageVariable"
objects as part of its output. Due to a couple of bugs in Asterisk a list of
received variables was never included even if ones were available. However,
variables set to send would be (which they should have not been), but would
fail validation due to the bad formatting.
So basically there was no way to get a "TextMessageReceived" event with
variables. Due to this the API has changed. The "TextMessageVariable" object
no longer exists. "TextMessageReceived" now returns a JSON object of key/value
pairs. So for instance instead of a list of "TextMessageVariable" objects:
[ TextMessageVariable, TextMessageVariable, TextMessageVariable]
where a TextMessageVariable was supposed to be:
{ "key": "<var name>", "value":, "<var value>" }
The output is now just:
{ "<var name>": "<var value>" }
This aligns more with how variables are specified when sending a message, as
well as other variable lists in ARI.
res_stasis
------------------
* The "TextMessageReceived" event used to include a list of "TextMessageVariable"
objects as part of its output. Due to a couple of bugs in Asterisk a list of
received variables was never included even if ones were available. However,
variables set to send would be (which they should have not been), but would
fail validation due to the bad formatting.
So basically there was no way to get a "TextMessageReceived" event with
variables. Due to this the API has changed. The "TextMessageVariable" object
no longer exists. "TextMessageReceived" now returns a JSON object of key/value
pairs. So for instance instead of a list of "TextMessageVariable" objects:
[ TextMessageVariable, TextMessageVariable, TextMessageVariable]
where a TextMessageVariable was supposed to be:
{ "key": "<var name>", "value":, "<var value>" }
The output is now just:
{ "<var name>": "<var value>" }
This aligns more with how variables are specified when sending a message, as
well as other variable lists in ARI.
------------------------------------------------------------------------------
--- Functionality changes from Asterisk 16.6.1 to Asterisk 16.6.2 ------------
------------------------------------------------------------------------------
AMI
------------------
* The AMI Originate action, which optionally takes a dialplan application as
an argument, no longer accepts "Originate" as the application due to
security concerns.
------------------------------------------------------------------------------
--- Functionality changes from Asterisk 16.5.0 to Asterisk 16.6.0 ------------
------------------------------------------------------------------------------
Core
------------------
* res_pjsip_pubsub is now required so call transfer progress can be monitored
and reported in the channel variable TRANSFERSTATUS.
chan_pjsip
------------------
* res_pjsip_pubsub is now required so call transfer progress can be monitored
and reported in the channel variable TRANSFERSTATUS.
From 16.0.0 to 16.1.0:
Core:
- ast_bt_get_symbols() now returns a vector of strings instead of an
array of strings. This must be freed with ast_bt_free_symbols.
New in 16.0.0:
app_fax:
- The app_fax module is now deprecated, users should migrate to the
replacement module res_fax.
app_macro:
- The app_macro module is now deprecated and by default it is no longer
built. Users should migrate to app_stack (Gosub). A warning is logged
the first time any Macro is used.
AMI:
- The ContactStatus and Status fields for the manager events ContactStatus
and ContactStatusDetail are now set to "NonQualified" when a contact exists
but has not been qualified.
- The ContactStatus event will no longer be sent by PJSIP when a device
refreshes its registration.
- The "Newexten" event is now part of the "dialplan" class. The documentation
for Asterisk 15 already specified this, but the implementation was actually
using the "call" class instead.
ARI:
- The ContactInfo event's contact_status field is now set to "NonQualified"
when a contact exists but has not been qualified.
Build System:
- MALLOC_DEBUG no longer has an effect on Asterisk's ABI. Asterisk built
with MALLOC_DEBUG can now successfully load binary modules built without
MALLOC_DEBUG and vice versa. Third-party pre-compiled modules no longer
need to have a special build with it enabled.
- Asterisk now depends on libjansson >= 2.11. If this version is not
available on your distro you can use `./configure --with-jansson-bundled`.
chan_dahdi:
- Timeouts for reading digits from analog phones are now configurable in
chan_dahdi.conf: firstdigit_timeout, interdigit_timeout, matchdigit_timeout.
cdr_syslog:
- The cdr_syslog module is now deprecated and by default it is no longer
built.
res_config_sqlite:
- The res_config_sqlite module is now deprecated, users should migrate to the
replacement module res_config_sqlite3.
res_monitor:
- The res_monitor module is now deprecated, users should migrate to the
replacement module app_mixmonitor.
Core:
- libedit is no longer available as an embedded library and must be provided
by the system.
- The module loader now enforces inter-module dependencies. This ensures that
a module is not started before another it depends on, even if preload is used.
If a dependency is not available or fails to startup this will block any
dependants from startup.
- Parts of the Asterisk core which can load configuration from realtime are now
built-in modules. It is no longer necessary to preload realtime drivers as
they are always initialized before the built-in modules.
From 15.2.0 to 15.3.0:
res_pjsip
------------------
* Users who are matching endpoints by SIP header need to reevaluate their
global "endpoint_identifier_order" option in light of the "ip" endpoint
identifier method split into the "ip" and "header" endpoint identifier
methods.
res_pjsip_endpoint_identifier_ip
------------------
* The endpoint identifier "ip" method previously recognized endpoints either
by IP address or a matching SIP header. The "ip" endpoint identifier method
is now split into the "ip" and "header" endpoint identifier methods. The
"ip" endpoint identifier method only matches by IP address and the "header"
endpoint identifier method only matches by SIP header. The split allows the
user to control the relative priority of the IP address and the SIP header
identification methods in the global "endpoint_identifier_order" option.
e.g., If you have two type=identify sections where one matches by IP address
for endpoint alice and the other matches by SIP header for endpoint bob then
you can now predict which endpoint is matched when a request comes in that
matches both.
New in 15.0.0:
Build System:
- '--with-pjproject-bundled' is now the default when running ./configure
It can be disabled with '--without-pjproject-bundled'.
Core:
- Multi-stream support has been added so a channel can have multiple
streams of the same type such as audio and video.
- The 'Data Retrieval API' has been removed. This API was not actively
maintained, was not added to new modules (such as res_pjsip), and there
exist better alternatives to acquire the same information, such as the
ARI. As a result, the 'DataGet' AMI action as well as the 'data get'
CLI command have been removed.
From 14.6.0 to 14.7.0:
Core:
- ast_app_parse_timelen now returns an error if it encounters extra characters
at the end of the string to be parsed.
From 14.4.0 to 14.5.0:
Core:
- Support for embedded modules has been removed. This has not worked in
many years. LOADABLE_MODULES menuselect option is also removed as
loadable module support is now always enabled.
From 14.3.0 to 14.4.0:
res_rtp_asterisk:
- The RTP layer of Asterisk now has support for RFC 5761: "Multiplexing RTP
Data and Control Packets on a Single Port." For the PJSIP channel driver,
chan_pjsip, you can set "rtcp_mux = yes" on a PJSIP endpoint in pjsip.conf
to enable the feature. For chan_sip you can set "rtcp_mux = yes" either
globally or on a per-peer basis in sip.conf.
New in 14.0.0
ARI:
- The policy for when to send "Dial" events has changed. Previously, "Dial"
events were sent on the calling channel's topic. However, starting in Asterisk
14, if there is no calling channel on which to send the event, the event is
instead sent on the called channel's topic. Note that for the ARI channels
resource's dial operation, this means that the "Dial" events will always be
sent on the called channel's topic.
Channel Drivers:
chan_dahdi:
- For users using the FXO port (FXS signaling) distinctive ring detection
feature, you will need to adjust the dringX count values. The count
values now only record ring end events instead of any DAHDI event. A
ring-ring-ring pattern would exceed the pattern limits and stop
Caller-ID detection.
chan_sip:
- The SIP dial string has been extended past the [!dnid] option by another
exclamation mark: [!dnid[!fromuri]. An exclamation mark in the To-URI
will now mean changes to the From-URI.
Core:
- The REF_DEBUG compiler flag is now used to enable refdebug by default.
The setting can be overridden in asterisk.conf by setting refdebug in
the options category. No recompile is required to enable/disable it.
- Modified processing of command-line options to first parse only what
is necessary to read asterisk.conf. Once asterisk.conf is fully loaded,
the remaining options are processed. The -X option now applies to
asterisk.conf only. To enable #exec for other config files you must
set execincludes=yes in asterisk.conf. Any other option set on the
command-line will now override the equivalent setting from asterisk.conf.
AMI:
- The 'ModuleCheck' Action's Version key will no longer show the module
version. The value will always be blank.
CLI:
- The 'core show file version' command has been removed. When Asterisk
moved to Git, the source control version support was removed. As a
result, the CLi command was no longer useful and was removed as well.
Logging:
- The first callid created is now 1 instead of 0. The value 0
is now reserved to represent a lack of callid.
AMI:
- The Command action now sends the output from the CLI command as a series
of Output headers for each line instead of as a block of text with the
--END COMMAND-- delimiter to match the output from other actions.
Commands that fail to execute (no such command, invalid syntax etc.) now
return an Error response instead of Success.
app_amd:
- The 'maximum_number_of_words' configuration option and parameter to the AMD
application previously did not match the documented functionality + variable
name. In Asterisk 13, a value of '3' would mean that if '3' words were detected,
the result would be detection as a 'MACHINE'. As of this version, the value
reflects the maximum words that if EXCEEDED (rather than reached), would
result in detection as a machine. This means that you should update this
value to be one higher than your previos value, if your previous value
was working well for you.
From 12 to 13:
General Asterisk Changes:
- The asterisk command line -I option and the asterisk.conf internal_timing
option are removed and always enabled if any timing module is loaded.
- The per console verbose level feature as previously implemented caused a
large performance penalty. The fix required some minor incompatibilities
if the new rasterisk is used to connect to an earlier version. If the new
rasterisk connects to an older Asterisk version then the root console verbose
level is always affected by the "core set verbose" command of the remote
console even though it may appear to only affect the current console. If
an older version of rasterisk connects to the new version then the
"core set verbose" command will have no effect.
- The asterisk compatibility options in asterisk.conf have been removed.
These options enabled certain backwards compatibility features for
pbx_realtime, res_agi, and app_set that made their behaviour similar to
Asterisk 1.4. Users who used these backwards compatibility settings should
update their dialplans to use ',' instead of '|' as a delimiter, and should
use the Set dialplan application instead of the MSet dialplan application.
Build System:
- Sample config files have been moved from configs/ to a subfolder of that
directory, 'samples'.
- The menuselect utility has been pulled into the Asterisk repository. As a
result, the libxml2 development library is now a required dependency for
Asterisk.
- Added a new Compiler Flag, REF_DEBUG. When enabled, reference counted
objects will emit additional debug information to the refs log file located
in the standard Asterisk log file directory. This log file is useful in
tracking down object leaks and other reference counting issues. Prior to
this version, this option was only available by modifying the source code
directly. This change also includes a new script, refcounter.py, in the
contrib folder that will process the refs log file.
Applications:
ConfBridge:
- The sound_place_into_conference sound used in Confbridge is now deprecated
and is no longer functional since it has been broken since its inception
and the fix involved using a different method to achieve the same goal. The
new method to achieve this functionality is by using sound_begin to play
a sound to the conference when waitmarked users are moved into the conference.
- Added 'Admin' header to ConfbridgeJoin, ConfbridgeLeave, ConfbridgeMute,
ConfbridgeUnmute, and ConfbridgeTalking AMI events.
ControlPlayback:
- The ControlPlayback and 'control stream file' AGI command will no longer
implicitly answer the channel. If you do not answer the channel prior to
using either this application or AGI command, you must send Progress
first.
Queue:
- Queue rules provided in queuerules.conf can no longer be named "general".
SetMusicOnHold:
- The SetMusicOnHold dialplan application was deprecated and has been removed.
Users of the application should use the CHANNEL function's musicclass
setting instead.
WaitMusicOnHold:
- The WaitMusicOnHold dialplan application was deprecated and has been
removed. Users of the application should use MusicOnHold with a duration
parameter instead.
CDR Backends:
- The cdr_sqlite module was deprecated and has been removed. Users of this
module should use the cdr_sqlite3_custom module instead.
Channel Drivers:
chan_dahdi:
- SS7 support now requires libss7 v2.0 or later.
- Added the inband_on_setup_ack compatibility option to chan_dahdi.conf to
deal with switches that don't send an inband progress indication in the
SETUP ACKNOWLEDGE message.
Default is now no.
chan_gtalk
- This module was deprecated and has been removed. Users of chan_gtalk
should use chan_motif.
chan_h323
- This module was deprecated and has been removed. Users of chan_h323
should use chan_ooh323.
chan_jingle
- This module was deprecated and has been removed. Users of chan_jingle
should use chan_motif.
chan_pjsip:
- Added a 'force_avp' option to chan_pjsip which will force the usage of
'RTP/AVP', 'RTP/AVPF', 'RTP/SAVP', or 'RTP/SAVPF' as the media transport type
in SDP offers depending on settings, even when DTLS is used for media
encryption.
- Added a 'media_use_received_transport' option to chan_pjsip which will
cause the SDP answer to use the media transport as received in the SDP
offer.
chan_sip:
- Made set SIPREFERREDBYHDR as inheritable for better chan_pjsip
interoperability.
- The SIPPEER dialplan function no longer supports using a colon as a
delimiter for parameters. The parameters for the function should be
delimited using a comma.
- The SIPCHANINFO dialplan function was deprecated and has been removed. Users
of the function should use the CHANNEL function instead.
- Added a 'force_avp' option for chan_sip. When enabled this option will
cause the media transport in the offer or answer SDP to be 'RTP/AVP',
'RTP/AVPF', 'RTP/SAVP', or 'RTP/SAVPF' even if a DTLS stream has been
configured. This option can be set to improve interoperability with WebRTC
clients that don't use the RFC defined transport for DTLS.
- The 'dtlsverify' option in chan_sip now has additional values besides
'yes' and 'no'. If 'yes' is specified both the certificate and fingerprint
will be verified. If 'no' is specified then neither the certificate or
fingerprint is verified. If 'certificate' is specified then only the
certificate is verified. If 'fingerprint' is specified then only the
fingerprint is verified.
- A 'dtlsfingerprint' option has been added to chan_sip which allows the
hash to be specified for the DTLS fingerprint placed in SDP. Supported
values are 'sha-1' and 'sha-256' with 'sha-256' being the default.
- The 'progressinband=never' option is now more zealous in the persecution of
progress messages coming from Asterisk. Channels bridged with a SIP channel
that has 'progressinband=never' set will not be able to forward their
progress indications through to the SIP device. chan_sip will now turn such
progress indications into a 180 Ringing (if a 180 has not yet been
transmitted) if 'progressinband=never'.
- The codec preference order in an SDP during an offer is slightly different
than previous releases. Prior to Asterisk 13, the preference order of
codecs used to be:
(1) Our preferred codec
(2) Our configured codecs
(3) Any non-audio joint codecs
One of the ways the new media format architecture in Asterisk 13 improves
performance is by reference counting formats, such that they can be reused
in many places without additional allocation. To not require a large
amount of locking, an instance of a format is immutable by convention.
This works well except for formats with attributes. Since a media format
with an attribute is a different object than the same format without an
attribute, we have to carry over the formats with attributes from an
inbound offer so that the correct attributes are offered in an outgoing
INVITE request. This requires some subtle tweaks to the preference order
to ensure that the media format with attributes is offered to a remote
peer, as opposed to the same media format (but without attributes) that
may be stored in the peer object.
All of this means that our offer offer list will now be:
(1) Our preferred codec
(2) Any joint codecs offered by the inbound offer
(3) All other codecs that are not the preferred codec and not a joint
codec offered by the inbound offer
chan_unistim:
- The unistim.conf 'dateformat' has changed meaning of options values to conform
values used inside Unistim protocol
- Added 'dtmf_duration' option with changing default operation to disable
receivied dtmf playback on unistim phone
Core:
Account Codes:
- accountcode behavior changed somewhat to add functional peeraccount
support. The main change is that local channels now cross accountcode
and peeraccount across the special bridge between the ;1 and ;2 channels
just like channels between normal bridges. See the CHANGES file for
more information.
ARI:
- The ARI version has been changed to 1.5.0. This is to reflect backwards
compatible changes made since 12.0.0 was released.
- Added a new ARI resource 'mailboxes' which allows the creation and
modification of mailboxes managed by external MWI. Modules res_mwi_external
and res_stasis_mailbox must be enabled to use this resource.
- Added new events for externally initiated transfers. The event
BridgeBlindTransfer is now raised when a channel initiates a blind transfer
of a bridge in the ARI controlled application to the dialplan; the
BridgeAttendedTransfer event is raised when a channel initiates an
attended transfer of a bridge in the ARI controlled application to the
dialplan.
- Channel variables may now be specified as a body parameter to the
POST /channels operation. The 'variables' key in the JSON is interpreted
as a sequence of key/value pairs that will be added to the created channel
as channel variables. Other parameters in the JSON body are treated as
query parameters of the same name.
- A bug fix in bridge creation has caused a behavioural change in how
subscriptions are created for bridges. A bridge created through ARI, does
not, by itself, have a subscription created for any particular Stasis
application. When a channel in a Stasis application joins a bridge, an
implicit event subscription is created for that bridge as well. Previously,
when a channel left such a bridge, the subscription was leaked; this allowed
for later bridge events to continue to be pushed to the subscribed
applications. That leak has been fixed; as a result, bridge events that were
delivered after a channel left the bridge are no longer delivered. An
application must subscribe to a bridge through the applications resource if
it wishes to receive all events related to a bridge.
AMI:
- The AMI version has been changed to 2.5.0. This is to reflect backwards
compatible changes made since 12.0.0 was released.
- The DialStatus field in the DialEnd event can now have additional values.
This includes ABORT, CONTINUE, and GOTO.
- The res_mwi_external_ami module can, if loaded, provide additional AMI
actions and events that convey MWI state within Asterisk. This includes
the MWIGet, MWIUpdate, and MWIDelete actions, as well as the MWIGet and
MWIGetComplete events that occur in response to an MWIGet action.
- AMI now contains a new class authorization, 'security'. This is used with
the following new events: FailedACL, InvalidAccountID, SessionLimit,
MemoryLimit, LoadAverageLimit, RequestNotAllowed, AuthMethodNotAllowed,
RequestBadFormat, SuccessfulAuth, UnexpectedAddress, ChallengeResponseFailed,
InvalidPassword, ChallengeSent, and InvalidTransport.
- Bridge related events now have two additional fields: BridgeName and
BridgeCreator. BridgeName is a descriptive name for the bridge;
BridgeCreator is the name of the entity that created the bridge. This
affects the following events: ConfbridgeStart, ConfbridgeEnd,
ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
- MixMonitor AMI actions now require users to have authorization classes.
* MixMonitor - system
* MixMonitorMute - call or system
* StopMixMonitor - call or system
- Removed the undocumented manager.conf block-sockets option. It interferes with
TCP/TLS inactivity timeouts.
- The response to the PresenceState AMI action has historically contained two
Message keys. The first of these is used as an informative message regarding
the success/failure of the action; the second contains a Presence state
specific message. Having two keys with the same unique name in an AMI
message is cumbersome for some client; hence, the Presence specific Message
has been deprecated. The message will now contain a PresenceMessage key
for the presence specific information; the Message key containing presence
information will be removed in the next major version of AMI.
- The manager.conf 'eventfilter' now takes an "extended" regular expression
instead of a "basic" one.
CDRs:
- The "endbeforehexten" setting now defaults to "yes", instead of "no".
When set to "no", yhis setting will cause a new CDR to be generated when a
channel enters into hangup logic (either the 'h' extension or a hangup
handler subroutine). In general, this is not the preferred default: this
causes extra CDRs to be generated for a channel in many common dialplans.
CLI commands:
- "core show settings" now lists the current console verbosity in addition
to the root console verbosity.
- "core set verbose" has not been able to support the by module verbose
logging levels since verbose logging levels were made per console. That
syntax is now removed and a silence option added in its place.
Logging:
- The 'verbose' setting in logger.conf still takes an optional argument,
specifying the verbosity level for each logging destination. However,
the default is now to once again follow the current root console level.
As a result, using the AMI Command action with "core set verbose" could
again set the root console verbose level and affect the verbose level
logged.
HTTP:
- Added http.conf session_inactivity timer option to close HTTP connections
that aren't doing anything.
- Added support for persistent HTTP connections. To enable persistent
HTTP connections configure the keep alive time between HTTP requests. The
keep alive time between HTTP requests is configured in http.conf with the
session_keep_alive parameter.
Realtime Configuration:
- WARNING: The database migration script that adds the 'extensions' table for
realtime had to be modified due to an error when installing for MySQL. The
'extensions' table's 'id' column was changed to be a primary key. This could
potentially cause a migration problem. If so, it may be necessary to
manually alter the affected table/column to bring it back in line with the
migration scripts.
- New columns have been added to realtime tables for 'support_path' on
ps_registrations and ps_aors and for 'path' on ps_contacts for the new
SIP Path support in chan_pjsip.
- The following new tables have been added for pjsip realtime: 'ps_systems',
'ps_globals', 'ps_tranports', 'ps_registrations'.
- The following columns were added to the 'ps_aors' realtime table:
'maximum_expiration', 'outbound_proxy', and 'support_path'.
- The following columns were added to the 'ps_contacts' realtime table:
'outbound_proxy', 'user_agent', and 'path'.
- New columns have been added to the ps_endpoints realtime table for the
'media_address', 'redirect_method' and 'set_var' options. Also the
'mwi_fromuser' column was renamed to 'mwi_from_user'. A new column
'message_context' was added to let users configure how MESSAGE requests are
routed to the dialplan.
- A new column was added to the 'ps_globals' realtime table for the 'debug'
option.
- PJSIP endpoint columns 'tos_audio' and 'tos_video' have been changed from
yes/no enumerators to string values. 'cos_audio' and 'cos_video' have been
changed from yes/no enumerators to integer values. PJSIP transport column
'tos' has been changed from a yes/no enumerator to a string value. 'cos' has
been changed from a yes/no enumerator to an integer value.
- The 'queues' and 'queue_members' realtime tables have been added to the
config Alembic scripts.
- A new set of Alembic scripts has been added for CDR tables. This will create
a 'cdr' table with the default schema that Asterisk expects.
- A new upgrade script has been added that adds a 'queue_rules' table for
app_queue. Users of app_queue can store queue rules in a database. It is
important to note that app_queue only looks for this table on module load or
module reload; for more information, see the CHANGES file.
Resources:
res_odbc:
- The compatibility setting, allow_empty_string_in_nontext, has been removed.
Empty column values will be stored as empty strings during realtime updates.
res_jabber:
- This module was deprecated and has been removed. Users of this module should
use res_xmpp instead.
res_http_websocket:
- Added a compatibility option to ari.conf, sip.conf, and pjsip.conf
'websocket_write_timeout'. When a websocket connection exists where Asterisk
writes a substantial amount of data to the connected client, and the connected
client is slow to process the received data, the socket may be disconnected.
In such cases, it may be necessary to adjust this value.
Default is 100 ms.
Scripts:
safe_asterisk:
- The safe_asterisk script was previously not installed on top of an existing
version. This caused bug-fixes in that script not to be deployed. If your
safe_asterisk script is customized, be sure to keep your changes. Custom
values for variables should be created in *.sh file(s) inside
ASTETCDIR/startup.d/. See ASTERISK-21965.
- Changed a log message in safe_asterisk and the $NOTIFY mail subject. If
you use tools to parse either of them, update your parse functions
accordingly. The changed strings are:
- "Exited on signal $EXITSIGNAL" => "Asterisk exited on signal $EXITSIGNAL."
- "Asterisk Died" => "Asterisk on $MACHINE died (sig $EXITSIGNAL)"
Utilities:
- The refcounter program has been removed in favor of the refcounter.py script
in contrib/scripts.
From 11 to 12:
There are many significant architectural changes in Asterisk 12. It is
recommended that you not only read through this document for important
changes that affect an upgrade, but that you also read through the CHANGES
document in depth to better understand the new options available to you.
Additional information on the architectural changes made in Asterisk can be
found on the Asterisk wiki (https://wiki.asterisk.org)
Of particular note, the following systems in Asterisk underwent significant
changes. Documentation for the changes and a specification for their
behavior in Asterisk 12 is also available on the Asterisk wiki.
- AMI: Many events were changed, and the semantics of channels and bridges
were defined. In particular, how channels and bridges behave under
transfer scenarios and situations involving multiple parties has
changed significantly. See https://wiki.asterisk.org/wiki/x/dAFRAQ
for more information.
- CDR: CDR logic was extracted from the many locations it existed in across
Asterisk and implemented as a consumer of Stasis message bus events.
As a result, consistency of records has improved significantly and the
behavior of CDRs in transfer scenarios has been defined in the CDR
specification. However, significant behavioral changes in CDRs resulted
from the transition. The most significant change is the addition of
CDR entries when a channel who is the Party A in a CDR leaves a bridge.
See https://wiki.asterisk.org/wiki/x/pwpRAQ for more information.
- CEL: Much like CDRs, CEL was removed from the many locations it existed in
across Asterisk and implemented as a consumer of Stasis message bus
events. It now closely follows the Bridging API model of channels and
bridges, and has a much closer consistency of conveyed events as AMI.
For the changes in events, see https://wiki.asterisk.org/wiki/x/4ICLAQ.
Build System:
- Removed the CHANNEL_TRACE development mode build option. Certain aspects of
the CHANNEL_TRACE build option were incompatible with the new bridging
architecture.
- Asterisk now depends on libjansson, libuuid and optionally (but recommended)
libxslt and uriparser.
- The new SIP stack and channel driver uses a particular version of PJSIP.
Please see https://wiki.asterisk.org/wiki/x/J4GLAQ for more information on
configuring and installing PJSIP for use with Asterisk.
AgentLogin and chan_agent:
- Along with AgentRequest, this application has been modified to be a
replacement for chan_agent. The chan_agent module and the Agent channel
driver have been removed from Asterisk, as the concept of a channel driver
proxying in front of another channel driver was incompatible with the new
architecture (and has had numerous problems through past versions of
Asterisk). The act of a channel calling the AgentLogin application places the
channel into a pool of agents that can be requested by the AgentRequest
application. Note that this application, as well as all other agent related
functionality, is now provided by the app_agent_pool module.
- This application no longer performs agent authentication. If authentication
is desired, the dialplan needs to perform this function using the
Authenticate or VMAuthenticate application or through an AGI script before
running AgentLogin.
- The agents.conf schema has changed. Rather than specifying agents on a
single line in comma delineated fashion, each agent is defined in a separate
context. This allows agents to use the power of context templates in their
definition.
- A number of parameters from agents.conf have been removed. This includes
maxloginretries, autologoffunavail, updatecdr, goodbye, group, recordformat,
urlprefix, and savecallsin. These options were obsoleted by the move from
a channel driver model to the bridging/application model provided by
app_agent_pool.
- The AGENTUPDATECDR channel variable has also been removed, for the same
reason as the updatecdr option.
- The endcall and enddtmf configuration options are removed. Use the
dialplan function CHANNEL(dtmf_features) to set DTMF features on the agent
channel before calling AgentLogin.
AgentMonitorOutgoing
- This application has been removed. It was a holdover from when
AgentCallbackLogin was removed.
Answer
- It is no longer possible to bypass updating the CDR when answering a
channel. CDRs are based on the channel state and will be updated when
the channel is Answered.
ControlPlayback
- The channel variable CPLAYBACKSTATUS may now return the value
'REMOTESTOPPED' when playback is stopped by an external entity.
DISA
- This application now has a dependency on the app_cdr module. It uses this
module to hide the CDR created prior to execution of the DISA application.
DumpChan:
- The output of DumpChan no longer includes the DirectBridge or IndirectBridge
fields. Instead, if a channel is in a bridge, it includes a BridgeID field
containing the unique ID of the bridge that the channel happens to be in.
ForkCDR:
- Nearly every parameter in ForkCDR has been updated and changed to reflect
the changes in CDRs. Please see the documentation for the ForkCDR
application, as well as the CDR specification on the Asterisk wiki.
NoCDR:
- The NoCDR application has been deprecated. Please use the CDR_PROP function
to disable CDRs on a channel.
ParkAndAnnounce:
- The app_parkandannounce module has been removed. The application
ParkAndAnnounce is now provided by the res_parking module. See the
Parking changes for more information.
ResetCDR:
- The 'w' and 'a' options have been removed. Dispatching CDRs to registered
backends occurs on an as-needed basis in order to preserve linkedid
propagation and other needed behavior.
- The 'e' option is deprecated. Please use the CDR_PROP function to enable
CDRs on a channel that they were previously disabled on.
- The ResetCDR application is no longer a part of core Asterisk, and instead
is now delivered as part of app_cdr.
Queues:
- Queue strategy rrmemory now has a predictable order similar to strategy
rrordered. Members will be called in the order that they are added to the
queue.
- Removed the queues.conf check_state_unknown option. It is no longer
necessary.
- It is now possible to play the Queue prompts to the first user waiting in a
call queue. Note that this may impact the ability for agents to talk with
users, as a prompt may still be playing when an agent connects to the user.
This ability is disabled by default but can be enabled on an individual
queue using the 'announce-to-first-user' option.
- The configuration options eventwhencalled and eventmemberstatus have been
removed. As a result, the AMI events QueueMemberStatus, AgentCalled,
AgentConnect, AgentComplete, AgentDump, and AgentRingNoAnswer will always be
sent. The "Variable" fields will also no longer exist on the Agent* events.
These events can be filtered out from a connected AMI client using the
eventfilter setting in manager.conf.
- The queue log now differentiates between blind and attended transfers. A
blind transfer will result in a BLINDTRANSFER message with the destination
context and extension. An attended transfer will result in an
ATTENDEDTRANSFER message. This message will indicate the method by which
the attended transfer was completed: "BRIDGE" for a bridge merge, "APP"
for running an application on a bridge or channel, or "LINK" for linking
two bridges together with local channels. The queue log will also now detect
externally initiated blind and attended transfers and record the transfer
status accordingly.
- When performing queue pause/unpause on an interface without specifying an
individual queue, the PAUSEALL/UNPAUSEALL event will only be logged if at
least one member of any queue exists for that interface.
SetAMAFlags
- This application is deprecated in favor of CHANNEL(amaflags).
VoiceMail:
- Mailboxes defined by app_voicemail MUST be referenced by the rest of the
system as mailbox@context. The rest of the system cannot add @default
to mailbox identifiers for app_voicemail that do not specify a context
any longer. It is a mailbox identifier format that should only be
interpreted by app_voicemail.
- The voicemail.conf configuration file now has an 'alias' configuration
parameter for use with the Directory application. The voicemail realtime
database table schema has also been updated with an 'alias' column. Systems
using voicemail with realtime should update their schemas accordingly.
Channel Drivers:
- When a channel driver is configured to enable jiterbuffers, they are now
applied unconditionally when a channel joins a bridge. If a jitterbuffer
is already set for that channel when it enters, such as by the JITTERBUFFER
function, then the existing jitterbuffer will be used and the one set by
the channel driver will not be applied.
chan_bridge
- chan_bridge is removed and its functionality is incorporated into ConfBridge
itself.
chan_dahdi:
- Analog port dialing and deferred DTMF dialing for PRI now distinguishes
between 'w' and 'W'. The 'w' pauses dialing for half a second. The 'W'
pauses dialing for one second.
- The default for inband_on_proceeding has changed to no.
- The CLI command 'dahdi destroy channel' is now 'dahdi destroy channels'.
A range of channels can be specified to be destroyed. Note that this command
should only be used if you understand the risks it entails.
- The script specified by the chan_dahdi.conf mwimonitornotify option now gets
the exact configured mailbox name. For app_voicemail mailboxes this is
mailbox@context.
- Added mwi_vm_boxes that also must be configured for ISDN MWI to be enabled.
- ignore_failed_channels now defaults to True: the channel will continue to
be configured even if configuring it has failed. This is generally a
better setup for systems with not more than one DAHDI device or with DAHDI
>= 2.8.0 .
chan_local:
- The /b option has been removed.
- chan_local moved into the system core and is no longer a loadable module.
chan_sip:
- The 'callevents' parameter has been removed. Hold AMI events are now raised
in the core, and can be filtered out using the 'eventfilter' parameter
in manager.conf.
- Dynamic realtime tables for SIP Users can now include a 'path' field. This
will store the path information for that peer when it registers. Realtime
tables can also use the 'supportpath' field to enable Path header support.
- LDAP realtime configurations for SIP Users now have the AstAccountPathSupport
objectIdentifier. This maps to the supportpath option in sip.conf.
Core:
- Masquerades as an operation inside Asterisk have been effectively hidden
by the migration to the Bridging API. As such, many 'quirks' of Asterisk
no longer occur. This includes renaming of channels, "<ZOMBIE>" channels,
dropping of frame/audio hooks, and other internal implementation details
that users had to deal with. This fundamental change has large implications
throughout the changes documented for this version. For more information
about the new core architecture of Asterisk, please see the Asterisk wiki.
- The following channel variables have changed behavior which is described in
the CHANGES file: TRANSFER_CONTEXT, BRIDGEPEER, BRIDGEPVTCALLID,
ATTENDED_TRANSFER_COMPLETE_SOUND, DYNAMIC_FEATURENAME, and DYNAMIC_PEERNAME.
AMI (Asterisk Manager Interface):
- Version 1.4 - The details of what happens to a channel when a masquerade
happens (transfers, parking, etc) have changed.
- The Masquerade event now includes the Uniqueid's of the clone and original
channels.
- Channels no longer swap Uniqueid's as a result of the masquerade.
- Instead of a shell game of renames, there's now a single rename, appending
<ZOMBIE> to the name of the original channel.
- *Major* changes were made to both the syntax as well as the semantics of the
AMI protocol. In particular, AMI events have been substantially modified
and improved in this version of Asterisk. The major event changes are listed
below.
- NewPeerAccount has been removed. NewAccountCode is raised instead.
- Reload events have been consolidated and standardized.
- ModuleLoadReport has been removed.
- FaxSent is now SendFAX; FaxReceived is now ReceiveFAX. This standardizes
app_fax and res_fax events.
- MusicOnHold has been replaced with MusicOnHoldStart and MusicOnHoldStop.
- JabberEvent has been removed.
- Hold is now in the core and will now raise Hold and Unhold events.
- Join is now QueueCallerJoin.
- Leave is now QueueCallerLeave.
- Agentlogin/Agentlogoff is now AgentLogin/AgentLogoff, respectively.
- ChannelUpdate has been removed.
- Local channel optimization is now conveyed via LocalOptimizationBegin and
LocalOptimizationEnd.
- BridgeAction and BridgeExec have been removed.
- BlindTransfer and AttendedTransfer events were added.
- Dial is now DialBegin and DialEnd.
- DTMF is now DTMFBegin and DTMFEnd.
- Bridge has been replaced with BridgeCreate, BridgeEnter, BridgeLeave, and
BridgeDestroy
- MusicOnHold has been replaced with MusicOnHoldStart and MusicOnHoldStop
- AGIExec is now AGIExecStart and AGIExecEnd
- AsyncAGI is now AsyncAGIStart, AsyncAGIExec, and AsyncAGIEnd
- The 'MCID' AMI event now publishes a channel snapshot when available and
its non-channel-snapshot parameters now use either the "MCallerID" or
'MConnectedID' prefixes with Subaddr*, Name*, and Num* suffixes instead
of 'CallerID' and 'ConnectedID' to avoid confusion with similarly named
parameters in the channel snapshot.
- The 'Channel' key used in the 'AlarmClear', 'Alarm', and 'DNDState' has been
renamed "DAHDIChannel" since it does not convey an Asterisk channel name.
- All AMI events now contain a 'SystemName' field, if available.
- Local channel information in events is now prefixed with 'LocalOne' and
'LocalTwo'. This replaces the suffix of '1' and '2' for the two halves of
the Local channel. This affects the 'LocalBridge', 'LocalOptimizationBegin',
and 'LocalOptimizationEnd' events.
- The 'RTCPSent'/'RTCPReceived' events have been significantly modified from
previous versions. They now report all SR/RR packets sent/received, and
have been restructured to better reflect the data sent in a SR/RR. In
particular, the event structure now supports multiple report blocks.
- The deprecated use of | (pipe) as a separator in the channelvars setting in
manager.conf has been removed.
- The SIP SIPqualifypeer action now sends a response indicating it will qualify
a peer once a peer has been found to qualify. Once the qualify has been
completed it will now issue a SIPqualifypeerdone event.
- The AMI event 'Newexten' field 'Extension' is deprecated, and may be removed
in a future release. Please use the common 'Exten' field instead.
- The AMI events 'ParkedCall', 'ParkedCallTimeOut', 'ParkedCallGiveUp', and
'UnParkedCall' have changed significantly in the new res_parking module.
- The 'Channel' and 'From' headers are gone. For the channel that was parked
or is coming out of parking, a 'Parkee' channel snapshot is issued and it
has a number of fields associated with it. The old 'Channel' header relayed
the same data as the new 'ParkeeChannel' header.
- The 'From' field was ambiguous and changed meaning depending on the event.
for most of these, it was the name of the channel that parked the call
(the 'Parker'). There is no longer a header that provides this channel name,
however the 'ParkerDialString' will contain a dialstring to redial the
device that parked the call.