08501ad4e31f000ca3a12f8d8995227984d9703c
[asterisk/asterisk.git] / CHANGES
1 ==============================================================================
2 ===
3 === This file documents the new and/or enhanced functionality added in
4 === the Asterisk versions listed below. This file does NOT include
5 === changes in behavior that would not be backwards compatible with
6 === previous versions; for that information see the UPGRADE.txt file
7 === and the other UPGRADE files for older releases.
8 ===
9 ==============================================================================
10
11 ------------------------------------------------------------------------------
12 --- Functionality changes from Asterisk 16 to Asterisk 17 --------------------
13 ------------------------------------------------------------------------------
14
15 chan_sip
16 ------------------
17  * The chan_sip module is now deprecated, users should migrate to the
18    replacement module chan_pjsip.  See guides at the Asterisk Wiki:
19      https://wiki.asterisk.org/wiki/x/tAHOAQ
20      https://wiki.asterisk.org/wiki/x/hYCLAQ
21
22 Channels
23 ------------------
24  * The core no longer uses the stasis cache for channels snapshots.
25    The following APIs are no longer available:
26        ast_channel_topic_cached()
27        ast_channel_topic_all_cached()
28    The ast_channel_cache_all() and ast_channel_cache_by_name() functions
29    now returns an ao2_container of ast_channel_snapshots rather than a
30    container of stasis_messages therefore you can't call stasis_cache
31    functions on it.
32    The ast_channel_topic_all() function now returns a normal topic,
33    not a cached one so you can't use stasis cache functions on it either.
34    The ast_channel_snapshot_type() stasis message now has the
35    ast_channel_snapshot_update structure as it's data.
36    ast_channel_snapshot_get_latest() still returns the latest snapshot.
37
38 Bridging
39 ------------------
40  * The bridging core no longer uses the stasis cache for bridge
41    snapshots.  The latest bridge snapshot is now stored on the
42    ast_bridge structure itself.
43
44  * The following APIs are no longer available since the stasis cache
45    is no longer used:
46      ast_bridge_topic_cached()
47      ast_bridge_topic_all_cached()
48
49  * A topic pool is now used for individual bridge topics.
50
51  * The ast_bridge_cache() function was removed since there's no
52    longer a separate container of snapshots.
53
54  * A new function "ast_bridges()" was created to retrieve the
55    container of all bridges.  Users formerly calling
56    ast_bridge_cache() can use the new function to iterate over
57    bridges and retrieve the latest snapshot directly from the
58    bridge.
59
60  * The ast_bridge_snapshot_get_latest() function was renamed to
61    ast_bridge_get_snapshot_by_uniqueid().
62
63  * A new function "ast_bridge_get_snapshot()" was created to retrieve
64    the bridge snapshot directly from the bridge structure.
65
66  * The ast_bridge_topic_all() function now returns a normal topic
67    not a cached one so you can't use stasis cache functions on it
68    either.
69
70  * The ast_bridge_snapshot_type() stasis message now has the
71    ast_bridge_snapshot_update structure as it's data.  It contains
72    the last snapshot and the new one.
73
74 ------------------------------------------------------------------------------
75 --- Functionality changes from Asterisk 16.1.0 to Asterisk 16.2.0 ------------
76 ------------------------------------------------------------------------------
77
78 res_pjsip
79 ------------------
80  * Added "send_contact_status_on_update_registration" global configuration option
81    to enable sending AMI ContactStatus event when a device refreshes its registration.
82
83 Core
84 ------------------
85  * Reworked the media indexer so it doesn't cache the index.  Testing revealed
86    that the cache added no benefit but that it could consume excessive memory.
87    Two new index related functions were created: ast_sounds_get_index_for_file()
88    and ast_media_index_update_for_file() which restrict index updating to
89    specific sound files.  The original ast_sounds_get_index() and
90    ast_media_index_update() calls are still available but since they no longer
91    cache the results internally, developers should re-use an index they may
92    already have instead of calling ast_sounds_get_index() repeatedly.  If
93    information for only a single file is needed, ast_sounds_get_index_for_file()
94    should be called instead of ast_sounds_get_index().
95
96 Features
97 ------------------
98  * Before Asterisk 12, when using the automon or automixmon features defined
99    in features.conf, a channel variable (TOUCH_MIXMONITOR_OUTPUT) was set on
100    both channels, indicating the filename of the recording.
101
102    When bridging was overhauled in Asterisk 12, the behavior was changed such
103    that the variable was only set on the peer channel and not on the channel
104    that initiated the automon or automixmon.
105
106    The previous behavior has been restored so both channels receive the
107    channel variable when one of these features is invoked.
108
109 app_voicemail
110 ------------------
111  * You can now specify a special context with the "aliasescontext" parameter
112    in voicemail.conf which will allow you to create aliases for physical
113    mailboxes.
114
115 ------------------------------------------------------------------------------
116 --- Functionality changes from Asterisk 16.0.0 to Asterisk 16.1.0 ------------
117 ------------------------------------------------------------------------------
118
119 pbx_config
120 ------------------
121  * pbx_config will now find and process multiple 'globals' sections from
122    extensions.conf.  Variables are processed in the order they are found
123    and duplicate variables overwrite the previous value.
124
125 chan_pjsip
126 ------------------
127  * New dialplan function PJSIP_PARSE_URI added to parse an URI and return
128    a specified part of the URI.
129
130 Core
131 ------------------
132  * ast_bt_get_symbols() now returns a vector of strings instead of an
133    array of strings.  This must be freed with ast_bt_free_symbols.
134
135 res_pjsip
136 ------------------
137  * New options 'trust_connected_line' and 'send_connected_line' have been
138    added to the endpoint. The option 'trust_connected_line' is to control
139    if connected line updates are accepted from this endpoint.
140    The option 'send_connected_line' is to control if connected line updates
141    can be sent to this endpoint.
142    The default value is 'yes' for both options.
143
144 res_rtp_asterisk
145 ------------------
146  * The existing strictrtp option in rtp.conf has a new choice availabe, called
147    'seqno', which behaves the same way as setting strictrtp to 'yes', but will
148    ignore the time interval during learning so that bursts of packets can still
149    trigger learning our source.
150
151 ------------------------------------------------------------------------------
152 --- Functionality changes from Asterisk 15 to Asterisk 16 --------------------
153 ------------------------------------------------------------------------------
154
155 app_fax
156 ------------------
157  * The app_fax module is now deprecated, users should migrate to the
158    replacement module res_fax.
159
160 app_originate
161 ------------------
162  * An 'a' option has been added to the Originate dialplan application which
163    will execute the originate in an asynchronous fashion. If set then the
164    application will return immediately without waiting for the originated
165    channel to answer.
166
167 Build System
168 ------------------
169  * MALLOC_DEBUG no longer has an effect on Asterisk's ABI.  Asterisk built
170    with MALLOC_DEBUG can now successfully load binary modules built without
171    MALLOC_DEBUG and vice versa.  Third-party pre-compiled modules no longer
172    need to have a special build with it enabled.
173
174  * Asterisk now depends on libjansson >= 2.11.  If this version is not
175    available on your distro you can use `./configure --with-jansson-bundled`.
176
177 app_macro
178 ------------------
179  * The app_macro module is now deprecated and by default it is no longer
180    built.  Users should migrate to app_stack (Gosub).  A warning is logged
181    the first time any Macro is used.
182
183 app_setcallerid
184 ------------------
185  * The app_setcallerid module has been removed. The CALLERID dialplan function
186    should be used instead.
187
188 chan_sip
189 ------------------
190  * New function SIP_HEADERS() enumerates all headers in the incoming INVITE.
191
192  * The variable GET_TRANSFERRER_DATA set in the peer channel causes matching
193    headers be retrieved from the REFER message and made accessible to the
194    dialplan in the hash TRANSFER_DATA.
195
196 chan_dahdi
197 ------------------
198  * Timeouts for reading digits from analog phones are now configurable in
199    chan_dahdi.conf: firstdigit_timeout, interdigit_timeout, matchdigit_timeout.
200
201 AMI
202 ------------------
203  * The ContactStatus and Status fields for the manager events ContactStatus
204    and ContactStatusDetail are now set to "NonQualified" when a contact exists
205    but has not been qualified.
206
207  * The "Newexten" event is now part of the "dialplan" class. The documentation
208    for Asterisk 15 already specified this, but the implementation was actually
209    using the "call" class instead.
210
211 ARI
212 ------------------
213  * The ContactInfo event's contact_status field is now set to "NonQualified"
214    when a contact exists but has not been qualified.
215
216 app_queue
217 ------------------
218  * Added the ability to set the wrapuptime in the configuration of member.
219    When set the wrapuptime on the member is used instead of the wrapuptime
220    defined for the queue itself.
221
222  * Added predial handler support for caller and callee channels with the
223    B and b options respectively.  This is similar to the predial support
224    in app_dial.
225
226 res_config_sqlite
227 ------------------
228  * The res_config_sqlite module is now deprecated, users should migrate to the
229    replacement module res_config_sqlite3.
230
231 res_monitor
232 ------------------
233  * The res_monitor module is now deprecated, users should migrate to the
234    replacement module app_mixmonitor.
235
236 res_pjsip
237 ------------------
238  * A new AMI action, PJSIPShowAors, has been added which displays information
239    about all configured PJSIP AORs.
240
241  * A new AMI action, PJSIPShowAuths, has been added which displays information
242    about all configured PJSIP Auths.
243
244  * A new AMI action, PJSIPShowContacts, has been added which displays information
245    about all configured PJSIP Contacts.
246
247 res_pjsip_registrar_expire
248 ------------------
249  * The res_pjsip_registrar_expire module has been removed.  The functionality has
250    been moved into res_pjsip_registrar.
251
252 func_audiohookinherit
253 ------------------
254  * The func_audiohookinherit module has been removed. Due to architectural changes
255    in Asterisk 12, audiohook inheritance is performed automatically and this
256    function now lacks function.
257
258 cdr_syslog
259 ------------------
260  * The cdr_syslog module is now deprecated and by default it is no longer
261    built.
262
263 cdr_sqlite
264 ------------------
265  * The cdr_sqlite module has been removed. Users should move to using the
266    cdr_sqlite3_custom module instead.
267
268 format_jpeg
269 ------------------
270  * The format_jpeg module has been removed.
271
272 pbx_dundi
273 ------------------
274  * DUNDi now supports IPv6
275
276 Core:
277 ------------------
278  * libedit is no longer available as an embedded library and must be provided
279    by the system.
280  * The STATIC_BUILD functionality has been removed as it has not been maintained
281    and has not worked in quite some time.
282  * The module loader now enforces inter-module dependencies.  This ensures that
283    a module is not started before another it depends on, even if preload is used.
284    If a dependency is not available or fails to startup this will block any
285    dependants from startup.
286  * Parts of the Asterisk core which can load configuration from realtime are now
287    built-in modules.  It is no longer necessary to preload realtime drivers as
288    they are always initialized before the built-in modules.
289
290 ------------------------------------------------------------------------------
291 --- Functionality changes from Asterisk 15.5.0 to Asterisk 15.6.0 ------------
292 ------------------------------------------------------------------------------
293
294 res_pjsip
295 ------------------
296  * A new option 'suppress_q850_reason_headers' has been added to the endpoint
297    object. Some devices can't accept multiple Reason headers and get confused
298    when both 'SIP' and 'Q.850' Reason headers are received.  This option allows
299    the 'Q.850' Reason header to be suppressed.  The default value is 'no'.
300
301 res_pjsip_endpoint_identifier_ip
302 ------------------
303  * Added regex support to the identify section match_header option.  You
304    specify a regex instead of an explicit string by surrounding the header
305    value with slashes:
306    match_header = SIPHeader: /regex/
307
308 ------------------------------------------------------------------------------
309 --- Functionality changes from Asterisk 15.4.0 to Asterisk 15.5.0 ------------
310 ------------------------------------------------------------------------------
311
312 Core
313 ------------------
314  * Core bridging and, more specifically, bridge_softmix have been enhanced to
315    relay received frames of type TEXT or TEXT_DATA to all participants in a
316    softmix bridge.  res_pjsip_messaging and chan_pjsip have been enhanced to
317    take advantage of this so when res_pjsip_messaging receives an in-dialog
318    MESSAGE message from a user in a conference call, it's relayed to all
319    other participants in the call.
320
321 app_sendtext
322 ------------------
323  * Support Enhanced Messaging.  SendText now accepts new channel variables
324    that can be used to override the To and From display names and set the
325    Content-Type of a message.  Since you can now set Content-Type, other
326    text/* content types are now valid.
327
328 app_confbridge
329 ------------------
330  * ConfbridgeList now shows talking status. This utilizes the same voice
331    detection as the ConfbridgeTalking event, so bridges must be configured
332    with "talk_detection_events=yes" for this flag to have meaning.
333
334  * ConfBridge can now send events to participants via in-dialog MESSAGEs.
335    All current Confbridge events are supported, such as ConfbridgeJoin,
336    ConfbridgeLeave, etc.  In addition to those events, a new event
337    ConfbridgeWelcome has been added that will send a list of all
338    current participants to a new participant.
339
340 res_pjsip
341 ------------------
342   * Two new options have been added to the system and endpoint objects to
343     control whether, on outbound calls, Asterisk will accept updated SDP answers
344     during the initial INVITE transaction when 100rel is not in effect.
345     This usually happens when the INVITE is forked to multiple UASs and more
346     than one sends an SDP answer or when a single UAS needs to change a media
347     port to switch from custom ringback to the actual media destination.
348
349     The 'follow_early_media_forked' option sets whether Asterisk will accept
350     the updated SDP when the To tag on the subsequent response is different than
351     that on the the previous response.  This usually occurs in the forked INVITE
352     scenario. The default value is "yes" which is the current behavior.
353
354     The 'accept_multiple_sdp_answers' flag sets whether Asterisk will accept the
355     updated SDP when the To tag on the subsequent response is the same as that
356     on the previous response. This can occur when a UAS needs to switch media
357     ports from custom ringback to the final media path.  The default value is
358     "no" which is the current behavior.
359
360     These options have to be enabled system-wide in the system config section
361     of pjsip.conf as well as on individual endpoints that require the
362     functionality.
363
364 ------------------------------------------------------------------------------
365 --- Functionality changes from Asterisk 15.3.0 to Asterisk 15.4.0 ------------
366 ------------------------------------------------------------------------------
367
368 Core
369 ------------------
370  * A new configuration option "genericplc_on_equal_codecs" was added to the
371    "plc" section of codecs.conf to allow generic packet loss concealment even
372    if no transcoding was originally needed.  Transcoding via SLIN is forced
373    in this case.
374
375 res_pjproject
376 ------------------
377  * Added the "cache_pools" option to pjproject.conf.  Disabling the option
378    helps track down pool content mismanagement when using valgrind or
379    MALLOC_DEBUG.  The cache gets in the way of determining if the pool contents
380    are used after free and who freed it.
381
382 res_pjsip_notify
383 ------------------
384  * Extend the PJSIPNotify AMI command to send an in-dialog notify on a
385    channel.
386
387 ------------------------------------------------------------------------------
388 --- Functionality changes from Asterisk 15.2.0 to Asterisk 15.3.0 ------------
389 ------------------------------------------------------------------------------
390
391 Core
392 ------------------
393  * During dialplan reload log messages are produced for each context,
394    extension and include.  These messages are no longer printed by the
395    verbose loggers, they are now only logged as debug messages.
396
397 app_confbridge
398 ------------------
399  * Added the Muted header to the ConfbridgeJoin AMI event to indicate the
400    participant's starting mute status.
401
402  * Made the AMI ConfbridgeList action's ConfbridgeList events output all
403    the standard channel snapshot headers instead of a few hand-coded channel
404    snapshot headers.  The benefit is that the CallerIDName gets disruptive
405    characters like CR, LF, Tab, and a few others escaped.  However, an empty
406    CallerIDName is now output as "<unknown>" instead of "<no name>".
407
408 app_followme
409 ------------------
410  * Added a new prompt, connecting-prompt, which will be played
411    (if configured) to the "winner" callee before connecting the call.
412
413 res_pjsip
414 ------------------
415  * Users who are matching endpoints by SIP header need to reevaluate their
416    global "endpoint_identifier_order" option in light of the "ip" endpoint
417    identifier method split into the "ip" and "header" endpoint identifier
418    methods.
419
420  * The pjsip_transport_event feature introduced in 15.1.0 has been refactored.
421    Any external modules that may have used that feature (highly unlikey) will
422    need to be changed as the API has been altered slightly.
423
424 res_pjsip_endpoint_identifier_ip
425 ------------------
426  * The endpoint identifier "ip" method previously recognized endpoints either
427    by IP address or a matching SIP header.  The "ip" endpoint identifier method
428    is now split into the "ip" and "header" endpoint identifier methods.  The
429    "ip" endpoint identifier method only matches by IP address and the "header"
430    endpoint identifier method only matches by SIP header.  The split allows the
431    user to control the relative priority of the IP address and the SIP header
432    identification methods in the global "endpoint_identifier_order" option.
433    e.g., If you have two type=identify sections where one matches by IP address
434    for endpoint alice and the other matches by SIP header for endpoint bob then
435    you can now predict which endpoint is matched when a request comes in that
436    matches both.
437
438 res_pjsip_pubsub
439 ------------------
440  * In an earlier release, inbound registrations on a reliable transport
441    were pruned on Asterisk restart since the TCP connection would have
442    been torn down and become unusable when Asterisk stopped.  This same
443    process is now also applied to inbound subscriptions.  Since this
444    required the addition of a new column to the ps_subscription_persistence
445    realtime table, users who store their subscriptions in a database will
446    need to run the "alembic upgrade head" process to add the column to
447    the schema.
448
449 res_pjsip_transport_management
450 ------------------
451  * Since res_pjsip_transport_management provides several attack
452    mitigation features, its functionality moved to res_pjsip and
453    this module has been removed.  This way the features will always
454    be available if res_pjsip is loaded.
455
456 ------------------------------------------------------------------------------
457 --- Functionality changes from Asterisk 15.1.0 to Asterisk 15.2.0 ------------
458 ------------------------------------------------------------------------------
459
460 Core
461 ------------------
462  * Added the "cache_media_frames" option to asterisk.conf.  Disabling the option
463    helps track down media frame mismanagement when using valgrind or
464    MALLOC_DEBUG.  The cache gets in the way of determining if the frame is
465    used after free and who freed it.  NOTE: This option has no effect when
466    Asterisk is compiled with the LOW_MEMORY compile time option enabled because
467    the cache code does not exist.
468
469 chan_sip
470 ------------------
471  * Calls to invalid extensions are now reported as an ACL failure security event
472    "no_extension_match".
473
474 res_rtp_asterisk
475 ------------------
476  * The X.509 certificate used for DTLS negotation can now be automatically
477    generated. This is supported by res_pjsip by specifying
478    "dtls_auto_generate_cert = yes" on a PJSIP endpoint. For chan_sip, you
479    would set "dtlsautogeneratecert = yes" either in the [general] section of
480    sip.conf or on a specific peer.
481
482 res_pjsip
483 ------------------
484  * The "identify_by" on endpoints can now be set to "ip" to restrict an endpoint
485    being matched based only on IP address. To ensure no behavior change the
486    default has been changed to "username,ip".
487
488 ------------------------------------------------------------------------------
489 --- Functionality changes from Asterisk 15.0.0 to Asterisk 15.1.0 ------------
490 ------------------------------------------------------------------------------
491
492 res_pjsip
493 ------------------
494  * The "remove_existing" option now allows a registration to succeed by
495    displacing any existing contacts that now exceed the "max_contacts" count.
496    Any removed contacts are the next to expire.  The behaviour change is
497    beneficial when "rewrite_contact" is enabled and "max_contacts" is greater
498    than one.  The removed contact is likely the old contact created by
499    "rewrite_contact" that the device is refreshing.
500
501 AMI
502 ------------------
503  * Added a new CancelAtxfer action that cancels an attended transfer.
504
505 ------------------------------------------------------------------------------
506 --- Functionality changes from Asterisk 14 to Asterisk 15 --------------------
507 ------------------------------------------------------------------------------
508
509 app_queue
510 ------------------
511  * PAUSEALL/UNPAUSEALL now sets the pause reason in the queue_log if it has
512    been defined.
513
514  * A new option, "announce-position-only-up," has been added that, when set to
515    yes, causes position announcements to only be played when the caller's
516    queue position has improved since the last time that we annouced their
517    position. This default is no.
518
519 Build System
520 ------------------
521  * '--with-pjproject-bundled' is now the default when running ./configure
522    It can be disabled with '--without-pjproject-bundled'.
523
524  * A '--with-download-cache' option is now available which is equivalent to
525    setting '--with-sounds-cache' and '--with-externals-cache' to the same
526    value.  The download cache can also be set via the AST_DOWNLOAD_CACHE
527    environment variable.
528
529 ------------------------------------------------------------------------------
530 --- Functionality changes from Asterisk 14.6.0 to Asterisk 14.7.0 ------------
531 ------------------------------------------------------------------------------
532
533 res_pjsip
534 ------------------
535  * The "external_media_address" on transports is now resolved using dnsmgr and
536    when dnsmgr refreshes are enabled will be automatically updated with the new
537    IP address of a given hostname.
538
539  * A new endpoint parameter "incoming_mwi_mailbox" allows Asterisk to receive
540    unsolicited MWI NOTIFY requests and make them available to other modules via
541    the stasis message bus.
542
543 res_musiconhold
544 ------------------
545  * By default, when res_musiconhold reloads or unloads, it sends a HUP signal
546    to custom applications (and all descendants), waits 100ms, then sends a
547    TERM signal, waits 100ms, then finally sends a KILL signal.  An application
548    which is interacting with an external device and/or spawns children of its
549    own may not be able to exit cleanly in the default times, expecially if sent
550    a KILL signal, or if it's children are getting signals directly from
551    res_musiconhoild.  To allow extra time, the 'kill_escalation_delay'
552    class option can be used to set the number of milliseconds res_musiconhold
553    waits before escalating kill signals, with the default being the current
554    100ms.  To control to whom the signals are sent, the "kill_method"
555    class option can be set to "process_group" (the default, existing behavior),
556    which sends signals to the application and its descendants directly, or
557    "process" which sends signals only to the application itself.
558
559  * New dialplan function PJSIP_DTMF_MODE added to get or change the DTMF mode
560    of a channel on a per-call basis.
561
562 res_xmpp
563 -----------------
564  * OAuth 2.0 authentication is now supported when contacting Google. Follow the
565    instructions in xmpp.conf.sample to retrieve and configure the necessary
566    tokens.
567
568 ------------------------------------------------------------------------------
569 --- Functionality changes from Asterisk 14.5.0 to Asterisk 14.6.0 ------------
570 ------------------------------------------------------------------------------
571
572 app_voicemail
573 ------------------
574  * A new global option "imap_poll_logout" was added to specify whether need to
575    disconnect from the IMAP server after polling of mailboxes.
576    Default: no
577
578 res_pjsip
579 ------------------
580  * A new endpoint option "refer_blind_progress" was added to turn off notifying
581    the progress details on Blind Transfer. If this option is not set then
582    the chan_pjsip will send NOTIFY "200 OK" immediately after "202 Accepted".
583    On default is enabled.
584    Some SIP phones like Mitel/Aastra or Snom keep the line busy until
585    receive "200 OK".
586
587  * A new endpoint option "notify_early_inuse_ringing" was added to control
588    whether to notify dialog-info state 'early' or 'confirmed' on Ringing
589    when already INUSE.
590
591  * The endpoint option 'dtmf_mode' has a new option 'auto_dtmf' added. This
592    mode works similar to 'auto' except uses DTMF INFO as fallback instead of
593    INBAND.
594
595 res_agi
596 ------------------
597  * The EAGI() application will now look for a dialplan variable named
598    EAGI_AUDIO_FORMAT and use that format with the 'enhanced' audio pipe that
599    EAGI provides. If not specified, it will continue to use the default signed
600    linear (slin).
601
602 chan_pjsip
603 ------------------
604  * When dialing an endpoint directly or using the PJSIP_DIAL_CONTACTS dialplan
605    function any contact which is considered unreachable due to qualify being
606    enabled will no longer be called.
607
608  * The asymmetric_rtp_codec option now also controls whether chan_pjsip will
609    send media as-is without transcoding if the codec has been negotiated in the
610    SDP. If set to "no" then Asterisk will only ever send the preferred codec
611    from the SDP, unless the remote side sends a different codec and we will
612    switch to match.
613
614 Build System
615 ------------------
616  * Added a new PJPROJECT_CONFIGURE_OPTS environment variable which can be used
617    to pass arbitrary options to the bundled pjproject configure.
618
619  * Automatically set the bundled pjproject configure --host and --build
620    options to match those supplied for the asterisk configure.
621
622 ------------------------------------------------------------------------------
623 --- Functionality changes from Asterisk 14.4.0 to Asterisk 14.5.0 ------------
624 ------------------------------------------------------------------------------
625
626 res_rtp_asterisk
627 ------------------
628  * Added the stun_blacklist option to rtp.conf.  Some multihomed servers have
629    IP interfaces that cannot reach the STUN server specified by stunaddr.
630    Blacklist those interface subnets from trying to send a STUN packet to find
631    the external IP address.  Attempting to send the STUN packet needlessly
632    delays processing incoming and outgoing SIP INVITEs because we will wait
633    for a response that can never come until we give up on the response.
634    Multiple subnets may be listed.
635
636 Logging
637 -------------------
638  * Added logger_queue_limit to the configuration options.
639    All log messages go to a queue serviced by a single thread
640    which does all the IO.  This setting controls how big that
641    queue can get (and therefore how much memory is allocated)
642    before new messages are discarded.
643    The default is 1000.
644
645 res_pjsip_config_wizard
646 ------------------
647  * Two new parameters have been added to the pjsip config wizard.
648    Setting 'sends_line_with_registrations' to true will cause the wizard
649    to skip the creation of an identify object to match incoming requests
650    to the endpoint and instead add the line and endpoint parameters to
651    the outbound registration object.
652    Setting 'outbound_proxy' is a shortcut for adding individual
653    endpoint/outbound_proxy, aor/outbound_proxy and registration/outbound_proxy
654    parameters.
655
656 res_hep_rtcp
657 ------------------
658  * If the 'call-id' value is specified for the uuid_type option and a
659    chan_sip channel is used the resulting HEP traffic will now contain the
660    SIP Call-ID instead of the Asterisk channel name.
661
662 ------------------------------------------------------------------------------
663 --- Functionality changes from Asterisk 14.3.0 to Asterisk 14.4.0 ------------
664 ------------------------------------------------------------------------------
665
666 Build System
667 ------------------
668  * LOW_MEMORY no longer has an effect on Asterisk ABI.  Symbols that were
669    previously suppressed by LOW_MEMORY are now replaced by stub functions.
670    Asterisk built with LOW_MEMORY can now successfully load binary modules
671    built without LOW_MEMORY and vice versa.
672
673  * RADIUS backends for CEL and CDR can now also be built using the radcli
674    client library, in addition to the existing support for building them
675    using either freeradius or radiusclient-ng.
676
677 Core
678 ------------------
679  * ASTERISK_REGISTER_FILE was no longer useful and has been removed.  Sources
680    which use mtx_prof must now manually declare and initialize the variable.
681
682 chan_sip
683 ------------------
684  * If an offer is received with optional SRTP (a media stream with RTP/AVP but
685    which contains a crypto line) chan_sip will now accept it and enable SRTP.
686    If you would like to do optional SRTP on outbound you will need to create
687    a dialplan that dials with it enabled initially and if it fails fall back to
688    without.
689
690 res_pjsip
691 ------------------
692  * Added endpoint configuration parameter "preferred_codec_only".
693    This allow asterisk response to a SIP invite with the single most
694    preferred codec rather than advertising all joint codec capabilities.
695    This limits the other side's codec choice to exactly what we prefer.
696
697 cdr_radius
698 ------------------
699  * To fix a memory leak the syslog channel is now empty if it has not been set
700    and used by a syslog channel in the logger.
701
702 cel_radius
703 ------------------
704  * To fix a memory leak the syslog channel is now empty if it has not been set
705    and used by a syslog channel in the logger.
706
707 RTP
708 ------------------
709  * New setting "rtp_pt_dynamic = 35" in asterisk.conf:
710    Normally the Dynamic RTP Payload Type numbers are 96-127, which allow just 32
711    formats. To avoid the message "No Dynamic RTP mapping available", the range
712    was changed to 35-63,96-127. This is allowed by RFC 3551 section 3. However,
713    when you use more than 32 formats and calls are not accepted by a remote
714    implementation, please report this and go back to rtp_pt_dynamic = 96.
715
716  * A new setting, "rtp_use_dynamic", has been added in asterisk.conf". When set
717    to "yes" RTP dynamic payload types are assigned dynamically per RTP instance.
718    When set to "no" RTP dynamic payload types are globally initialized to pre-
719    designated numbers and function similar to static payload types.
720
721 app_originate
722 ------------------
723  * Added support to gosub predial routines on both original channel and on the
724    created channel using options parameter (like app_dial) B() and b().  This
725    allows for adding variables to newly created channel or, e.g. setting callerid.
726
727 CLI Commands
728 ------------------
729  * 'dialplan show' output will now show [config_file:line_number] instead of
730    [registrar] when that information is available. Currently only extensions
731    registered by pbx_config when loading/reloading will use this format.
732
733 app_queue
734 ------------------
735  * Add 'QueueUpdate' application which can be used to track outbound calls
736    using app_queue.
737
738 pbx_spool
739 ------------------
740  * Asterisk will now set the AST_OUTGOING_ATTEMPT channel variable so that
741    attempt-specific behavior is possible. This is a 1-based number that
742    simply increases by 1 for each attempt.
743
744 ------------------------------------------------------------------------------
745 --- Functionality changes from Asterisk 14.3.0 to Asterisk 14.4.0 ------------
746 ------------------------------------------------------------------------------
747
748 AMI
749 ------------------
750  * The 'PJSIPShowEndpoint' command's respone event of 'IdentifyDetail' now
751    contains a new optional parameter, 'MatchHeader', mapping to the new
752    configuration option 'match_header' for the corresponding 'identify' object.
753    It should be noted that since 'match_header' takes in a key: value pair, the
754    event parameter will contain a ':' as well.
755
756 app_record
757 ------------------
758  * Added new 'u' option to Record() application which prevents Asterisk from
759    truncating silence from the end of recorded files.
760
761 res_pjsip_outbound_registration
762 ------------------
763  * Outbound registrations are now refreshed when res_stun_monitor detects
764    a network change event has happened.
765    The 'pjsip send (un)register' CLI commands were updated to accept '*all'
766    as an argument to operate on all registrations.
767    The 'PJSIP(Un)Register' AMI commands were updated to also accept '*all'.
768
769 app_voicemail
770 ------------------
771  * The 'Comedian Mail' prompts can now be overriden using the 'vm-login' and
772    'vm-newuser' configuration options in voicemail.conf.
773
774  * Added 'fromstring' field to the voicemail boxes. If set, it will override
775    the global 'fromstring' field on a per-mailbox basis.
776
777 func_channel
778 ------------------
779  * Added CHANNEL(callid) to retrieve the call log tag associated with the
780    channel.  e.g., [C-00000000]  Dialplan now has access to the call log
781    search key associated with the channel so it can be saved in case there
782    is a problem with the call.
783
784 res_pjsip
785 ------------------
786  * A new transport parameter 'symmetric_transport' has been added.
787    When a request from a dynamic contact comes in on a transport with this
788    option set to 'yes', the transport name will be saved and used for
789    subsequent outgoing requests like OPTIONS, NOTIFY and INVITE.  It's
790    saved as a contact uri parameter named 'x-ast-txp' and will display with
791    the contact uri in CLI, AMI, and ARI output.  On the outgoing request,
792    if a transport wasn't explicitly set on the endpoint AND the request URI
793    is not a hostname, the saved transport will be used and the 'x-ast-txp'
794    parameter stripped from the outgoing packet.  To facilitate recreation of
795    subscriptions on asterisk restart, a new column 'contact_uri' needed to be
796    added to the ps_subcsription_persistence table.  Since new columns were
797    added to both transport and subscription_persistence, an alembic upgrade
798    should be run to bring the database tables up to date.
799
800  * A new option, allow_overlap, has been added to endpoints which allows
801    overlap dialing functionality to be enabled or disabled. The option defaults
802    to enabled.
803
804 res_pjsip_transport_websocket
805 ------------------
806  * Removed non-secure websocket support.  Firefox and Chrome have not allowed
807    non-secure websockets for quite some time so this shouldn't be an issue
808    for people.  Attempting to use a non-secure websocket may or may not work
809    when Asterisk attempts to send SIP requests to do something like initiate
810    call hangup.
811
812 res_pjsip_endpoint_identifier_ip
813 ------------------
814  * A new option has been added to the 'identify' configuration object,
815    'match_header'. The 'match_header' attribute should contain a SIP
816    header: value pair that, When set, will cause inbound requests that contain
817    the matching SIP header/value pair to be associated with the corresponding
818    endpoint. This option is cumulative with the 'match' option, so that if
819    either option matches the request, the request is associated with the
820    endpoint.
821
822    In a future release, this module will be renamed to something more
823    appropriate, as it now matches inbound requests on more than just IP
824    address.
825
826 res_rtp_asterisk
827 -----------------
828  * The RTP layer of Asterisk now has support for RFC 5761: "Multiplexing RTP
829    Data and Control Packets on a Single Port." So far, the only channel driver
830    that supports this feature is chan_pjsip. You can set "rtcp_mux = yes" on
831    a PJSIP endpoint in pjsip.conf to enable the feature.
832
833 ------------------------------------------------------------------------------
834 --- Functionality changes from Asterisk 14.2.0 to Asterisk 14.3.0 ------------
835 ------------------------------------------------------------------------------
836
837 res_pjproject
838 ------------------
839  * Added new CLI command "pjproject set log level".  The new command allows
840    the maximum PJPROJECT log levels to be adjusted dynamically and
841    independently from the set debug logging level like many other similar
842    module debug logging commands.
843
844  * Added new companion CLI command "pjproject show log level" to allow the
845    user to see the current maximum pjproject logging level.
846
847  * Added new pjproject.conf startup section "log_level' option to set the
848    initial maximum PJPROJECT logging level.
849
850 res_pjsip_outbound_registration
851 ------------------
852  * Statsd no longer logs redundant status PJSIP.registrations.state changes
853    for internal state transitions that don't change the reported public status
854    state.
855
856 res_pjsip_registrar
857 ------------------
858  * The PJSIPShowRegistrationInboundContactStatuses AMI command has been added
859    to return ContactStatusDetail events as opposed to
860    PJSIPShowRegistrationsInbound which just a dumps every defined AOR.
861
862 res_pjsip
863 ------------------
864  * Six existing contact fields have been added to the end of the
865    ContactStatusDetail AMI event:
866    ID, AuthenticateQualify, OutboundProxy, Path, QualifyFrequency and
867    QualifyTimeout.  Existing fields have not been disturbed.
868
869 res_pjsip_endpoint_identifier_ip
870 ------------------
871  * SRV lookups can now be done on provided hostnames to determine additional
872    source IP addresses for requests. This is configurable using the
873    "srv_lookups" option on the identify and defaults to "yes".
874
875 ARI
876 ------------------
877  * The 'ari set debug' command has been enhanced to accept 'all' as an
878    application name.  This allows dumping of all apps even if an app
879    hasn't registered yet.
880
881  * 'ari set debug' now displays requests and responses as well as events.
882
883 ------------------------------------------------------------------------------
884 --- Functionality changes from Asterisk 14.1.0 to Asterisk 14.2.0 ------------
885 ------------------------------------------------------------------------------
886
887 AMI
888 ------------------
889  * Events that reference a bridge may now contain two new optional fields:
890    - 'BridgeVideoSourceMode': the video source mode for the bridge.
891      Can be one of 'none', 'talker', or 'single'.
892    - 'BridgeVideoSource': the unique ID of the channel that is the video
893      source in this bridge, if one exists.
894
895  * A new event, BridgeVideoSourceUpdate, has been added with a class
896    authorization of CALL. The event is raised when the video source changes
897    in a multi-party mixing bridge.
898
899 ARI
900 ------------------
901  * The bridges resource now exposes two new operations:
902    - POST /bridges/{bridgeId}/videoSource/{channelId}: Set a video source in a
903      multi-party mixing bridge
904    - DELETE /bridges/{bridgeId}/videoSource: Remove the set video source,
905      reverting to talk detection for the video source
906
907  * The bridge model in any returned response or event now contains the following
908    optional fields:
909    - video_mode: the video source mode for the bridge. Can be one of 'none',
910      'talker', or 'single'.
911    - video_source_id: the unique ID of the channel that is the video source
912      in this bridge, if one exists.
913
914  * A new event, BridgeVideoSourceChanged, has been added for bridges.
915    Applications subscribed to a bridge will receive this event when the source
916    of video changes in a mixing bridge.
917
918  * The ARI major version has been bumped. There are not any known breaking changes
919    in ARI. The major version has been bumped because otherwise we can end up with
920    overlapping version numbers between different Asterisk versions. Now each major
921    version of Asterisk will bring with it a change in the major version of ARI.
922    The ARI version in Asterisk 14 is now 2.0.0.
923
924 res_pjsip
925 ------------------
926  * Automatic dual stack support is now implemented. Depending on DNS resolution
927    and the transport used for sending a message the SIP signaling and SDP will
928    be updated with the correct IP address and protocol version. This means that
929    the rtp_ipv6 and t38_udptl_ipv6 options no longer have any effect. The
930    res_pjsip_multihomed module has also been moved into core res_pjsip to ensure
931    that messages are updated with the correct address information in all cases.
932
933 chan_pjsip
934 ------------------
935  * The default behavior for RTP codecs has been changed. The sending codec will
936    now match the receiving codec. This can be turned off and behavior reverted
937    to asymmetric using the "asymmetric_rtp_codec" endpoint option. If this
938    option is set then the sending and received codec are allowed to differ.
939
940 CLI Commands
941 ------------------
942  * Three new CLI commands have been added for ARI:
943    - ari show apps:
944       Displays a listing of all registered ARI applications.
945    - ari show app <name>:
946       Display detailed information about a registered ARI application.
947    - ari set debug <name> <on|off>:
948       Enable/disable debugging of an ARI application. When debugged, verbose
949       information will be sent to the Asterisk CLI.
950
951
952 Queue
953 ------------------
954  * A new dialplan variable, ABANDONED, is set when the call is not answered
955    by an agent.
956
957 res_ari
958 ------------------
959  * The configuration file ari.conf now supports a channelvars option, which
960    specifies a list of channel variables to include in each channel-oriented
961    ARI event.
962
963 ------------------------------------------------------------------------------
964 --- Functionality changes from Asterisk 14.0.0 to Asterisk 14.1.0 ------------
965 ------------------------------------------------------------------------------
966
967 Build System
968 ------------------
969  * The res_digium_phone, codec_g729a, codec_silk, codec_siren7 and
970    codec_siren14 binary modules hosted at downloads.digium.com can now be
971    automatically downloaded and installed during the Asterisk install
972    process.  If selected in menuselect, when 'make install' is run, the
973    script will check the downloads site for a new version and download
974    and install it if needed.  The '--with-externals-cache' option to
975    ./configure can be used to specify a location to cache the latest
976    tarballs so they don't have to be re-downloaded for every install.
977
978 app_voicemail
979 ------------------
980  * Added "tps_queue_high" and "tps_queue_low" options.
981    The options can modify the taskprocessor alert levels for this module.
982    Additional information can be found in the sample configuration file at
983    config/samples/voicemail.conf.sample.
984
985 res_pjsip_mwi
986 ------------------
987  * Added "mwi_tps_queue_high" and "mwi_tps_queue_low" global configuration
988    options to tune taskprocessor alert levels.
989
990  * Added "mwi_disable_initial_unsolicited" global configuration option
991    to disable sending unsolicited MWI to all endpoints on startup.
992    Additional information can be found in the sample configuration file at
993    config/samples/pjsip.conf.sample.
994
995 chan_pjsip
996 ------------------
997  * A new dialplan function, PJSIP_SEND_SESSION_REFRESH, has been added. When
998    invoked, a re-INVITE or UPDATE request will be sent immediately to the
999    endpoint underlying the channel. When used in combination with the existing
1000    dialplan function PJSIP_MEDIA_OFFER, this allows the formats on a PJSIP
1001    channel to be re-negotiated and updated after session set up.
1002
1003 res_pjsip
1004 ------------------
1005  * A new endpoint configuration parameter 'contact_user' has been added which
1006    when set will override the default user set on Contact headers in outgoing
1007    requests.
1008
1009  * If you are using a sorcery realtime backend to store global res_pjsip
1010    options (ps_globals table) then you now have to do a res_pjsip reload for
1011    changes to these options to take effect.  If you are using pjsip.conf to
1012    configure these options then you already had to do a reload after making
1013    changes.
1014
1015  * Added "ignore_uri_user_options" global configuration option for
1016    compatibility with an ITSP that sends URI user field options.  When enabled
1017    the user field is truncated at the first semicolon.
1018    Example:
1019    URI: "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
1020    The user field is "1235557890;phone-context=national"
1021    Which is truncated to this: "1235557890"
1022
1023    Note: The caller-id and redirecting number strings obtained from incoming
1024    SIP URI user fields are now always truncated at the first semicolon.
1025
1026 res_rtp_asterisk
1027 ------------------
1028   * An option, ice_blacklist, has been added which allows certain subnets to be
1029     excluded from local ICE candidates.
1030
1031 app_confbridge
1032 ------------------
1033   * Some sounds played into the bridge are played asynchronously. This, for
1034     instance, allows a channel to immediately exit the ConfBridge without having
1035     to wait for a leave announcement to play.
1036
1037 app_dial
1038 ------------------
1039  * Added the "Q" option which sets the Q.850/Q.931 cause on unanswered channels
1040    when another channel answers the call.  The default of ANSWERED_ELSEWHERE
1041    is unchanged.
1042
1043 res_ari
1044 ------------------
1045  * ARI events will all now include a new field in the root of the JSON message,
1046    'asterisk_id'.  This will be the unique ID for the Asterisk system
1047    transmitting the event.  The value can be overridden using the 'entityid'
1048    setting in asterisk.conf.
1049
1050 ------------------------------------------------------------------------------
1051 --- Functionality changes from Asterisk 13 to Asterisk 14 --------------------
1052 ------------------------------------------------------------------------------
1053
1054 AMI
1055 -----------------
1056  * A new event, "DialState" has been added. This is similar to "DialBegin" and
1057  "DialEnd" in that it tracks the state of a dialed call. The difference is that
1058  this indicates some intermediate state change in the dial attempt, such as
1059  "RINGING", "PROGRESS", or "PROCEEDING".
1060
1061 ARI
1062 -----------------
1063  * A new ARI method has been added to the channels resource. "create" allows for
1064    you to create a new channel and place that channel into a Stasis application.
1065    This is similar to origination except that the specified channel is not
1066    dialed. This allows for an application writer to create a channel, perform
1067    manipulations on it, and then delay dialing the channel until later.
1068
1069  * To complement the "create" method, a "dial" method has been added to the
1070    channels resource in order to place a call to a created channel.
1071
1072  * All operations that initiate playback of media on a resource now support
1073    a list of media URIs. The list of URIs are played in the order they are
1074    presented to the resource. A new event, "PlaybackContinuing", is raised when
1075    a media URI finishes but before the next media URI starts. When a list is
1076    played, the "Playback" model will contain the optional attribute
1077    "next_media_uri", which specifies the next media URI in the list to be played
1078    back to the resource. The "PlaybackFinished" event is raised when all media
1079    URIs are done.
1080
1081  * Stored recordings now allow for the media associated with a stored recording
1082    to be retrieved. The new route, GET /recordings/stored/{name}/file, will
1083    transmit the raw media file to the requester as binary.
1084
1085
1086  * "Dial" events have been modified to not only be sent when dialing begins and ends.
1087  They now are also sent for intermediate states, such as "RINGING", "PROGRESS", and
1088  "PROCEEDING".
1089
1090 Applications
1091 ------------------
1092
1093 BridgeAdd
1094 ------------------
1095  * A new application in Asterisk, this will join the calling channel
1096    to an existing bridge containing the named channel prefix.
1097
1098 ChanSpy
1099 ------------------
1100  * Added the 'l' option, which forces ChanSpy's audiohook to use a long queue
1101    to store the audio frames. This option is useful if audio loss is
1102    experienced when using ChanSpy, but may introduce some delay in the audio
1103    feed on the listening channel.
1104
1105 Codecs
1106 ------------------
1107  * Added format attribute negotiation for the iLBC audio codec. Format attribute
1108    negotiation is provided by the res_format_attr_ilbc module. iLBC 20 is the
1109    default now. Falls back to iLBC 30, when the remote party requests this.
1110
1111 ConfBridge
1112 ------------------
1113  * Added the ability to pass options to MixMonitor when recording is used with
1114    ConfBridge. This includes the addition of the following configuration
1115    parameters for the 'bridge' object:
1116    - record_file_timestamp: whether or not to append the start time to the
1117      recorded file name
1118    - record_options: the options to pass to the MixMonitor application
1119    - record_command: a command to execute when recording is finished
1120    Note that these options may also be with the CONFBRIDGE function.
1121
1122 ControlPlayback
1123 ------------------
1124  * Remote files can now be retrieved and played back. See the Playback
1125    dialplan application for more details.
1126
1127 FollowMe
1128 ------------------
1129  * It is now possible to disable the prompt from a callee by setting
1130    'enable_callee_prompt = no' in followme.conf.
1131
1132 Playback
1133 ------------------
1134  * Remote files can now be retrieved and played back via the Playback and other
1135    media playback dialplan applications. This is done by directly providing
1136    the URL to play to the dialplan application:
1137      same => n,Playback(http://1.1.1.1/howler-monkeys-fl.wav)
1138    Note that unlike 'normal' media files, the entire URI to the file must be
1139    provided, including the file extension. Currently, on HTTP and HTTPS URI
1140    schemes are supported.
1141
1142 Queue
1143 -------------------
1144  * Added field ReasonPause on QueueMemberStatus if set when paused, the reason
1145    the queue member was paused.
1146
1147  * Added field LastPause on QueueMemberStatus for time when started the last
1148    pause for a queue member.
1149
1150  * Show the time when started the last pause for queue member on CLI for command
1151    'queue show'.
1152
1153 SMS
1154 ------------------
1155  * Added the 'n' option, which prevents the SMS from being written to the log
1156    file. This is needed for those countries with privacy laws that require
1157    providers to not log SMS content.
1158
1159
1160 Channel Drivers
1161 ------------------
1162
1163 chan_dahdi
1164 ------------------
1165  * The CALLERID(ani2) value for incoming calls is now populated in featdmf
1166    signaling mode.  The information was previously discarded.
1167
1168  * Added the force_restart_unavailable_chans compatibility option.  When
1169    enabled it causes Asterisk to restart the ISDN B channel if an outgoing
1170    call receives cause 44 (Requested channel not available).
1171
1172 chan_iax2
1173 ------------------
1174  * The iax.conf forcejitterbuffer option has been removed.  It is now always
1175    forced if you set iax.conf jitterbuffer=yes.  If you put a jitter buffer
1176    on a channel it will be on the channel.
1177
1178  * A new configuration parameters, 'calltokenexpiration', has been added that
1179    controls the duration before a call token expires. Default duration is 10
1180    seconds. Setting this to a higher value may help in lagged networks or those
1181    experiencing high packet loss.
1182
1183  * Plaintext auth mode is deprecated and removed from possible default modes.
1184
1185 chan_rtp (was chan_multicast_rtp)
1186 ------------------
1187  * Added unicast RTP support and renamed chan_multicast_rtp to chan_rtp.
1188
1189  * The format for dialing a unicast RTP channel is:
1190    UnicastRTP/<destination-addr>[/[<options>]]
1191    Where <destination-addr> is something like '127.0.0.1:5060'.
1192    Where <options> are in standard Asterisk flag options format:
1193    c(<codec>) - Specify which codec/format to use such as 'ulaw'.
1194    e(<engine>) - Specify which RTP engine to use such as 'asterisk'.
1195
1196  * New options were added for a multicast RTP channel.  The format for
1197    dialing a multicast RTP channel is:
1198    MulticastRTP/<type>/<destination-addr>[/[<control-addr>][/[<options>]]]
1199    Where <type> can be either 'basic' or 'linksys'.
1200    Where <destination-addr> is something like '224.0.0.3:5060'.
1201    Where <control-addr> is something like '127.0.0.1:5060'.
1202    Where <options> are in standard Asterisk flag options format:
1203    c(<codec>) - Specify which codec/format to use such as 'ulaw'.
1204    i(<address>) - Specify the interface address from which multicast RTP
1205      is sent.
1206    l(<enable>) - Set whether packets are looped back to the sender.  The
1207      enable value can be 0 to set looping to off and non-zero to set
1208      looping on.
1209    t(<ttl>) - Set the time-to-live (TTL) value for multicast packets.
1210
1211 chan_sip
1212 ------------------
1213  * New 'rtpbindaddr' global setting. This allows a user to define which
1214    ipaddress to bind the rtpengine to. For example, chan_sip might bind
1215    to eth0 (10.0.0.2) but rtpengine to eth1 (192.168.1.10).
1216
1217  * DTLS related configuration options can now be set at a general level.
1218    Enabling DTLS support, though, requires enabling it at the user
1219    or peer level.
1220
1221  * Added the possibility to set the From: header through the the SIP dial
1222    string (populating the fromuser/fromdomain fields), complementing the
1223    [!dnid] option for the To: header that has existed since 1.6.0 (1d6b192).
1224    NOTE: This is again separated by an exclamation mark, so the To: header may
1225    not contain one of those.
1226
1227  * Session-Timers (RFC 4028) work for TCP (and TLS) transports as well now.
1228    Previously Asterisk dropped calls only with UDP transports. However with
1229    longer international calls via TCP, the SIP channel might break, because
1230    all hops on the Internet route must stay online (have not a single power
1231    outage, for example). Therefore with Session-Timers enabled (which are
1232    enabled at default), you might see additional dropped calls. Consequently
1233    please, consider to go for session-timers=refuse in your sip.conf.
1234
1235 chan_pjsip
1236 ------------------
1237  * New 'user_eq_phone' endpoint setting. This adds a 'user=phone' parameter
1238    to the request URI and From URI if the user is determined to be a phone
1239    number.
1240
1241  * New 'moh_passthrough' endpoint setting. This will pass hold and unhold
1242    requests through using SIP re-invites with sendonly and sendrecv accordingly.
1243
1244  * Added the pjsip.conf system type disable_tcp_switch option.  The option
1245    allows the user to disable switching from UDP to TCP transports described
1246    by RFC 3261 section 18.1.1.
1247
1248  * New 'line' and 'endpoint' options added on outbound registrations. This
1249    allows some identifying information to be added to the Contact of the
1250    outbound registration. If this information is present on messages received
1251    from the remote server the message will automatically be associated with the
1252    configured endpoint on the outbound registration.
1253
1254
1255 Core
1256 ------------------
1257  * The core of Asterisk uses a message bus called "Stasis" to distribute
1258    information to internal components. For performance reasons, the message
1259    distribution was modified to make use of a thread pool instead of a
1260    dedicated thread per consumer in certain cases. The initial settings for
1261    the thread pool can now be configured in 'stasis.conf'.
1262
1263  * A new core DNS API has been implemented which provides a common interface
1264    for DNS functionality. Modules that use this functionality will require that
1265    a DNS resolver module is loaded and available.
1266
1267  * Modified processing of command-line options to first parse only what
1268    is necessary to read asterisk.conf. Once asterisk.conf is fully loaded,
1269    the remaining options are processed.  The -X option now applies to
1270    asterisk.conf only.  To enable #exec for other config files you must
1271    set execincludes=yes in asterisk.conf.  Any other option set on the
1272    command-line will now override the equivalent setting from asterisk.conf.
1273
1274  * The TLS core in Asterisk now supports X.509 certificate subject alternative
1275    names. This way one X.509 certificate can be used for hosts that can be
1276    reached under multiple DNS names or for multiple hosts.
1277
1278  * The Asterisk logging system now supports JSON structured logging. Log
1279    channels specified in logger.conf or added dynamically via CLI commands now
1280    support an optional specifier prior to their levels that determines their
1281    formatting. To set a log channel to format its entries as JSON, a formatter
1282    of '[json]' can be set, e.g.,
1283       full => [json]debug,verbose,notice,warning,error
1284
1285  * The core now supports a 'media cache', which stores temporary media files
1286    retrieved from external sources. CLI commands have been added to manipulate
1287    and display the cached files, including:
1288    - 'media cache show <all>' - show all cached media files, or details about
1289      one particular cached media file
1290    - 'media cache refresh <item>' - force a refresh of a particular media file
1291      in the cache
1292    - 'media cache delete <item>' - remove an item from the cache
1293    - 'media cache create <uri>' - retrieve a URI and store it in the cache
1294
1295  * The ability for device state hints to be automatically created as a result of
1296    device state changes now exists in the PBX. This functionality is referred to
1297    as "autohints" and is configurable in extensions.conf by placing "autohints=yes"
1298    in the context. If enabled a device state hint will be automatically created
1299    with the name of the device.
1300
1301 * If Asterisk is built with systemd support, and run under systemd, it will
1302   notify systemd of its state using sd_notify. Use 'Type=notify' in
1303   asterisk.service.
1304
1305 Functions
1306 ------------------
1307  * The func_odbc global option "single_db_connection" default value has been
1308    changed to 'no'.
1309
1310
1311 Formats
1312 ------------------
1313  * New module format_ogg_speex added which supports Speex codec inside
1314    Ogg containers (filename extension .spx).
1315
1316
1317 CHANNEL
1318 ------------------
1319  * Added CHANNEL(onhold) item that returns 1 (onhold) and 0 (not-onhold) for
1320    the hold status of a channel.
1321
1322 CURL
1323 ------------------
1324  * The CURL function now supports a write option, which will save the retrieved
1325    file to a location on disk. As an example:
1326      same => n,Set(CURL(https://1.1.1.1/foo.wav)=/tmp/foo.wav)
1327    will save 'foo.wav' to /tmp.
1328
1329 DTMF Features
1330 ------------------
1331  * The transferdialattempts default value has been changed from 1 to 3. The
1332    transferinvalidsound has been changed from "pbx-invalid" to
1333    "privacy-incorrect". These were changed to make DTMF transfers be more
1334    user-friendly by default.
1335
1336
1337 Resources
1338 ------------------
1339
1340 res_http_media_cache
1341 ------------------
1342  * A backend for the core media cache, this module retrieves media files from
1343    a remote HTTP(S) server and stores them in the core media cache for later
1344    playback.
1345
1346 res_musiconhold
1347 ------------------
1348  * Added sort=randstart to the sort options. It sorts the files by name and
1349    then chooses the first file to play at random.
1350  * Added preferchannelclass=no option to prefer the application-passed class
1351    over the channel-set musicclass. This allows separate hold-music from
1352    application (e.g. Queue or Dial) specified music.
1353
1354 res_resolver_unbound
1355 ------------------
1356  * Added a res_resolver_unbound module which uses the libunbound resolver library
1357    to perform DNS resolution. This module requires the libunbound library to be
1358    installed in order to be used.
1359
1360 res_pjsip
1361 ------------------
1362  * A new SIP resolver using the core DNS API has been implemented. This relies on
1363    external SIP resolver support in PJSIP which is only available as of PJSIP
1364    2.4. If this support is unavailable the existing built-in PJSIP SIP resolver
1365    will be used instead. The new SIP resolver provides NAPTR support, improved
1366    SRV support, and AAAA record support.
1367
1368 res_pjsip_info_empty
1369 --------------------
1370  * A new module that can respond to empty Content-Type INFO packets during call.
1371    Some SBCs will terminate a call if their empty INFO packets are not responded
1372    to within a predefined time.
1373
1374 res_pjsip_outbound_registration
1375 -------------------------------
1376 * A new 'fatal_retry_interval' option has been added to outbound registration.
1377   When set (default is zero), and upon receiving a failure response to an
1378   outbound registration, registration is retried at the given interval up to
1379   'max_retries'.
1380
1381 res_pjsip_outbound_publish
1382 ------------------
1383  * Added a new multi_user option that when set to 'yes' allows a given configuration
1384    to be used for multiple users.
1385
1386
1387 CEL Backends
1388 ------------------
1389
1390 cel_pgsql
1391 ------------------
1392  * Added a new option, 'usegmtime', which causes timestamps in CEL events
1393    to be logged in GMT.
1394
1395  * Added support to set schema where located the table cel. This settings is
1396    configurable for cel_pgsql via the 'schema' in configuration file
1397    cel_pgsql.conf.
1398
1399
1400 CDR Backends
1401 ------------------
1402
1403 cdr_adaptive_odbc
1404 ------------------
1405  * Added the ability to set the character to quote identifiers. This
1406    allows adding the character at the start and end of table and column
1407    names. This setting is configurable for cdr_adaptive_odbc via the
1408    quoted_identifiers in configuration file cdr_adaptive_odbc.conf.
1409
1410 cdr_odbc
1411 ------------------
1412  * Added a new configuration option, "newcdrcolumns", which enables use of the
1413    post-1.8 CDR columns 'peeraccount', 'linkedid', and 'sequence'.
1414
1415 cdr_csv
1416 ------------------
1417  * Added a new configuration option, "newcdrcolumns", which enables use of the
1418    post-1.8 CDR columns 'peeraccount', 'linkedid', and 'sequence'.
1419
1420 ------------------------------------------------------------------------------
1421 --- Functionality changes from Asterisk 13.10.0 to Asterisk 13.11.0 ----------
1422 ------------------------------------------------------------------------------
1423
1424 chan_dahdi
1425 ------------------
1426  * Added "faxdetect_timeout" option.
1427    The option determines how many seconds into a call before faxdetect
1428    is disabled for the call.  Setting the value to zero disables the timeout.
1429
1430 res_pjsip
1431 ------------------
1432  * Added "fax_detect_timeout" to endpoint.
1433    The option determines how many seconds into a call before fax_detect
1434    is disabled for the call.  Setting the value to zero disables the timeout.
1435
1436  * Added "subscribe_context" to endpoint.
1437    If specified, incoming SUBSCRIBE requests will be searched for the matching
1438    extension in the indicated context. If no "subscribe_context" is specified,
1439    then the "context" setting is used.
1440
1441 res_rtp_asterisk
1442 ------------------
1443  * The DTLS part in Asterisk now supports Perfect Forward Secrecy (PFS).
1444    Enabling PFS is attempted by default, and is dependent on the configuration
1445    of the module using TLS.
1446    - Ephemeral ECDH (ECDHE) is enabled by default. To disable it, do not
1447      specify a ECDHE cipher suite in sip.conf, for example:
1448        dtlscipher=AES128-SHA
1449    - Ephemeral DH (DHE) is disabled by default. To enable it, add DH parameters
1450      into the private key file, e.g., sip.conf dtlsprivatekey. For example:
1451        openssl dhparam -out ./dh.pem 2048
1452    - Because clients expect the server to prefer PFS, and because OpenSSL sorts
1453      its cipher suites by bit strength, see "openssl ciphers -v DEFAULT".
1454      Consider re-ordering your cipher suites in the respective configuration
1455      file. For example:
1456        dtlscipher=ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256
1457      which forces PFS and requires at least DTLS 1.2.
1458
1459 ------------------------------------------------------------------------------
1460 --- Functionality changes from Asterisk 13.9.0 to Asterisk 13.10.0 -----------
1461 ------------------------------------------------------------------------------
1462
1463 Core
1464 ------------------
1465  * A channel variable FORWARDERNAME is now set which indicates which channel
1466    was responsible for a forwarding requests received on dial attempt.
1467
1468 func_odbc
1469 ------------------
1470  * Added new global option "single_db_connection".
1471    Enabling this option func_odbc will use a single database connection per DSN.
1472    This option is enabled by default.
1473
1474 res_fax
1475 ------------------
1476  * Added FAXMODE variable to let dialplan know what fax transport was used.
1477    FAXMODE variable is set to either "audio" or "T38".
1478
1479 res_pjsip
1480 ------------------
1481  * Added "via_addr", "via_port", "call_id" to contacts.
1482    As res_pjsip_nat rewrites contact's address, only the last Via header
1483    can contain the source address of registered endpoint.
1484    Also Call-Id header may contain the source address of registered endpoint.
1485    Added new fields ViaAddress,CallID to AMI event ContactStatus
1486
1487  * Endpoint IP Access Controls
1488    Added new configuration Endpoint options:
1489     "acl" - list of IP ACL section names in acl.conf
1490     "deny" - List of IP addresses to deny access from
1491     "permit" - List of IP addresses to permit access from
1492     "contact_acl" - List of Contact ACL section names in acl.conf
1493     "contact_deny" - List of Contact header addresses to deny
1494     "contact_permit" - List of Contact header addresses to permit
1495
1496  * Added "reg_server" to contacts.
1497    If the Asterisk system name is set in asterisk.conf, it will be stored
1498    into the "reg_server" field in the ps_contacts table to facilitate
1499    multi-server setups.
1500
1501  * When starting Asterisk, received traffic will now be ignored until Asterisk
1502    has loaded all modules and is fully booted.
1503
1504 res_hep
1505 ------------------
1506  * Added a new option, 'uuid_type', that sets the preferred source of the Homer
1507    correlation UUID. The valid options are:
1508    - call-id: Use the PJSIP SIP Call-ID header value
1509    - channel: Use the Asterisk channel name
1510    The default value is 'call-id'. In the event that a HEP module cannot find a
1511    valid value using the specified 'uuid_type', the module may fallback to a
1512    more readily available source for the correlation UUID.
1513
1514 res_odbc
1515 ------------------
1516  * A new option has been added, 'max_connections', which sets the maximum number
1517    of concurrent connections to the database. This option defaults to 1 which
1518    returns the behavior to that of Asterisk 13.7 and prior.
1519
1520 app_confbridge
1521 ------------------
1522  * Added a bridge profile option called regcontext that allows you to
1523    dynamically register the conference bridge name as an extension into
1524    the specified context.  This allows tracking down conferences on multi-
1525    server installations via alternate means (DUNDI for example). By default
1526    this feature is not used.
1527
1528 Codecs
1529 ------------------
1530  * Added the associated format name to 'core show codecs'.
1531
1532 res_ari_channels
1533 ------------------
1534  * Added 'formats' to channel create/originate to allow setting the allowed
1535    formats for a channel when no originator channel is available.  Especially
1536    useful for Local channel creation where no other format information is
1537    available.  'core show codecs' can now be used to look up suitable format
1538    names.
1539
1540 ------------------------------------------------------------------------------
1541 --- Functionality changes from Asterisk 13.8.0 to Asterisk 13.9.0 ------------
1542 ------------------------------------------------------------------------------
1543
1544 res_parking:
1545  - The dynamic parking lot creation channel variables PARKINGDYNAMIC,
1546    PARKINGDYNCONTEXT, PARKINGDYNEXTEN, and PARKINGDYNPOS are now looked
1547    for in the parker's channel instead of the parked channel.  This is only
1548    of significance if the parker uses blind transfer or the DTMF one-step
1549    parking feature.  You need to use the double underscore '__' inheritance
1550    for these variables.  The indefinite inheritance is also recommended
1551    for the PARKINGEXTEN variable.
1552
1553 res_pjsip
1554 ------------------
1555  * Added new global option (disable_multi_domain) to pjsip.
1556    Disabling Multi Domain can improve realtime performace by reducing
1557    number of database requsts.
1558
1559 chan_pjsip
1560 ------------------
1561  * Added 'pjsip show channelstats' CLI command.
1562
1563 res_pjsip_outbound_publish
1564 ------------------
1565  * Added support for setting the transport used on outbound publish
1566    using the transport configuration option.
1567
1568 ------------------------------------------------------------------------------
1569 --- Functionality changes from Asterisk 13.7.0 to Asterisk 13.8.0 ------------
1570 ------------------------------------------------------------------------------
1571
1572 res_pjsip_caller_id
1573 ------------------
1574  * Per RFC3325, the 'From' header is now anonymized on outgoing calls when
1575    caller id presentation is prohibited.
1576
1577 res_pjsip_config_wizard
1578 ------------------
1579  * A new command (pjsip export config_wizard primitives) has been added that
1580    will export all the pjsip objects it created to the console or a file
1581    suitable for reuse in a pjsip.conf file.
1582
1583 Build System
1584 ------------------
1585  * To help insure that Asterisk is compiled and run with the same known
1586    version of pjproject, a new option (--with-pjproject-bundled) has been
1587    added to ./configure.  When specified, the version of pjproject specified
1588    in third-party/versions.mak will be downloaded and configured.  When you
1589    make Asterisk, the build process will also automatically build pjproject
1590    and Asterisk will be statically linked to it.  Once a particular version
1591    of pjproject is configured and built, it won't be configured or built
1592    again unless you run a 'make distclean'.
1593
1594    To facilitate testing, when 'make install' is run, the pjsua and pjsystest
1595    utilities and the pjproject python bindings will be installed in
1596    ASTDATADIR/third-party/pjproject.
1597
1598    The default behavior remains building with the shared pjproject
1599    installation, if any.
1600
1601 app_confbridge
1602 ------------------
1603  * Added CONFBRIDGE_INFO(muted,) for querying the muted conference state.
1604
1605  * Added Muted header to AMI ConfbridgeListRooms action response list events
1606    to indicate the muted conference state.
1607
1608  * Added Muted column to CLI "confbridge list" output to indicate the muted
1609    conference state and made the locked column a yes/no value instead of a
1610    locked/unlocked value.
1611
1612 REDIRECTING(reason)
1613 ------------------
1614  * The REDIRECTING(reason) value is now treated consistently between
1615    chan_sip and chan_pjsip.
1616
1617    Both channel drivers match incoming reason values with values documented
1618    by REDIRECTING(reason) and values documented by RFC5806 regardless of
1619    whether they are quoted or not.  RFC5806 values are mapped to the
1620    equivalent REDIRECTING(reason) documented value and is set in
1621    REDIRECTING(reason).  e.g., an incoming RFC5806 'unconditional' value or a
1622    quoted string version ('"unconditional"') is converted to
1623    REDIRECTING(reason)'s 'cfu' value.  The user's dialplan only needs to deal
1624    with 'cfu' instead of any of the aliases.
1625
1626    The incoming 480 response reason text supported by chan_sip checks for
1627    known reason values and if not matched then puts quotes around the reason
1628    string and assigns that to REDIRECTING(reason).
1629
1630    Both channel drivers send outgoing known REDIRECTING(reason) values as the
1631    unquoted RFC5806 equivalent.  User custom values are either sent as is or
1632    with added quotes if SIP doesn't allow a character within the value as
1633    part of a RFC3261 Section 25.1 token.  Note that there are still
1634    limitations on what characters can be put in a custom user value.  e.g.,
1635    embedding quotes in the middle of the reason string is just going to cause
1636    you grief.
1637
1638  * Setting a REDIRECTING(reason) value now recognizes RFC5806 aliases.
1639    e.g., Setting REDIRECTING(reason) to 'unconditional' is converted to the
1640    'cfu' value.
1641
1642 res_pjproject
1643 ------------------
1644  * This module is the successor of res_pjsip_log_forwarder.  As well as
1645    handling the log forwarding (which now displays as 'pjproject:0' instead
1646    of 'pjsip:0'), it also adds a 'pjproject show buildopts' command to the CLI.
1647    This displays the compiled-in options of the pjproject installation
1648    Asterisk is currently running against.
1649
1650  * Another feature of this module is the ability to map pjproject log levels
1651    to Asterisk log levels, or to suppress the pjproject log messages
1652    altogether.  Many of the messages emitted by pjproject itself are the result
1653    of errors which Asterisk will ultimately handle so the messages can be
1654    misleading or just noise.  A new config file (pjproject.conf) has been added
1655    to configure the mapping and a new CLI command (pjproject show log mappings)
1656    has been added to display the mappings currently in use.
1657
1658 res_pjsip
1659 ------------------
1660  * Transports are now reloadable.  In testing, no in-progress calls were
1661    disrupted if the ip address or port weren't changed, but the possibility
1662    still exists.  To make sure there are no unintentional drops, a new option
1663    'allow_reload', which defaults to 'no' has been added to transport.  If
1664    left at the default, changes to the particular transport will be ignored.
1665    If set to 'yes', changes (if any) will be applied.
1666
1667  * Added new global option (regcontext) to pjsip. When set, Asterisk will
1668    dynamically create and destroy a NoOp priority 1 extension
1669    for a given endpoint who registers or unregisters with us.
1670
1671  * Endpoints and aors can now be identified by the username and realm in an
1672    incoming Authorization header.  To use this feature, add "auth_username"
1673    to your endpoint's "identify_by" list.  You can combine "auth_username"
1674    and the original "username" to test both the From/To and Authorization
1675    headers.  For endpoints, the order is controlled by the global
1676    "endpoint_identifier_order" setting.  For matching aors to an endpoint
1677    for inbound registration, the order is controlled by this option.
1678
1679  * In conjunction with the "auth_username" change, 3 new options have been
1680    added to the global configuration object that control how many unidentified
1681    requests over a certain period from the same IP address can be received
1682    before a security altert is generated.  A new CLI command
1683    "pjsip show unidentified_requests" will list the current candidates.
1684
1685 res_pjsip_history
1686 ------------------
1687  * A new module, res_pjsip_history, has been added that provides SIP history
1688    viewing/filtering from the CLI. The module is intended to be used on systems
1689    with busy SIP traffic, where existing forms of viewing SIP messages - such
1690    as the res_pjsip_logger - may be inadequate. The module provides two new
1691    CLI commands:
1692    - 'pjsip set history {on|off|clear}' - this enables/disables SIP history
1693      capturing, as well as clears an existing history capture. Note that SIP
1694      packets captured are stored in memory until cleared. As a result, the
1695      history capture should only be used for debugging/viewing purposes, and
1696      should *NOT* be left permanently enabled on a system.
1697    - 'pjsip show history' - displays the captured SIP history. When invoked
1698      with no options, the entire captured history is displayed. Two options
1699      are available:
1700      -- 'entry <num>' - display a detailed view of a single SIP message in
1701         the history
1702      -- 'where ...' - filter the history based on some expression. For more
1703         information on filtering, view the current CLI help for the
1704         'pjsip show history' command.
1705
1706 Voicemail
1707 ------------------
1708  * app_voicemail and res_mwi_external can now be built together.  The default
1709    remains to build app_voicemail and not res_mwi_external but if they are
1710    both built, the load order will cause res_mwi_external to load first and
1711    app_voicemail will be skipped.  Use 'preload=app_voicemail.so' in
1712    modules.conf to force app_voicemail to be the voicemail provider.
1713
1714 res_pjsip_sdp_rtp
1715 ------------------
1716  * A new option (bind_rtp_to_media_address) has been added to endpoint which
1717    will cause res_pjsip_sdp_rtp to actually bind the RTP instance to the
1718    media_address as well as using it in the SDP.  If set, RTP packets will now
1719    originate from the media address instead of the operating system's "primary"
1720    ip address.
1721
1722 res_rtp_asterisk
1723 ------------------
1724  * A new configuration section - ice_host_candidates - has been added to
1725    rtp.conf, allowing automatically discovered ICE host candidates to be
1726    overriden. This allows an Asterisk server behind a 1:1 NAT to send its
1727    external IP as a host candidate rather than relying on STUN to discover it.
1728
1729 ------------------------------------------------------------------------------
1730 --- Functionality changes from Asterisk 13.6.0 to Asterisk 13.7.0 ------------
1731 ------------------------------------------------------------------------------
1732
1733 Codecs
1734 ------------------
1735  * Added format attribute negotiation for the VP8 video codec. Format attribute
1736    negotiation is provided by the res_format_attr_vp8 module.
1737
1738 ConfBridge
1739 ------------------
1740  * A new "timeout" user profile option has been added. This configures the number
1741    of seconds that a participant may stay in the ConfBridge after joining. When
1742    the time expires, the user is ejected from the conference and CONFBRIDGE_RESULT
1743    is set to "TIMEOUT" on the channel.
1744
1745 chan_sip
1746 ------------------
1747  * The websockets_enabled option has been added to the general section of
1748    sip.conf.  The option is enabled by default to match the previous behavior.
1749    The option should be disabled when using res_pjsip_transport_websockets to
1750    ensure chan_sip will not conflict with PJSIP websockets.
1751
1752 Dialplan Functions
1753 ------------------
1754  * The HOLD_INTERCEPT dialplan function now actually exists in the source tree.
1755    While support for the events was added in Asterisk 13.4.0, the function
1756    accidentally never made it in. That function is now present, and will cause
1757    the 'hold' raised by a channel to be intercepted and converted into an
1758    event instead.
1759
1760 res_pjsip_outbound_registration
1761 -------------------------------
1762  * If res_statsd is loaded and a StatsD server is configured, basic statistics
1763    regarding the state of outbound registrations will now be emitted. This
1764    includes:
1765    - A GAUGE statistic for the overall number of outbound registrations, i.e.:
1766        PJSIP.registrations.count
1767    - A GAUGE statistic for the overall number of outbound registrations in a
1768      particular state, e.g.:
1769        PJSIP.registrations.state.Registered
1770
1771 res_pjsip
1772 ------------------
1773  * The ability to use "like" has been added to the pjsip list and show
1774    CLI commands.  For instance: CLI> pjsip list endpoints like abc
1775
1776  * If res_statsd is loaded and a StatsD server is configured, basic statistics
1777    regarding the state of PJSIP contacts will now be emitted. This includes:
1778    - A GAUGE statistic for the overall number of contacts in a particular
1779      state, e.g.:
1780        PJSIP.contacts.states.Reachable
1781    - A TIMER statistic for the RTT time for each qualified contact, e.g.:
1782        PJSIP.contacts.alice@@127.0.0.1:5061.rtt
1783
1784 res_sorcery_memory_cache
1785 ------------------------
1786  * A new caching strategy, full_backend_cache, has been added which caches
1787    all stored objects in the backend. When enabled all objects will be
1788    expired or go stale according to the configuration. As well when enabled
1789    all retrieval operations will be performed against the cache instead of
1790    the backend.
1791
1792 func_callerid
1793 -------------------
1794  * CALLERID(pres) is now documented as a valid alternative to setting both
1795    CALLERID(name-pres) and CALLERID(num-pres) at once.  Some channel drivers,
1796    like chan_sip, don't make a distinction between the two: they take the
1797    least public value from name-pres and num-pres.  By using CALLERID(pres)
1798    for reading and writing, you touch the same combined value in the dialplan.
1799    The same applies to CONNECTEDLINE(pres), REDIRECTING(orig-pres),
1800    REDIRECTING(to-pres) and REDIRECTING(from-pres).
1801
1802 res_endpoint_stats
1803 -------------------
1804  * A new module that emits StatsD statistics regarding Asterisk endpoints.
1805    This includes a total count of the number of endpoints, the count of the
1806    number of endpoints in the technology agnostic state of the endpoint -
1807    online or offline - as well as the number of channels associated with each
1808    endpoint. These are recorded as three different GAUGE statistics:
1809     - endpoints.count
1810     - endpoints.state.{unknown|offline|online}
1811     - endpoints.{tech}.{resource}.channels
1812
1813
1814 ------------------------------------------------------------------------------
1815 --- Functionality changes from Asterisk 13.5.0 to Asterisk 13.6.0 ------------
1816 ------------------------------------------------------------------------------
1817
1818 Dialplan Functions
1819 ------------------
1820  * The CHANNEL function, when used on a PJSIP channel, now exposes a 'call-id'
1821    extraction option when using with the 'pjsip' signalling option. It will
1822    return the SIP Call-ID associated with the INVITE request that established
1823    the PJSIP channel.
1824
1825 ARI
1826 ------------------
1827  * Two new endpoint related events are now available: PeerStatusChange and
1828    ContactStatusChange. In particular, these events are useful when subscribing
1829    to all event sources, as they provide additional endpoint related
1830    information beyond the addition/removal of channels from an endpoint.
1831
1832  * Added the ability to subscribe to all ARI events in Asterisk, regardless
1833    of whether the application 'controls' the resource. This is useful for
1834    scenarios where an ARI application merely wants to observe the system,
1835    as opposed to control it. There are two ways to accomplish this:
1836    (1) Via the WebSocket connection URI. A new query paramter, 'subscribeAll',
1837        has been added that, when present and True, will subscribe all
1838        specified applications to all ARI event sources in Asterisk.
1839    (2) Via the applications resource. An ARI client can, at any time, subscribe
1840        to all resources in an event source merely by not providing an explicit
1841        resource. For example, subscribing to an event source of 'channels:'
1842        as opposed to 'channels:12345' will subscribe the application to all
1843        channels.
1844
1845 ------------------------------------------------------------------------------
1846 --- Functionality changes from Asterisk 13.4.0 to Asterisk 13.5.0 ------------
1847 ------------------------------------------------------------------------------
1848
1849 AMI
1850 ------------------
1851  * A new ContactStatus event has been added that reflects res_pjsip contact
1852    lifecycle changes:  Created, Removed, Reachable, Unreachable, Unknown.
1853
1854  * Added the Linkedid header to the common channel headers listed for each
1855    channel in AMI events.
1856
1857 ARI
1858 ------------------
1859  * A new feature has been added that enables the retrieval of modules and
1860    module information through an HTTP request. Information on a single module
1861    can be also be retrieved. Individual modules can be loaded to Asterisk, as
1862    well as unloaded and reloaded.
1863
1864 * A new resource has been added to the 'asterisk' resource, 'config/dynamic'.
1865    This resource allows for push configuration of sorcery derived objects
1866    within Asterisk. The resource supports creation, retrieval, updating, and
1867    deletion. Sorcery derived objects that are manipulated by this resource
1868    must have a sorcery wizard that supports the desired operations.
1869
1870  * A new feature has been added that allows for the rotation of log channels
1871    through HTTP requests.
1872
1873
1874 res_pjsip
1875 ------------------
1876 * A new 'g726_non_standard' endpoint option has been added that, when set to
1877   'yes' and g.726 audio is negotiated, forces the codec to be treated as if it
1878   is AAL2 packed on the channel.
1879
1880 * A new 'rtp_keepalive' endpoint option has been added. This option specifies
1881   an interval, in seconds, at which we will send RTP comfort noise packets to
1882   the endpoint. This functions identically to chan_sip's "rtpkeepalive" option.
1883
1884 * New 'rtp_timeout' and 'rtp_timeout_hold' endpoint options have been added.
1885   These options specify the amount of time, in seconds, that Asterisk will wait
1886   before terminating the call due to lack of received RTP. These are identical
1887   to chan_sip's rtptimeout and rtpholdtimeout options.
1888
1889 ------------------------------------------------------------------------------
1890 --- Functionality changes from Asterisk 13.3.0 to Asterisk 13.4.0 ------------
1891 ------------------------------------------------------------------------------
1892
1893 chan_pjsip
1894 ------------------
1895  * New 'rpid_immediate' option to control if connected line update information
1896    goes to the caller immediately or waits for another reason to send the
1897    connected line information update.  See the online option documentation for
1898    more information.  Defaults to 'no' as setting it to 'yes' can result in
1899    many unnecessary messages being sent to the caller.
1900
1901  * The configuration setting 'progressinband' now defaults to 'no', which
1902    matches the actual behavior of previous versions.
1903
1904 res_pjsip
1905 ------------------
1906  * A new CLI command has been added: "pjsip show settings", which shows
1907    both the global and system configuration settings.
1908
1909  * A new aor option has been added: "qualify_timeout", which sets the timeout
1910    in seconds for a qualify.  The default is 3 seconds.  This overrides the
1911    hard coded 32 seconds in pjproject.
1912
1913  * Endpoint status will now change to "Unreachable" when all contacts are
1914    unavailable.  When any contact becomes available, the endpoint will status
1915    will change back to "Reachable".
1916
1917  * A new global option has been added: "max_initial_qualify_time", which
1918    sets the maximum amount of time from startup that qualifies should be
1919    attempted on all contacts.
1920
1921 res_ari_channels
1922 ------------------
1923  * Two new events, 'ChannelHold' and 'ChannelUnhold', have been added to the
1924    events data model. These events are raised when a channel indicates a hold
1925    or unhold, respectively.
1926
1927 func_holdintercept
1928 ------------------
1929  * A new dialplan function, HOLD_INTERCEPT, has been added. This function, when
1930    placed on a channel, intercepts hold/unhold indications signalled by the
1931    channel and prevents them from moving on to other channels in a bridge with
1932    the hold initiator. Instead, AMI or ARI events are raised indicating that
1933    the channel wanted to place someone on hold. This allows external
1934    applications to implement their own custom hold/unhold logic.
1935
1936 ------------------------------------------------------------------------------
1937 --- Functionality changes from Asterisk 13.2.0 to Asterisk 13.3.0 ------------
1938 ------------------------------------------------------------------------------
1939
1940 chan_pjsip/app_transfer
1941 ------------------
1942  * The Transfer application, when used with chan_pjsip, now supports using
1943    a PJSIP endpoint as the transfer destination. This is in addition to
1944    explicitly specifying a SIP URI to transfer to.
1945
1946 res_ari_channels
1947 ------------------
1948  * The ARI /channels resource now supports a new operation, 'redirect'. The
1949    redirect operation will perform a technology and state specific redirection
1950    on the channel to a specified endpoint or destination. In the case of SIP
1951    technologies, this is either a 302 Redirect response to an on-going INVITE
1952    dialog or a SIP REFER request.
1953
1954 res_pjsip
1955 ------------------
1956  * A new 'endpoint_identifier_order' option has been added that allows one to
1957    set the order by which endpoint identifiers are processed and checked. This
1958    option is specified under the 'global' type configuration section.
1959
1960 ------------------------------------------------------------------------------
1961 --- Functionality changes from Asterisk 13.1.0 to Asterisk 13.2.0 ------------
1962 ------------------------------------------------------------------------------
1963
1964  * New 'PJSIP_AOR' and 'PJSIP_CONTACT' dialplan functions have been added which
1965    allow examining PJSIP AORs or contacts from the dialplan.
1966
1967 res_pjsip_outbound_registration
1968 ------------------
1969  * The 'pjsip send unregister' command now stops further registrations.
1970
1971  * A new command 'pjsip send register' has been added which allows you to
1972    start or restart periodic registration.  It can be used after a
1973    'send unregister' or after a 401 permanent error.
1974
1975 res_pjsip_config_wizard
1976 ------------------
1977  * This is a new module that adds streamlined configuration capability for
1978    chan_pjsip.  It's targeted at users who have lots of basic configuration
1979    scenarios like 'phone' or 'agent' or 'trunk'.  Additional information
1980    can be found in the sample configuration file at
1981    config/samples/pjsip_wizard.conf.sample.
1982
1983 res_fax
1984 -----------
1985  * The T.38 negotiation timeout was previously hard coded at 5000 milliseconds
1986    and is now configurable via the 't38timeout' configuration option in
1987    res_fax.conf and via the fax options dialplan function 'FAXOPT(t38timeout)'.
1988    The default remains at 5000 milliseconds.
1989
1990 PJSIP Transports
1991 ----------
1992  * The ca_list_path transport parameter has been added for TLS transports. This
1993    option behaves similarly to the old sip.conf option "tlscapath". In order to
1994    use this, you must be using PJProject version 2.4 or higher.
1995
1996 ARI
1997 ------------------
1998  * The Originate operation now takes in an originator channel. The linked ID of
1999    this originator channel is applied to the newly originated outgoing channel.
2000    If using CEL this allows an association to be established between the two so
2001    it can be recognized that the originator is dialing the originated channel.
2002
2003  * "language" (the default spoken language for the channel) is now included in
2004    the standard channel state output for suitable events.
2005
2006  * The POST channels/{id} operation and the POST channels/{id}/continue operation
2007    now have a new "label" parameter. This allows for origination or continuation
2008    to a labeled priority in the dialplan instead of requiring a specific priority
2009    number. The ARI version has been bumped to 1.7.0 as a result.
2010
2011 AMI
2012 ------------------
2013  * "Language" (the default spoken language for the channel) is now included in
2014    the standard channel state output for suitable events.
2015
2016  * AMI actions that return a list of events have been made to return consistent
2017    headers for the action response event starting the list and the list complete
2018    event.  The AMI version has been bumped to 2.7.0 as a result.
2019
2020 ------------------------------------------------------------------------------
2021 --- Functionality changes from Asterisk 13.0.0 to Asterisk 13.1.0 ------------
2022 ------------------------------------------------------------------------------
2023
2024 AMI
2025 ------------------
2026  * Event NewConnectedLine is emitted when the connected line information on
2027    a channel changes.
2028
2029 ARI
2030 ------------------
2031  * Event ChannelConnectedLine is emitted when the connected line information
2032    on a channel changes.
2033
2034 Core Transfers
2035 -----------------
2036
2037 The features.conf general section has three new configurable options:
2038     * transferdialattempts
2039     * transferretrysound
2040     * transferinvalidsound
2041 For more information on what these options do, see the Asterisk wiki:
2042  https://wiki.asterisk.org/wiki/x/W4fAAQ
2043
2044 Channel Drivers
2045 ------------------
2046
2047 chan_pjsip
2048 ------------------
2049  * New 'media_encryption_optimistic' endpoint setting. This will use SRTP
2050    when possible but does not consider lack of it a failure.
2051
2052 res_pjsip_endpoint_identifer_ip
2053 ------------------
2054  * New CLI commands have been added: "pjsip show identif(y|ies)", which lists
2055    all configured PJSIP identify objects
2056
2057 ------------------------------------------------------------------------------
2058 --- Functionality changes from Asterisk 12 to Asterisk 13 --------------------
2059 ------------------------------------------------------------------------------
2060
2061 Overview
2062 ------------------
2063
2064 Asterisk 13 is the next Long Term Support (LTS) release of Asterisk. As such,
2065 the focus of development for this release of Asterisk was on improving the
2066 usability and features developed in the previous Standard release, Asterisk 12.
2067 Beyond a general refinement of end user features, development focussed heavily
2068 on the Asterisk APIs - the Asterisk Manager Interface (AMI) and the Asterisk
2069 REST Interface (ARI) - and the PJSIP stack in Asterisk. Some highlights of the
2070 new features include:
2071
2072 * Asterisk security events are now provided via AMI, allowing end users to
2073   monitor their Asterisk system in real time for security related issues.
2074 * External control of Message Waiting Indicators (MWI) through both AMI and ARI.
2075 * Reception/transmission of out of call text messages using any supported
2076   channel driver/protocol stack through ARI.
2077 * Resource List Server support in the PJSIP stack, providing subscriptions to
2078   lists of resources and batched delivery of NOTIFY requests.
2079 * Inter-Asterisk distributed device state and mailbox state using the PJSIP
2080   stack.
2081
2082 It is important to note that Asterisk 13 is built on the architecture developed
2083 during the previous Standard release, Asterisk 12. Users upgrading to
2084 Asterisk 13 should read about the new features in Asterisk 12 later in this file
2085 (see Functionality changes from Asterisk 11 to Asterisk 12), as well as the
2086 UPGRADE-12.txt delivered with this release. In particular, users upgrading to
2087 Asterisk 13 from a release prior to Asterisk 12 should read the specifications
2088 on AMI, CDRs, and CEL on the Asterisk wiki:
2089  * AMI - https://wiki.asterisk.org/wiki/x/dAFRAQ
2090  * CEL - https://wiki.asterisk.org/wiki/x/4ICLAQ
2091  * CDRs - https://wiki.asterisk.org/wiki/x/pwpRAQ
2092
2093 Many new featuers in Asterisk 13 were introduced in point releases of
2094 Asterisk 12. Following this section - which documents the changes from all
2095 versions of Asterisk 12 to Asterisk 13 - users should examine the new features
2096 that were introduced in the point releases of Asterisk 12, as they are also
2097 included in Asterisk 13.
2098
2099 Finally, all users upgrading to Asterisk 13 should read the UPGRADE.txt file
2100 delivered with this release.
2101
2102
2103 Build System
2104 ------------------
2105  * Sample config files have been moved from configs/ to a sub-folder of that
2106    directory, samples.
2107
2108  * The menuselect utility has been pulled into the Asterisk repository. As a
2109    result, the libxml2 development library is now a required dependency for
2110    Asterisk.
2111
2112  * A new Compiler Flag, REF_DEBUG, has been added. When enabled, reference
2113    counted objects will emit additional debug information to the refs log file
2114    located in the standard Asterisk log file directory. This log file is useful
2115    in tracking down object leaks and other reference counting issues. Prior to
2116    this version, this option was only available by modifying the source code
2117    directly. This change also includes a new script, refcounter.py, in the
2118    contrib folder that will process the refs log file. Note that this replaces
2119    the refcounter utility that could be built from the utils directory.
2120
2121
2122 Applications
2123 ------------------
2124
2125 DahdiBarge
2126 ------------------
2127  * This module was deprecated and has been removed. Users of app_dahdibarge
2128    should use ChanSpy instead.
2129
2130 MixMonitor
2131 ------------------
2132  * New options to play a beep when starting a recording and stopping a recording
2133    have been added.  The option "p" will play a beep to the channel that starts
2134    the recording.  The option "P" will play a beep to the channel that stops the
2135    recording.
2136
2137 Queue
2138 ------------------
2139  * Queue rules can now be stored in a database table, queue_rules. Unlike other
2140    RealTime tables, the queue_rules table is only examined on module load or
2141    module reload. A new general setting has been added to queuerules.conf,
2142    'realtime_rules', which, when set to 'yes', will cause app_queue to look in
2143    RealTime for additional queue rules to parse. Note that both the file and
2144    the database can be used as a provide of queue rules when 'realtime_rules'
2145    is set to 'yes'.
2146
2147    When app_queue is reloaded, all rules are re-parsed and loaded into memory.
2148    There is no caching of RealTime queue rules.
2149
2150 ReadFile
2151 ------------------
2152  * This module was deprecated and has been removed. Users of app_readfile
2153    should use func_env's FILE function instead.
2154
2155 Say
2156 ------------------
2157  * The 'say' family of dialplan applications now support the Japanese
2158    language. The 'language' parameter in say.conf now recognizes a setting of
2159    'ja', which will enable Japanese language specific mechanisms for playing
2160    back numbers, dates, and other items.
2161  * Counting, enumeration and dates now supports Icelandic grammar with the
2162    'language' parameter set to 'is'.
2163
2164 SayCountPL
2165 ------------------
2166  * This module was deprecated and has been removed. Users of app_saycountpl
2167    should use the Say family of applications.
2168
2169 SetMusicOnHold
2170 ------------------
2171  * The SetMusicOnHold dialplan application was deprecated and has been removed.
2172    Users of the application should use the CHANNEL function's musicclass
2173    setting instead.
2174
2175 WaitMusicOnHold
2176 ------------------
2177  * The WaitMusicOnHold dialplan application was deprecated and has been
2178    removed. Users of the application should use MusicOnHold with a duration
2179    parameter instead.
2180
2181 VoiceMail
2182 ------------------
2183  * VoiceMail and VoiceMailMain now support the Japanese language. The
2184    'language' parameter in voicemail.conf now recognizes a setting of 'ja',
2185    which will enable prompts to be played back using a Japanese grammatical
2186    structure. Additional prompts are necessary for this functionality,
2187    including:
2188    - jb-arimasu: there is
2189    - jb-arimasen: there is not
2190    - jb-oshitekudasai: please press
2191    - jb-ni: article ni
2192    - jb-ga: article ga
2193    - jb-wa: article wa
2194    - jb-wo: article wo
2195
2196  * Add the ability to specify multiple email addresses in configuration,
2197    separated by a |.
2198
2199
2200 CDR Backends
2201 ------------------
2202
2203 cdr_sqlite
2204 -----------------
2205  * This module was deprecated and has been removed. Users of cdr_sqlite
2206    should use cdr_sqlite3_custom.
2207
2208 cdr_pgsql
2209 ------------------
2210  * Added the ability to support PostgreSQL application_name on connections.
2211    This allows PostgreSQL to display the configured name in the
2212    pg_stat_activity view and CSV log entries. This setting is configurable
2213    for cdr_pgsql via the appname configuration setting in cdr_pgsql.conf.
2214
2215
2216 CEL Backends
2217 ------------------
2218
2219 cel_pgsql
2220 ------------------
2221  * Added the ability to support PostgreSQL application_name on connections.
2222    This allows PostgreSQL to display the configured name in the
2223    pg_stat_activity view and CSV log entries. This setting is configurable
2224    for cel_pgsql via the appname configuration setting in cel_pgsql.conf.
2225
2226
2227 Channel Drivers
2228 ------------------
2229
2230 chan_dahdi
2231 ------------------
2232  * SS7 support now requires libss7 v2.0 or later.
2233
2234  * Added SS7 support for connected line and redirecting.
2235
2236  * Most SS7 CLI commands are reworked as well as new SS7 commands added.
2237    See online CLI help.
2238
2239  * Added several SS7 config option parameters described in
2240    chan_dahdi.conf.sample.
2241
2242 chan_gtalk
2243 ------------------
2244  * This module was deprecated and has been removed. Users of chan_gtalk
2245    should use chan_motif.
2246
2247 chan_h323
2248 ------------------
2249  * This module was deprecated and has been removed. Users of chan_h323
2250    should use chan_ooh323.
2251
2252 chan_jingle
2253 ------------------
2254  * This module was deprecated and has been removed. Users of chan_jingle
2255    should use chan_motif.
2256
2257 chan_pjsip
2258 ------------------
2259  * Added the CLI command 'pjsip list ciphers' so a user can know what
2260    OpenSSL names are available on their system for the pjsip.conf cipher
2261    option.
2262
2263 chan_sip
2264 ------------------
2265  * The SIPPEER dialplan function no longer supports using a colon as a
2266    delimiter for parameters. The parameters for the function should be
2267    delimited using a comma.
2268
2269  * The SIPCHANINFO dialplan function was deprecated and has been removed. Users
2270    of the function should use the CHANNEL function instead.
2271
2272
2273 Core
2274 ------------------
2275
2276 Account Codes
2277 ------------------
2278  * Added functional peeraccount support.  Except for Queue, the
2279    accountcode propagation is now consistently propagated to outgoing
2280    channels before dialing.  The channel accountcode can change from its
2281    original non-empty value on channel creation for the following specific
2282    reasons.  One, dialplan sets it using CHANNEL(accountcode).  Two, an
2283    originate method that can specify an accountcode value.  Three, the
2284    calling channel propagates its peeraccount or accountcode to the
2285    outgoing channel's accountcode before dialing.  The change has two
2286    visible effects.  One, local channels now cross accountcode and
2287    peeraccount across the special bridge between the ;1 and ;2 channels
2288    just like channels between normal bridges.  Two, the
2289    CHANNEL(peeraccount) value can now be set before Dial and FollowMe to
2290    set the accountcode on the outgoing channel(s).
2291
2292    For Queue, an outgoing channel's non-empty accountcode will not change
2293    unless explicitly set by CHANNEL(accountcode).  The change has three
2294    visible effects.  One, local channels now cross accountcode and
2295    peeraccount across the special bridge between the ;1 and ;2 channels
2296    just like channels between normal bridges.  Two, the queue member will
2297    get an accountcode if it doesn't have one and one is available from the
2298    calling channel's peeraccount.  Three, accountcode propagation includes
2299    local channel members where the accountcodes are propagated early
2300    enough to be available on the ;2 channel.
2301
2302 AMI
2303 ------------------
2304  * New DeviceStateChanged and PresenceStateChanged AMI events have been added.
2305    These events are emitted whenever a device state or presence state change
2306    occurs. The events are controlled by res_manager_device_state.so and
2307    res_manager_presence_state.so. If the high frequency of these events is
2308    problematic for you, do not load these modules.
2309
2310  * Added DialplanExtensionAdd and DialplanExtensionRemove AMI commands. They
2311    work in basically the same way as the 'dialplan add extension' and
2312    'dialplan remove extension' CLI commands respectively.
2313
2314  * New AMI action LoggerRotate reloads and rotates logger in the same manner
2315    as CLI command 'logger rotate'
2316
2317  * New AMI Actions FAXSessions, FAXSession, and FAXStats replicate the
2318    functionality of CLI commands 'fax show sessions', 'fax show session',
2319    and fax show stats' respectively.
2320
2321  * New AMI actions PRIDebugSet, PRIDebugFileSet, and PRIDebugFileUnset
2322    enable manager control over PRI debugging levels and file output.
2323
2324  * AMI action PJSIPNotify may now send to a URI instead of only to a PJSIP
2325    endpoint as long as a default outbound endpoint is set. This also applies
2326    to the equivalent CLI command (pjsip send notify)
2327
2328  * The AMI action PJSIPShowEndpoint now includes ContactStatusDetail sections
2329    that give information on Asterisk's attempts to qualify the endpoint.
2330
2331  * The DialEnd event will now contain a Forward header if the dial is ending
2332    due to the call being forwarded. The contents of the Forward header is the
2333    extension in the number to which the call is being forwarded.
2334
2335 CEL
2336 ------------------
2337  * The "bridge_technology" extra field key has been added to BRIDGE_ENTER
2338    and BRIDGE_EXIT events.
2339
2340 Features
2341 ------------------
2342  * Channel variables are now substituted in arguments passed to applications
2343    run by using dynamic features.
2344
2345 TLS
2346 ------------------
2347  * The TLS core in Asterisk now supports Perfect Forward Secrecy (PFS).
2348    Enabling PFS is attempted by default, and is dependent on the configuration
2349    of the module using TLS.
2350    - Ephemeral ECDH (ECDHE) is enabled by default. To disable it, do not
2351      specify a ECDHE cipher suite in sip.conf, for example:
2352        tlscipher=AES128-SHA:DES-CBC3-SHA
2353    - Ephemeral DH (DHE) is disabled by default. To enable it, add DH parameters
2354      into the private key file, e.g., sip.conf tlsprivatekey. For example, the
2355      default dh2048.pem - see
2356      http://www.opensource.apple.com/source/OpenSSL098/OpenSSL098-35.1/src/apps/dh2048.pem?txt
2357    - Because clients expect the server to prefer PFS, and because OpenSSL sorts
2358      its cipher suites by bit strength, see "openssl ciphers -v DEFAULT".
2359      Consider re-ordering your cipher suites in the respective configuration
2360      file. For example:
2361        tlscipher=AES128+kEECDH:AES128+kEDH:3DES+kEDH:AES128-SHA:DES-CBC3-SHA:-ADH:-AECDH
2362      will use PFS when offered by the client. Clients which do not offer PFS
2363      fall-back to AES-128 (or even 3DES, as recommended by RFC 3261).
2364
2365
2366 Functions
2367 ------------------
2368
2369 JACK_HOOK
2370 ------------------
2371  * The JACK_HOOK function now supports audio with a sample rate higher than
2372    8kHz.
2373
2374
2375 Resources
2376 ------------------
2377
2378 res_config_pgsql
2379 ------------------
2380  * Added the ability to support PostgreSQL application_name on connections.
2381    This allows PostgreSQL to display the configured name in the
2382    pg_stat_activity view and CSV log entries. This setting is configurable
2383    for res_config_pgsql via the dbappname configuration setting in
2384    res_pgsql.conf.
2385
2386 res_pjsip_outbound_publish
2387 ------------------
2388  * A new module, res_pjsip_outbound_publish provides the mechanisms for sending
2389    PUBLISH requests for specific event packages to another SIP User Agent.
2390
2391 res_pjsip_pubsub
2392 ------------------
2393  * The publish/subscribe core module has been updated to support RFC 4662
2394    Resource Lists, allowing Asterisk to act as a Resource List Server (RLS).
2395    Resource lists are configured in pjsip.conf under a new object type,
2396    resource_list. Resource lists can contain either message-summary or presence
2397    events, and can be composed of specific resources that provide the event or
2398    other resource lists.
2399
2400  * Inbound publication support is provided by a new object, inbound-publication.
2401    This configures res_pjsip_pubsub to accept PUBLISH requests from a particular
2402    resource. Which events are accepted is constructed dynamically; see
2403    res_pjsip_publish_asterisk for more information.
2404
2405 res_pjsip_publish_asterisk
2406 ------------------
2407  * A new module, res_pjsip_publish_asterisk adds support for PUBLISH requests of
2408    Asterisk information to other Asterisk servers. This module is intended only
2409    for Asterisk to Asterisk exchanges of information. Currently, this includes
2410    both mailbox state and device state information.
2411
2412 ------------------------------------------------------------------------------
2413 --- Functionality changes from Asterisk 12.4.0 to Asterisk 12.5.0 ------------
2414 ------------------------------------------------------------------------------
2415
2416 ARI
2417 ------------------
2418  * Stored recordings now support a new operation, copy. This will take an
2419    existing stored recording and copy it to a new location in the recordings
2420    directory.
2421
2422  * LiveRecording objects now have three additional fields that can be reported
2423    in a RecordingFinished ARI event:
2424    - total_duration: the duration of the recording
2425    - talking_duration: optional. The duration of talking detected in the
2426      recording. This is only available if max_silence_seconds was specified
2427      when the recording was started.
2428    - silence_duration: optional. The duration of silence detected in the
2429      recording. This is only available if max_silence_seconds was specified
2430      when the recording was started.
2431    Note that all duration values are reported in seconds.
2432
2433  * Users of ARI can now send and receive out of call text messages. Messages
2434    can be sent directly to a particular endpoint, or can be sent to the
2435    endpoints resource directly and inferred from the URI scheme. Text
2436    messages are passed to ARI clients as TextMessageReceived events. ARI
2437    clients can choose to receive text messages by subscribing to the particular
2438    endpoint technology or endpoints that they are interested in.
2439
2440  * The applications resource now supports subscriptions to all endpoints of
2441    a particular channel technology. For example, subscribing to an eventSource
2442    of 'endpoint:PJSIP' will subscribe to all PJSIP endpoints.
2443
2444 res_pjsip
2445 ------------------
2446  * The endpoint configuration object now supports 'accountcode'. Any channel
2447    created for an endpoint with this setting will have its accountcode set
2448    to the specified value.
2449
2450 res_hep_rtcp
2451 ------------------
2452  * A new module, res_hep_rtcp, has been added that will forward RTCP call
2453    statistics to a HEP capture server. See res_hep for more information.
2454
2455 Functions
2456 ------------------
2457  * Function AUDIOHOOK_INHERIT has been deprecated. Audiohooks are now
2458    unconditionally inhereted through masquerades. As a side benefit, more
2459    than one audiohook of a given type may persist through a masquerade now.
2460
2461 ------------------------------------------------------------------------------
2462 --- Functionality changes from Asterisk 12.3.0 to Asterisk 12.4.0 ------------
2463 ------------------------------------------------------------------------------
2464
2465 AgentRequest
2466 ------------------
2467  * Returns new AGENT_STATUS value "NOT_CONNECTED" if the agent fails to
2468    connect with an incoming caller after being alerted to the presence
2469    of the incoming caller.  The most likely reason this would happen is
2470    the agent did not acknowledge the call in time.
2471
2472 AMI
2473 ------------------
2474  * New events have been added for the TALK_DETECT function. When the function
2475    is used on a channel, ChannelTalkingStart/ChannelTalkingStop events will be
2476    emitted to connected AMI clients indicating the start/stop of talking on
2477    the channel.
2478
2479 ARI
2480 ------------------
2481  * New event models have been aded for the TALK_DETECT function. When the
2482    function is used on a channel, ChannelTalkingStarted/ChannelTalkingFinished
2483    events will be emitted to connected WebSockets subscribed to the channel,
2484    indicating the start/stop of talking on the channel.
2485
2486 Functions
2487 ------------------
2488  * A new function, TALK_DETECT, has been added. When set on a channel, this
2489    fucntion causes events indicating the starting/stoping of talking on said
2490    channel to be emitted to both AMI and ARI clients.
2491
2492 ------------------------------------------------------------------------------
2493 --- Functionality changes from Asterisk 12.2.0 to Asterisk 12.3.0 ------------
2494 ------------------------------------------------------------------------------
2495
2496 ARI
2497 ------------------
2498  * A new Playback URI 'tone' has been added. Tones are specified either as
2499    an indication name (e.g. 'tone:busy') from indications.conf or as a tone
2500    pattern (e.g. 'tone:240/250,0/250'). Tones differ from normal playback
2501    URIs in that they must be stopped manually and will continue to occupy
2502    a channel's ARI control queue until they are stopped. They also can not
2503    be rewound or fastforwarded.
2504
2505  * User events can now be generated from ARI.  Events can be signalled with
2506    arbitrary json variables, and include one or more of channel, bridge, or
2507    endpoint snapshots.  An application must be specified which will receive
2508    the event message (other applications can subscribe to it).  The message
2509    will also be delivered via AMI provided a channel is attached.  Dialplan
2510    generated user event messages are still transmitted via the channel, and
2511    will only be received by a stasis application they are attached to or if
2512    the channel is subscribed to.
2513
2514 chan_sip
2515 -----------
2516  * SIP peers can now specify 'trust_id_outbound' which affects RPID/PAI
2517    fields for prohibited callingpres information. Values are legacy, no, and
2518    yes. By default, legacy is used.
2519    trust_id_outbound=legacy - behavior remains the same as 1.8.26.1. When
2520      dealing with prohibited callingpres and sendrpid=pai/rpid, RPID/PAI
2521      headers are appended to outbound SIP messages just as they are with
2522      allowed callingpres values, but data about the remote party's identity is
2523      anonymized.
2524      When sendrpid=rpid, only the remote party's domain is anonymized.
2525    trust_id_outbound=no - when dealing with prohibited callingpres, RPID/PAI
2526      headers are not sent.
2527    trust_id_outbound=yes - RPID/PAI headers are applied with the full remote
2528      party information in tact even for prohibited callingpres information.
2529      In the case of PAI, a Privacy: id header will be appended for prohibited
2530      calling information to communicate that the private information should
2531      not be relayed to untrusted parties.
2532
2533 res_parking
2534 ------------------
2535  * Manager action 'Park' now takes an additional argument 'AnnounceChannel'
2536    which can be used to announce the parked call's location to an arbitrary
2537    channel in a bridge. If 'Channel' and 'TimeoutChannel' are now the two
2538    parties in a one to one bridge, 'TimeoutChannel' is treated as having
2539    parked 'Channel' like with the Park Call DTMF feature and will receive
2540    announcements prior to being hung up.
2541
2542 ------------------------------------------------------------------------------
2543 --- Functionality changes from Asterisk 12.1.0 to Asterisk 12.2.0 ------------
2544 ------------------------------------------------------------------------------
2545
2546 Record
2547 ------------------
2548  * Record application now has an option 'o' which allows 0 to act as an exit
2549    key setting the RECORD_STATUS variable to 'OPERATOR' instead of 'DTMF'
2550
2551 ChanSpy
2552 --------------------------
2553  * ChanSpy now accepts a channel uniqueid or a fully specified channel name
2554    as the chanprefix parameter if the 'u' option is specified.
2555
2556 ConfBridge
2557 --------------------------
2558  * CONFBRIDGE dialplan function is now capable of creating/modifying dynamic
2559    conference user menus.
2560
2561  * CONFBRIDGE dialplan function is now capable of removing dynamic conference
2562    menus, bridge settings, and user settings that have been applied by the
2563    CONFBRIDGE dialplan function.
2564
2565  * The ConfBridge dialplan application now sets a channel variable,
2566    CONFBRIGE_RESULT, upon exiting. This variable can be used to determine
2567    how a channel exited the conference.
2568
2569  * Added conference user option 'announce_join_leave_review'. This option
2570    implies 'announce_join_leave' with the added effect that the user will
2571    be asked if they want to confirm or re-record the recording of their
2572    name when entering the conference
2573
2574 Directory
2575 --------------------------
2576  * At exit, the Directory application now sets a channel variable
2577    DIRECTORY_RESULT to one of the following based on the reason for exiting:
2578      OPERATOR    user requested operator by pressing '0' for operator
2579      ASSISTANT   user requested assistant by pressing '*' for assistant
2580      TIMEOUT     user pressed nothing and Directory stopped waiting
2581      HANGUP      user's channel hung up
2582      SELECTED    user selected a user from the directory and is routed
2583      USEREXIT    user pressed '#' from the selection prompt to exit
2584      FAILED      directory failed in a way that wasn't accounted for. Dang.
2585
2586 Monitor
2587 ------------------
2588  * Monitor() - A new option, B(), has been added that will turn on a periodic
2589    beep while the call is being recorded.
2590
2591 MusicOnHold
2592 --------------------------
2593  * MusicOnHold streams (all modes other than "files") now support wide band
2594    audio too.
2595
2596 Page
2597 --------------------------
2598  * Added options 'b' and 'B' to apply predial handlers for outgoing calls
2599    and for the channel executing Page respectively.
2600
2601 PickupChan
2602 --------------------------
2603  * PickupChan now accepts channel uniqueids of channels to pickup.
2604
2605 Say
2606 --------------------------
2607  * If a channel variable SAY_DTMF_INTERRUPT is present on a channel and set
2608    to 'true' (case insensitive), then any Say application (SayNumber,
2609    SayDigits, SayAlpha, SayAlphaCase, SayUnixTime, and SayCounted) will
2610    anticipate DTMF. If DTMF is received, these applications will behave like
2611    the background application and jump to the received extension once a match
2612    is established or after a short period of inactivity.
2613
2614 MixMonitor
2615 -------------------------
2616  * A new function, MIXMONITOR, has been added to allow access to individual
2617    instances of MixMonitor on a channel.
2618
2619  * A new option, B(), has been added that will turn on a periodic beep while the
2620    call is being recorded.
2621
2622
2623 Channel Drivers
2624 -------------------------
2625
2626 chan_sip
2627 -------------------------
2628  * TEL URI support for inbound INVITE requests has been added. chan_sip will
2629    now handle TEL schemes in the Request and From URIs. The phone-context in
2630    the Request URI will be stored in the SIPURIPHONECONTEXT channel variable on
2631    the inbound channel.
2632
2633 Core
2634 ------------------
2635  * Exposed sorcery-based configuration files like pjsip.conf to dialplans via
2636    the new AST_SORCERY diaplan function.
2637
2638  * Core Show Locks output now includes Thread/LWP ID if the platform
2639    supports this feature.
2640
2641  * New "logger add channel" and "logger remove channel" CLI commands have
2642    been added to allow creation and deletion of dynamic logger channels
2643    without configuration changes. These dynamic logger channels will only
2644    exist until the next restart of asterisk.
2645
2646 ARI
2647 ------------------
2648  * The live recording object on recording events now contains a target_uri
2649    field which contains the URI of what is being recorded.
2650
2651  * The bridge type used when creating a bridge is now a comma separated list of
2652    bridge properties. Valid options are: mixing, holding, dtmf_events, and
2653    proxy_media.
2654
2655  * A channelId can now be provided when creating a channel, either in the
2656    uri (POST channels/my-channel-id) or as query parameter.  A local channel
2657    will suffix the second channel id with ';2' unless provided as query
2658    parameter otherChannelId.
2659
2660  * A bridgeId can now be provided when creating a bridge, either in the uri
2661    (POST bridges/my-bridge-id) or as a query parameter.
2662
2663  * A playbackId can be provided when starting a playback, either in the uri
2664    (POST channels/my-channel-id/play/my-playback-id /
2665     POST bridges/my-bridge-id/play/my-playback-id)  or as a query parameter.
2666
2667  * A snoop channel can be started with a snoopId, in the uri or query.
2668
2669 AMI
2670 ------------------
2671  * Originate now takes optional parameters ChannelId and OtherChannelId,
2672    used to set the UniqueId on creation.  The other id is assigned to the
2673    second channel when dialing LOCAL, or defaults to appending ;2 if only
2674    the single Id is given.
2675
2676  * The Mixmonitor action now has a "Command" header that can be used to
2677    indicate a post-process command to run once recording finishes.
2678
2679 RealTime
2680 ------------------
2681  * A new set of Alembic scripts has been added for CDR tables. This will create
2682    a 'cdr' table with the default schema that Asterisk expects.
2683
2684
2685 Functions
2686 ------------------
2687  * A new function was added: PERIODIC_HOOK.  This allows running a periodic
2688    dialplan hook on a channel.  Any audio generated by this hook will be
2689    injected into the call.
2690
2691
2692 Resources
2693 ------------------
2694
2695 res_hep
2696 ------------------
2697  * A new module, res_hep, has been added, that acts as a generic packet
2698    capture agent for the Homer Encapsulation Protocol (HEP) version 3.
2699    It can be configured via hep.conf. Other modules can use res_hep to send
2700    message traffic to a HEP capture server.
2701
2702 res_hep_pjsip
2703 ------------------
2704  * A new module, res_hep_pjsip, has been added that will forward PJSIP
2705    message traffic to a HEP capture server. See res_hep for more
2706    information.
2707
2708 res_pjsip
2709 ------------------
2710  * transport and endpoint ToS options (tos, tos_audio, and tos_video) may now
2711    be set as the named set of ToS values (cs0-cs7, af11-af43, ef).
2712
2713  * Added the following new CLI commands:
2714    - "pjsip show contacts" - list all current PJSIP contacts.
2715    - "pjsip show contact" - show specific information about a current PJSIP
2716      contact.
2717    - "pjsip show channel" - show detailed information about a PJSIP channel.
2718
2719 res_pjsip_multihomed
2720 ------------------
2721  * A new module, res_pjsip_multihomed handles situations where the system
2722    Asterisk is running out has multiple interfaces. res_pjsip_multihomed
2723    determines which interface should be used during message sending.
2724
2725 res_pjsip_pidf_digium_body_supplement
2726 ------------------
2727  * A new module, res_pjsip_pidf_digium_body_supplement provides NOTIFY
2728    request body formatting for presence support in Digium phones.
2729
2730 res_pjsip_send_to_voicemail
2731 ------------------
2732  * A new module, res_pjsip_send_to_voicemail allows for REFER requests with
2733    particular headers to transfer a PJSIP channel directly to a particular
2734    extension that has VoiceMail. This is intended to be used with Digium
2735    phones that support this feature.
2736
2737 res_pjsip_outbound_registration
2738 ------------------
2739  * A new CLI command has been added: "pjsip show registrations", which lists
2740    all configured PJSIP registrations
2741
2742
2743 ------------------------------------------------------------------------------
2744 --- Functionality changes from Asterisk 12.0.0 to Asterisk 12.1.0 ------------
2745 ------------------------------------------------------------------------------
2746
2747 AMI
2748 ------------------
2749  * Added a new module that provides AMI control over MWI within Asterisk,
2750    res_mwi_external_ami. Note that this module depends on res_mwi_external;
2751    for more information on enabling this module, see res_mwi_external.
2752    This module provides the MWIGet/MWIUpdate/MWIDelete actions, as well as
2753    the MWIGet/MWIGetComplete events.
2754
2755  * The DialStatus field in the DialEnd event can now contain additional
2756    statuses that convey how the dial operation terminated. This includes
2757    ABORT, CONTINUE, and GOTO.
2758
2759  * AMI will now emit security events. A new class authorization has been
2760    added in manager.conf for the security events, 'security'. The new events
2761    are:
2762     - FailedACL - raised when a request violates an ACL check
2763     - InvalidAccountID - raised when a request fails an authentication
2764       check due to an invalid account ID
2765     - SessionLimit - raised when a request fails due to exceeding the
2766       number of allowed concurrent sessions for a service
2767     - MemoryLimit - raised when a request fails due to an internal memory
2768       allocation failure
2769     - LoadAverageLimit - raised when a request fails because a configured
2770       load average limit has been reached
2771     - RequestNotAllowed - raised when a request is not allowed by
2772       the service
2773     - AuthMethodNotAllowed - raised when a request used an authentication
2774       method not allowed by the service
2775     - RequestBadFormat - raised when a request is received with bad formatting
2776     - SuccessfulAuth - raised when a request successfully authenticates
2777     - UnexpectedAddress - raised when a request has a different source address
2778       then what is expected for a session already in progress with a service
2779     - ChallengeResponseFailed - raised when a request's attempt to authenticate
2780       has been challenged, and the request failed the authentication challenge
2781     - InvalidPassword - raised when a request provides an invalid password
2782       during an authentication attempt
2783     - ChallengeSent - raised when an Asterisk service send an authentication
2784       challenge to a request
2785     - InvalidTransport - raised when a request attempts to use a transport not
2786       allowed by the Asterisk service
2787
2788  * Bridge related events now have two additional fields: BridgeName and
2789    BridgeCreator. BridgeName is a descriptive name for the bridge;
2790    BridgeCreator is the name of the entity that created the bridge. This
2791    affects the following events: ConfbridgeStart, ConfbridgeEnd,
2792    ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
2793    ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
2794    AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
2795
2796 ARI
2797 ------------------
2798  * The Bridge data model now contains the additional fields 'name' and
2799    'creator'. The 'name' field conveys a descriptive name for the bridge;
2800    the 'creator' field conveys the name of the entity that created the bridge.
2801    This affects all responses to HTTP requests that return a Bridge data model
2802    as well as all event derived data models that contain a Bridge data model.
2803    The POST /bridges operation may now optionally specify a name to give to
2804    the bridge being created.
2805
2806  * Added a new ARI resource 'mailboxes' which allows the creation and
2807    modification of mailboxes managed by external MWI. Modules res_mwi_external
2808    and res_stasis_mailbox must be enabled to use this resource. For more
2809    information on external MWI control, see res_mwi_external.
2810
2811  * Added new events for externally initiated transfers. The event
2812    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
2813    of a bridge in the ARI controlled application to the dialplan; the
2814    BridgeAttendedTransfer event is raised when a channel initiates an
2815    attended transfer of a bridge in the ARI controlled application to the
2816    dialplan.
2817
2818  * Channel variables may now be specified as a body parameter to the
2819    POST /channels operation. The 'variables' key in the JSON is interpreted
2820    as a sequence of key/value pairs that will be added to the created channel
2821    as channel variables. Other parameters in the JSON body are treated as
2822    query parameters of the same name.
2823
2824 HTTP
2825 ------------------
2826  * Asterisk's HTTP server now supports chunked Transfer-Encoding. This will be
2827    automatically handled by the HTTP server if a request is received with a
2828    Transfer-Encoding type of "chunked".
2829
2830 res_pjsip
2831 ------------------
2832  * Path support has been added with the 'support_path' option in registration
2833    and aor sections.
2834
2835  * A 'debug' option has been added to the globals section that will allow
2836    sip messages to be logged.
2837
2838  * A 'set_var' option has been added to endpoints that will automatically
2839    set the desired variable(s) on a channel created for that endpoint.
2840
2841  * Several new tables and columns have been added to the realtime schema for
2842    the res_pjsip related modules. See the UPGRADE.txt notes for updating
2843    the database schema.
2844
2845 res_mwi_external
2846 ------------------
2847  * A new module, res_mwi_external, has been added to Asterisk. This module
2848    acts as a base framework that other modules can build on top of to allow
2849    an external system to control MWI within Asterisk. For implementations
2850    that make use of res_mwi_external, see res_mwi_external_ami and
2851    res_ari_mailboxes. Note that res_mwi_external canflicts with other modules
2852    that may produce MWI themselves, such as app_voicemail. res_mwi_external
2853    and other modules that depend on it cannot be built or loaded with
2854    app_voicemail present.
2855
2856 res_pjsip
2857 ------------------
2858  * DNS functionality will now automatically be enabled if the system configured
2859    nameservers can be retrieved. If the system configured nameservers can not be
2860    retrieved the functionality will resort to using system resolution. Functionalty
2861    such as SRV records and failover will not be available if system resolution
2862    is in use.
2863
2864 ------------------------------------------------------------------------------
2865 --- Functionality changes from Asterisk 11 to Asterisk 12 --------------------
2866 ------------------------------------------------------------------------------
2867
2868 Overview
2869 ------------------
2870
2871 Asterisk 12 is a standard release of the Asterisk project. As such, the
2872 focus of development for this release was on core architectural changes and
2873 major new features. This includes:
2874  * A more flexible bridging core based on the Bridging API
2875  * A new internal message bus, Stasis
2876  * Major standardization and consistency improvements to AMI
2877  * Addition of the Asterisk RESTful Interface (ARI)
2878  * A new SIP channel driver, chan_pjsip
2879 In addition, as the vast majority of bridging in Asterisk was migrated to the
2880 Bridging API used by ConfBridge, major changes were made to most of the
2881 interfaces in Asterisk. This includes not only AMI, but also CDRs and CEL.
2882
2883 Specifications have been written for the affected interfaces. These
2884 specifications are available on the Asterisk wiki:
2885  * AMI - https://wiki.asterisk.org/wiki/x/dAFRAQ
2886  * CEL - https://wiki.asterisk.org/wiki/x/4ICLAQ
2887  * CDRs - https://wiki.asterisk.org/wiki/x/pwpRAQ
2888
2889 It is *highly* recommended that anyone migrating to Asterisk 12 read the
2890 information regarding its release both in this file and in the accompanying
2891 UPGRADE.txt file. More detailed information on the major changes can be found
2892 on the Asterisk wiki at https://wiki.asterisk.org/wiki/x/0YCLAQ.
2893
2894
2895 Build System
2896 ------------------
2897  * Added build option DISABLE_INLINE. This option can be used to work around a
2898    bug in gcc. For more information, see
2899    http://gcc.gnu.org/bugzilla/show_bug.cgi?id=47816
2900
2901  * Removed the CHANNEL_TRACE development mode build option. Certain aspects of
2902    the CHANNEL_TRACE build option were incompatible with the new bridging
2903    architecture.
2904
2905  * Asterisk now optionally uses libxslt to improve XML documentation generation
2906    and maintainability. If libxslt is not available on the system, some XML
2907    documentation will be incomplete.
2908
2909  * Asterisk now depends on libjansson. If a package of libjansson is not
2910    available on your distro, please see http://www.digip.org/jansson/.
2911
2912  * Asterisk now depends on libuuid and, optionally, uriparser. It is
2913    recommended that you install uriparser, even if it is optional.
2914
2915  * The new SIP stack and channel driver uses a particular version of PJSIP.
2916    Please see https://wiki.asterisk.org/wiki/x/J4GLAQ for more information on
2917    configuring and installing PJSIP for usage with Asterisk.
2918
2919  * Optional API was re-implemented to be more portable, and no longer requires
2920    weak reference support from the compiler. The build option OPTIONAL_API may
2921    be disabled to disable Optional API support.
2922
2923 Applications
2924 ------------------
2925
2926 AgentLogin
2927 ------------------
2928  * Along with AgentRequest, this application has been modified to be a
2929    replacement for chan_agent. The act of a channel calling the AgentLogin
2930    application places the channel into a pool of agents that can be
2931    requested by the AgentRequest application. Note that this application, as
2932    well as all other agent related functionality, is now provided by the
2933    app_agent_pool module. See chan_agent and AgentRequest for more information.
2934
2935  * This application no longer performs agent authentication. If authentication
2936    is desired, the dialplan needs to perform this function using the
2937    Authenticate or VMAuthenticate application or through an AGI script before
2938    running AgentLogin.
2939
2940  * If this application is called and the agent is already logged in, the
2941    dialplan will continue exection with the AGENT_STATUS channel variable set
2942    to ALREADY_LOGGED_IN.
2943
2944  * The agents.conf schema has changed. Rather than specifying agents on a
2945    single line in comma delineated fashion, each agent is defined in a separate
2946    context. This allows agents to use the power of context templates in their
2947    definition.
2948
2949  * A number of parameters from agents.conf have been removed. This includes
2950    maxloginretries, autologoffunavail, updatecdr, goodbye, group, recordformat,
2951    urlprefix, and savecallsin. These options were obsoleted by the move from
2952    a channel driver model to the bridging/application model provided by
2953    app_agent_pool.
2954
2955 AgentRequest
2956 ------------------
2957  * A new application, this will request a logged in agent from the pool and
2958    bridge the requested channel with the channel calling this application.
2959    Logged in agents are those channels that called the AgentLogin application.
2960    If an agent cannot be requested from the pool, the AGENT_STATUS dialplan
2961    application will be set with an appropriate error value.
2962
2963 AgentMonitorOutgoing
2964 ------------------
2965  * This application has been removed. It was a holdover from when
2966    AgentCallbackLogin was removed.
2967
2968 AlarmReceiver
2969 ------------------
2970  * Added support for additional Ademco DTMF signalling formats, including
2971    Express 4+1, Express 4+2, High Speed and Super Fast.
2972
2973  * Added channel variable ALARMRECEIVER_CALL_LIMIT. This sets the maximum
2974    call time, in milliseconds, to run the application.
2975
2976  * Added channel variable ALARMRECEIVER_RETRIES_LIMIT. This sets the
2977    maximum number of times to retry the call.
2978
2979  * Added a new configuration option answait. If set, the AlarmReceiver
2980    application will wait the number of milliseconds specified by answait
2981    after the channel has answered. Valid values range between 500
2982    milliseconds and 10000 milliseconds.
2983
2984  * Added configuration option no_group_meta. If enabled, grouping of metadata
2985    information in the AlarmReceiver log file will be skipped.
2986
2987 Answer
2988 ------------------
2989  * It is now no longer possible to bypass updating the CDR on the channel
2990    when answering. CDRs reflect the state of the channel and will always
2991    reflect the time they were Answered.
2992
2993 BridgeWait
2994 ------------------
2995  * A new application in Asterisk, this will place the calling channel
2996    into a holding bridge, optionally entertaining them with some form of
2997    media. Channels participating in a holding bridge do not interact with
2998    other channels in the same holding bridge. Optionally, however, a channel
2999    may join as an announcer. Any media passed from an announcer channel is
3000    played to all channels in the holding bridge. Channels leave a holding
3001    bridge either when an optional timer expires, or via the ChannelRedirect
3002    application or AMI Redirect action.
3003
3004 ConfBridge
3005 ------------------
3006  * All participants in a bridge can now be kicked out of a conference room
3007    by specifying the channel parameter as 'all' in the ConfBridge kick CLI
3008    command, i.e., 'confbridge kick <conference> all'
3009
3010  * CLI output for the 'confbridge list' command has been improved. When
3011    displaying information about a particular bridge, flags will now be shown
3012    for the participating users indicating properties of that user.
3013
3014  * The ConfbridgeList event now contains the following fields: WaitMarked,
3015    EndMarked, and Waiting. This displays additional properties about the
3016    user's profile, as well as whether or not the user is waiting for a
3017    Marked user to enter the conference.
3018
3019  * Added a new option for conference recording, record_file_append. If enabled,
3020    when the recording is stopped and then re-started, the existing recording
3021    will be used and appended to.
3022
3023  * ConfBridge now has the ability to set the language of announcements to the
3024    conference.  The language can be set on a bridge profile in confbridge.conf
3025    or by the dialplan function CONFBRIDGE(bridge,language)=en.
3026
3027 ControlPlayback
3028 ------------------
3029  * The channel variable CPLAYBACKSTATUS may now return the value
3030    'REMOTESTOPPED'. This occurs when playback is stopped by a remote interface,
3031    such as AMI. See the AMI action ControlPlayback for more information.
3032
3033 Directory
3034 ------------------
3035  * Added the 'a' option, which allows the caller to enter in an additional
3036    alias for the user in the directory. This option must be used in conjunction
3037    with the 'f', 'l', or 'b' options. Note that the alias for a user can be
3038    specified in voicemail.conf.
3039
3040 DumpChan
3041 ------------------
3042  * The output of DumpChan no longer includes the DirectBridge or IndirectBridge
3043    fields. Instead, if a channel is in a bridge, it includes a BridgeID field
3044    containing the unique ID of the bridge that the channel happens to be in.
3045
3046 ForkCDR
3047 ------------------
3048  * ForkCDR no longer automatically resets the forked CDR. See the 'r' option
3049    for more information.
3050
3051  * Variables are no longer purged from the original CDR. See the 'v' option for
3052    more information.
3053
3054  * The 'A' option has been removed. The Answer time on a CDR is never updated
3055    once set.
3056
3057  * The 'd' option has been removed. The disposition on a CDR is a function of
3058    the state of the channel and cannot be altered.
3059
3060  * The 'D' option has been removed. Who the Party B is on a CDR is a function
3061    of the state of the respective channels involved in the CDR and cannot be
3062    altered.
3063
3064  * The 'r' option has been changed. Previously, ForkCDR always reset the CDR
3065    such that the start time and, if applicable, the answer time was updated.
3066    Now, by default, ForkCDR simply forks the CDR, maintaining any times. The
3067    'r' option now triggers the Reset, setting the start time (and answer time
3068    if applicable) to the current time. Note that the 'a' option still sets
3069    the answer time to the current time if the channel was already answered.
3070
3071  * The 's' option has been removed. A variable can be set on the original CDR
3072    if desired using the CDR function, and removed from a forked CDR using the
3073    same function.
3074
3075  * The 'T' option has been removed. The concept of DONT_TOUCH and LOCKED no
3076    longer applies in the CDR engine.
3077
3078  * The 'v' option now prevents the copy of the variables from the original CDR
3079    to the forked CDR. Previously the variables were always copied but were
3080    removed from the original. This was changed as removing variables from a CDR
3081    can have unintended side effects - this option allows the user to prevent
3082    propagation of variables from the original to the forked without modifying
3083    the original.
3084
3085 MeetMe
3086 -------------------
3087  * Added the 'n' option to MeetMe to prevent application of the DENOISE
3088    function to a channel joining a conference. Some channel drivers that vary
3089    the number of audio samples in a voice frame will experience significant
3090    quality problems if a denoiser is attached to the channel; this option gives
3091    them the ability to remove the denoiser without having to unload func_speex.
3092
3093 MixMonitor
3094 ------------------
3095  * The 'b' option now includes conferences as well as sounds played to the
3096    participants.
3097
3098  * The AUDIOHOOK_INHERIT function is no longer needed to keep a MixMonitor
3099    running during a transfer. If a MixMonitor is started on a channel,
3100    the MixMonitor will continue to record the audio passing through the
3101    channel even in the presence of transfers.
3102
3103 NoCDR
3104 ------------------
3105  * The NoCDR application is deprecated. Please use the CDR_PROP function to
3106    disable CDRs.
3107
3108  * While the NoCDR application will prevent CDRs for a channel from being
3109    propagated to registered CDR backends, it will not prevent that data from
3110    being collected. Hence, a subsequent call to ResetCDR or the CDR_PROP
3111    function that enables CDRs on a channel will restore those records that have
3112    not yet been finalized.
3113
3114 ParkAndAnnounce
3115 -------------------
3116  * The app_parkandannounce module has been removed. The application
3117    ParkAndAnnounce is now provided by the res_parking module. See the
3118    res_parking changes for more information.
3119
3120 Queue
3121 -------------------
3122  * Added queue available hint. The hint can be added to the dialplan using the
3123    following syntax: exten,hint,Queue:{queue_name}_avail
3124    For example, if the name of the queue is 'markq':
3125         exten => 8501,hint,Queue:markq_avail
3126    This will report 'InUse' if there are no logged in agents or no free agents.
3127    It will report 'Idle' when an agent is free.
3128
3129  * Queues now support a hint for member paused state. The hint uses the form
3130    'Queue:{queue_name}_pause_{member_name}', where {queue_name} and {member_name}
3131    are the name of the queue and the name of the member to subscribe to,
3132    respectively. For example: exten => 8501,hint,Queue:sales_pause_mark.
3133    Members will show as In Use when paused.
3134
3135  * The configuration options eventwhencalled and eventmemberstatus have been
3136    removed.  As a result, the AMI events QueueMemberStatus, AgentCalled,
3137    AgentConnect, AgentComplete, AgentDump, and AgentRingNoAnswer will always be
3138    sent.  The "Variable" fields will also no longer exist on the Agent* events.
3139    These events can be filtered out from a connected AMI client using the
3140    eventfilter setting in manager.conf.
3141
3142  * The queue log now differentiates between blind and attended transfers. A
3143    blind transfer will result in a BLINDTRANSFER message with the destination
3144    context and extension. An attended transfer will result in an
3145    ATTENDEDTRANSFER message. This message will indicate the method by which
3146    the attended transfer was completed: "BRIDGE" for a bridge merge, "APP"
3147    for running an application on a bridge or channel, or "LINK" for linking
3148    two bridges together with local channels. The queue log will also now detect
3149    externally initiated blind and attended transfers and record the transfer
3150    status accordingly.
3151
3152  * When performing queue pause/unpause on an interface without specifying an
3153    individual queue, the PAUSEALL/UNPAUSEALL event will only be logged if at
3154    least one member of any queue exists for that interface.
3155
3156  * Added the 'queue_log_realtime_use_gmt' option to have timestamps in GMT
3157    for realtime queue log entries.
3158
3159 ResetCDR
3160 ------------------
3161  * The 'e' option has been deprecated. Use the CDR_PROP function to re-enable
3162    CDRs when they were previously disabled on a channel.
3163
3164  * The 'w' and 'a' options have been removed. Dispatching CDRs to registered
3165    backends occurs on an as-needed basis in order to preserve linkedid
3166    propagation and other needed behavior.
3167
3168 SayAlphaCase
3169 ------------------
3170  * A new application, this is similar to SayAlpha except that it supports
3171    case sensitive playback of the specified characters. For example,
3172    SayAlphaCase(u,aBc) will result in 'a uppercase b c'.
3173
3174 SetAMAFlags
3175 ------------------
3176  * This application is deprecated in favor of CHANNEL(amaflags).
3177
3178 SendDTMF
3179 ------------------
3180  * The SendDTMF application will now accept 'W' as valid input. This will cause
3181    the application to delay one second while streaming DTMF.
3182
3183 Stasis
3184 ------------------
3185  * A new application in Asterisk 12, this hands control of the channel calling
3186    the application over to an external system. Currently, external systems
3187    manipulate channels in Stasis through the Asterisk RESTful Interface (ARI).
3188
3189 UserEvent
3190 ------------------
3191  * UserEvent will now handle duplicate keys by overwriting the previous value
3192    assigned to the key.
3193
3194  * In addition to AMI, UserEvent invocations will now be distributed to any
3195    interested Stasis applications.
3196
3197 VoiceMail
3198 ------------------
3199  * Mailboxes defined by app_voicemail MUST be referenced by the rest of the
3200    system as mailbox@context.  The rest of the system cannot add @default
3201    to mailbox identifiers for app_voicemail that do not specify a context
3202    any longer.  It is a mailbox identifier format that should only be
3203    interpreted by app_voicemail.
3204
3205  * The voicemail.conf configuration file now has an 'alias' configuration
3206    parameter for use with the Directory application. The voicemail realtime
3207    database table schema has also been updated with an 'alias' column.
3208
3209
3210 Codecs
3211 ------------------
3212  * Pass through support has been added for both VP8 and Opus.
3213
3214  * Added format attribute negotiation for the Opus codec. Format attribute
3215    negotiation is provided by the res_format_attr_opus module.
3216
3217
3218 Core
3219 ------------------
3220  * Masquerades as an operation inside Asterisk have been effectively hidden
3221    by the migration to the Bridging API. As such, many 'quirks' of Asterisk
3222    no longer occur. This includes renaming of channels, "<ZOMBIE>" channels,
3223    dropping of frame/audio hooks, and other internal implementation details
3224    that users had to deal with. This fundamental change has large implications
3225    throughout the changes documented for this version. For more information
3226    about the new core architecture of Asterisk, please see the Asterisk wiki.
3227
3228  * Multiple parties in a bridge may now be transferred. If a participant in a
3229    multi-party bridge initiates a blind transfer, a Local channel will be used
3230    to execute the dialplan location that the transferer sent the parties to. If
3231    a participant in a multi-party bridge initiates an attended transfer,
3232    several options are possible. If the attended transfer results in a transfer
3233    to an application, a Local channel is used. If the attended transfer results
3234    in a transfer to another channel, the resulting channels will be merged into
3235    a single bridge.
3236
3237  * The channel variable ATTENDED_TRANSFER_COMPLETE_SOUND is no longer channel
3238    driver specific.  If the channel variable is set on the transferrer channel,
3239    the sound will be played to the target of an attended transfer.
3240
3241  * The channel variable BRIDGEPEER becomes a comma separated list of peers in
3242    a multi-party bridge.  The BRIDGEPEER value can have a maximum of 10 peers
3243    listed.  Any more peers in the bridge will not be included in the list.
3244    BRIDGEPEER is not valid in holding bridges like parking since those channels
3245    do not talk to each other even though they are in a bridge.
3246
3247  * The channel variable BRIDGEPVTCALLID is only valid for two party bridges
3248    and will contain a value if the BRIDGEPEER's channel driver supports it.
3249
3250  * A channel variable ATTENDEDTRANSFER is now set which indicates which channel
3251    was responsible for an attended transfer in a similar fashion to
3252    BLINDTRANSFER.
3253
3254  * Modules using the Configuration Framework or Sorcery must have XML
3255    configuration documentation. This configuration documentation is included
3256    with the rest of Asterisk's XML documentation, and is accessible via CLI
3257    commands. See the CLI changes for more information.
3258
3259 AMI (Asterisk Manager Interface)
3260 ------------------
3261  * Major changes were made to both the syntax as well as the semantics of the
3262    AMI protocol. In particular, AMI events have been substantially improved
3263    in this version of Asterisk. For more information, please see the AMI
3264    specification at https://wiki.asterisk.org/wiki/x/dAFRAQ
3265
3266  * AMI events that reference a particular channel or bridge will now always
3267    contain a standard set of fields. When multiple channels or bridges are
3268    referenced in an event, fields for at least some subset of the channels
3269    and bridges in the event will be prefixed with a descriptive name to avoid
3270    name collisions. See the AMI event documentation on the Asterisk wiki for
3271    more information.
3272
3273  * The CLI command 'manager show commands' no longer truncates command names
3274    longer than 15 characters and no longer shows authorization requirement
3275    for commands. 'manager show command' now displays the privileges needed
3276    for using a given manager command instead.
3277
3278  * The SIPshowpeer action will now include a 'SubscribeContext' field for a
3279    peer in its response if the peer has a subscribe context set.
3280
3281  * The SIPqualifypeer action now acknowledges the request once it has
3282    established that the request is against a known peer. It also issues a new
3283    event, 'SIPQualifyPeerDone', once the qualify action has been completed.
3284
3285  * The PlayDTMF action now supports an optional 'Duration' parameter.  This
3286    specifies the duration of the digit to be played, in milliseconds.
3287
3288  * Added VoicemailRefresh action to allow an external entity to trigger mailbox
3289    updates when changes occur instead of requiring the use of pollmailboxes.
3290
3291  * Added a new action 'ControlPlayback'. The ControlPlayback action allows an
3292    AMI client to manipulate audio currently being played back on a channel. The
3293    supported operations depend on the application being used to send audio to
3294    the channel. When the audio playback was initiated using the ControlPlayback
3295    application or CONTROL STREAM FILE AGI command, the audio can be paused,
3296    stopped, restarted, reversed, or skipped forward. When initiated by other
3297    mechanisms (such as the Playback application), the audio can be stopped,
3298    reversed, or skipped forward.
3299
3300  * Channel related events now contain a snapshot of channel state, adding new
3301    fields to many of these events.
3302
3303  * The AMI event 'Newexten' field 'Extension' is deprecated, and may be removed
3304    in a future release. Please use the common 'Exten' field instead.
3305
3306  * The AMI event 'UserEvent' from app_userevent now contains the channel state
3307    fields. The channel state fields will come before the body fields.
3308
3309  * The AMI events 'ParkedCall', 'ParkedCallTimeOut', 'ParkedCallGiveUp', and
3310    'UnParkedCall' have changed significantly in the new res_parking module.
3311
3312    The 'Channel' and 'From' headers are gone. For the channel that was parked
3313    or is coming out of parking, a 'Parkee' channel snapshot is issued and it
3314    has a number of fields associated with it. The old 'Channel' header relayed
3315    the same data as the new 'ParkeeChannel' header.
3316
3317    The 'From' field was ambiguous and changed meaning depending on the event.
3318    for most of these, it was the name of the channel that parked the call
3319    (the 'Parker'). There is no longer a header that provides this channel name,
3320    however the 'ParkerDialString' will contain a dialstring to redial the
3321    device that parked the call.
3322
3323    On UnParkedCall events, the 'From' header would instead represent the
3324    channel responsible for retrieving the parkee. It receives a channel
3325    snapshot labeled 'Retriever'. The 'from' field is is replaced with
3326    'RetrieverChannel'.
3327
3328    Lastly, the 'Exten' field has been replaced with 'ParkingSpace'.
3329
3330  * The AMI event 'Parkinglot' (response to 'Parkinglots' command) in a similar
3331    fashion has changed the field names 'StartExten' and 'StopExten' to
3332    'StartSpace' and 'StopSpace' respectively.
3333
3334  * The deprecated use of | (pipe) as a separator in the channelvars setting in
3335    manager.conf has been removed.
3336
3337  * Channel Variables conveyed with a channel no longer contain the name of the
3338    channel as part of the key field, i.e., ChanVariable(SIP/foo): bar=baz is now
3339    ChanVariable: bar=baz. When multiple channels are present in a single AMI
3340    event, the various ChanVariable fields will contain a suffix that specifies
3341    which channel they correspond to.
3342
3343  * The NewPeerAccount AMI event is no longer raised. The NewAccountCode AMI
3344    event always conveys the AMI event for a particular channel.
3345
3346  * All 'Reload' events have been consolidated into a single event type. This
3347    event will always contain a Module field specifying the name of the module
3348    and a Status field denoting the result of the reload. All modules now issue
3349    this event when being reloaded.
3350
3351  * The 'ModuleLoadReport' event has been removed. Most AMI connections would
3352    fail to receive this event due to being connected after modules have loaded.
3353    AMI connections that want to know when Asterisk is ready should listen for
3354    the 'FullyBooted' event.
3355
3356  * app_fax now sends the same send fax/receive fax events as res_fax. The
3357    'FaxSent' event is now the 'SendFAX' event, and the 'FaxReceived' event is
3358    now the 'ReceiveFAX' event.
3359
3360  * The 'MusicOnHold' event is now two events: 'MusicOnHoldStart' and
3361    'MusicOnHoldStop'. The sub type field has been removed.
3362
3363  * The 'JabberEvent' event has been removed. It is not AMI's purpose to be a
3364    carrier for another protocol.
3365
3366  * The Bridge Manager action's 'Playtone' header now accepts more fine-grained
3367    options. 'Channel1' and 'Channel2' may be specified in order to play a tone
3368    to the specific channel. 'Both' may be specified to play a tone to both
3369    channels. The old 'yes' option is still accepted as a way of playing the
3370    tone to Channel2 only.
3371
3372  * The AMI 'Status' response event to the AMI Status action replaces the
3373    'BridgedChannel' and 'BridgedUniqueid' headers with the 'BridgeID' header to
3374    indicate what bridge the channel is currently in.
3375
3376  * The AMI 'Hold' event has been moved out of individual channel drivers, into
3377    core, and is now two events: 'Hold' and 'Unhold'.  The status field has been
3378    removed.
3379
3380  * The AMI events in app_queue have been made more consistent with each other.
3381    Events that reference channels (QueueCaller* and Agent*) will show
3382    information about each channel.  The (infamous) 'Join' and 'Leave' AMI
3383    events have been changed to 'QueueCallerJoin' and 'QueueCallerLeave'.
3384
3385  * The 'MCID' AMI event now publishes a channel snapshot when available and
3386    its non-channel-snapshot parameters now use either the "MCallerID" or
3387    'MConnectedID' prefixes with Subaddr*, Name*, and Num* suffixes instead
3388    of 'CallerID' and 'ConnectedID' to avoid confusion with similarly named
3389    parameters in the channel snapshot.
3390
3391  * The AMI events 'Agentlogin' and 'Agentlogoff' have been renamed
3392    'AgentLogin' and 'AgentLogoff' respectively.
3393
3394  * The 'Channel' key used in the 'AlarmClear', 'Alarm', and 'DNDState' has been
3395    renamed "DAHDIChannel" since it does not convey an Asterisk channel name.
3396
3397  * 'ChannelUpdate' events have been removed.
3398
3399  * All AMI events now contain a 'SystemName' field, if available.
3400
3401  * Local channel optimization is now conveyed in two events:
3402    'LocalOptimizationBegin' and 'LocalOptimizationEnd'. The Begin event is sent
3403    when the Local channel driver begins attempting to optimize itself out of
3404    the media path; the End event is sent after the channel halves have
3405    successfully optimized themselves out of the media path.
3406
3407  * Local channel information in events is now prefixed with 'LocalOne' and
3408    'LocalTwo'. This replaces the suffix of '1' and '2' for the two halves of
3409    the Local channel. This affects the 'LocalBridge', 'LocalOptimizationBegin',
3410    and 'LocalOptimizationEnd' events.
3411
3412  * The option 'allowmultiplelogin' can now be set or overriden in a particular
3413    account. When set in the general context, it will act as the default
3414    setting for defined accounts.
3415
3416  * The 'BridgeAction' event was removed. It technically added no value, as the
3417    Bridge Action already receives confirmation of the bridge through a
3418    successful completion Event.
3419
3420  * The 'BridgeExec' events were removed. These events duplicated the events that
3421    occur in the Briding API, and are conveyed now through BridgeCreate,
3422    BridgeEnter, and BridgeLeave events.
3423
3424  * The 'RTCPSent'/'RTCPReceived' events have been significantly modified from
3425    previous versions. They now report all SR/RR packets sent/received, and
3426    have been restructured to better reflect the data sent in a SR/RR. In
3427    particular, the event structure now supports multiple report blocks.
3428
3429  * Added 'BlindTransfer' and 'AttendedTransfer' events. These events are
3430    raised when a blind transfer/attended transfer completes successfully.
3431    They contain information about the transfer that just completed, including
3432    the location of the transfered channel.
3433
3434  * Added a 'security' class to AMI which outputs the required fields for
3435    security messages similar to the log messages from res_security_log
3436
3437  * The AMI event 'ExtensionStatus' now contains a 'StatusText' field
3438    that describes the status value in a human readable string.
3439
3440 CDR (Call Detail Records)
3441 ------------------
3442  * Significant changes have been made to the behavior of CDRs. The CDR engine
3443    was effectively rewritten and built on the Stasis message bus. For a full
3444    definition of CDR behavior in Asterisk 12, please read the specification
3445    on the Asterisk wiki (wiki.asterisk.org).
3446
3447  * CDRs will now be created between all participants in a bridge. For each
3448    pair of channels in a bridge, a CDR is created to represent the path of
3449    communication between those two endpoints. This lets an end user choose who
3450    to bill for what during bridge operations with multiple parties.
3451
3452  * The duration, billsec, start, answer, and end times now reflect the times
3453    associated with the current CDR for the channel, as opposed to a cumulative
3454    measurement of all CDRs for that channel.
3455
3456  * When a CDR is dispatched, user defined CDR variables from both parties are
3457    included in the resulting CDR. If both parties have the same variable, only
3458    the Party A value is provided.
3459
3460  * Added a new option to cdr.conf, 'debug'. When enabled, significantly more
3461    information regarding the CDR engine is logged as verbose messages. This
3462    option should only be used if the behavior of the CDR engine needs to be
3463    debugged.
3464
3465  * Added CLI command 'cdr set debug {on|off}'. This toggles the 'debug' setting
3466    normally configured in cdr.conf.
3467
3468  * Added CLI command 'cdr show active {channel}'. When {channel} is not
3469    specified, this command provides a summary of the channels with CDR
3470    information and their statistics. When {channel} is specified, it shows
3471    detailed information about all records associated with {channel}.
3472
3473 CEL (Channel Event Logging)
3474 ------------------
3475  * CEL has undergone significant rework in Asterisk 12, and is now built on the
3476    Stasis message bus. Please see the specification for CEL on the Asterisk
3477    wiki at https://wiki.asterisk.org/wiki/x/4ICLAQ for more detailed
3478    information.
3479
3480  * The 'extra' field of all CEL events that use it now consists of a JSON blob
3481    with key/value pairs which are defined in the Asterisk 12 CEL documentation.
3482
3483  * BLINDTRANSFER events now report the transferee bridge unique
3484    identifier, extension, and context in a JSON blob as the extra string
3485    instead of the transferee channel name as the peer.
3486
3487  * ATTENDEDTRANSFER events now report the peer as NULL and additional
3488    information in the 'extra' string as a JSON blob. For transfers that occur
3489    between two bridged channels, the 'extra' JSON blob contains the primary
3490    bridge unique identifier, the secondary channel name, and the secondary
3491    bridge unique identifier. For transfers that occur between a bridged channel
3492    and a channel running an app, the 'extra' JSON blob contains the primary
3493    bridge unique identifier, the secondary channel name, and the app name.
3494
3495  * LOCAL_OPTIMIZE events have been added to convey local channel
3496    optimizations with the record occurring for the semi-one channel and
3497    the semi-two channel name in the peer field.
3498
3499  * BRIDGE_START, BRIDGE_END, BRIDGE_UPDATE, 3WAY_START, 3WAY_END, CONF_ENTER,
3500    CONF_EXIT, CONF_START, and CONF_END events have all been removed. These
3501    events have been replaced by BRIDGE_ENTER/BRIDGE_EXIT. The BRIDGE_ENTER
3502    and BRIDGE_EXIT events are raised when a channel enters/exits any bridge,
3503    regardless of whether or not that bridge happens to contain multiple
3504    parties.
3505
3506 CLI
3507 -------------------
3508  * When compiled with '--enable-dev-mode', the astobj2 library will now add
3509    several CLI commands that allow for inspection of ao2 containers that
3510    register themselves with astobj2. The CLI commands are 'astobj2 container
3511    dump', 'astobj2 container stats', and 'astobj2 container check'.
3512
3513  * Added specific CLI commands for bridge inspection. This includes 'bridge
3514    show all', which lists all bridges in the system, and 'bridge show {id}',
3515    which provides specific information about a bridge.
3516
3517  * Added CLI command 'bridge destroy'. This will destroy the specified bridge,
3518    ejecting the channels currently in the bridge. If the channels cannot
3519    continue in the dialplan or application that put them in the bridge, they
3520    will be hung up.
3521
3522  * Added command 'bridge kick'. This will eject a single channel from a bridge.
3523
3524  * Added commands to inspect and manipulate the registered bridge technologies.
3525    This include 'bridge technology show', which lists the registered bridge
3526    technologies, as well as 'bridge technology {suspend|unsuspend} {tech}',
3527    which controls whether or not a registered bridge technology can be used
3528    during smart bridge operations. If a technology is suspended, it will not
3529    be used when a bridge technology is picked for channels; when unsuspended,
3530    it can be used again.
3531
3532  * The command 'config show help {module} {type} {option}' will show
3533    configuration documentation for modules with XML configuration
3534    documentation. When {module}, {type}, and {option} are omitted, a listing
3535    of all modules with registered documentation is displayed. When {module}
3536    is specified, a listing of all configuration types for that module is
3537    displayed, along with their synopsis. When {module} and {type} are
3538    specified, a listing of all configuration options for that type are
3539    displayed along with their synopsis. When {module}, {type}, and {option}
3540    are specified, detailed information for that configuration option is
3541    displayed.
3542
3543  * Added 'core show sounds' and 'core show sound' CLI commands. These display
3544    a listing of all installed media sounds available on the system and
3545    detailed information about a sound, respectively.
3546
3547  * 'xmldoc dump' has been added. This CLI command will dump the XML
3548    documentation DOM as a string to the specified file. The Asterisk core
3549    will populate certain XML elements pulled from the source files with
3550    additional run-time information; this command lets a user produce the
3551    XML documentation with all information.
3552
3553 Features
3554 -------------------
3555  * Parking has been pulled from core and placed into a separate module called
3556    res_parking. See Parking changes below for more details. Configuration for
3557    parking should now be performed in res_parking.conf. Configuration for
3558    parking in features.conf is now unsupported.
3559
3560  * Core attended transfers now have several new options. While performing an
3561    attended transfer, the transferer now has the following options:
3562    - *1 - cancel the attended transfer (configurable via atxferabort)
3563    - *2 - complete the attended transfer, dropping out of the call
3564           (configurable via atxfercomplete)
3565    - *3 - complete the attended transfer, but stay in the call. This will turn
3566           the call into a multi-party bridge (configurable via atxferthreeway)
3567    - *4 - swap to the other party. Once an attended transfer has begun, this
3568           options may be used multiple times (configurable via atxferswap)
3569
3570  * For DTMF blind and attended transfers, the channel variable TRANSFER_CONTEXT
3571    must be on the channel initiating the transfer to have any effect.
3572
3573  * The BRIDGE_FEATURES channel variable would previously only set features for
3574    the calling party and would set this feature regardless of whether the
3575    feature was in caps or in lowercase. Use of a caps feature for a letter
3576    will now apply the feature to the calling party while use of a lowercase
3577    letter will apply that feature to the called party.
3578
3579  * Add support for automixmon to the BRIDGE_FEATURES channel variable.
3580
3581  * The channel variable DYNAMIC_PEERNAME is redundant with BRIDGEPEER and is
3582    removed.  The more useful DYNAMIC_WHO_ACTIVATED gives the channel name that
3583    activated the dynamic feature.
3584
3585  * The channel variables DYNAMIC_FEATURENAME and DYNAMIC_WHO_ACTIVATED are set
3586    only on the channel executing the dynamic feature.  Executing a dynamic
3587    feature on the bridge peer in a multi-party bridge will execute it on all
3588    peers of the activating channel.
3589
3590  * You can now have the settings for a channel updated using the FEATURE()
3591    and FEATUREMAP() functions inherited to child channels by setting
3592    FEATURE(inherit)=yes.
3593
3594  * automixmon now supports additional channel variables from automon including:
3595    TOUCH_MIXMONITOR_PREFIX, TOUCH_MIXMONITOR_MESSAGE_START,
3596    and TOUCH_MIXMONITOR_MESSAGE_STOP
3597
3598  * A new general features.conf option 'recordingfailsound' has been added which
3599    allowssetting a failure sound for a user tries to invoke a recording feature
3600    such as automon or automixmon and it fails.
3601
3602  * It is no longer necessary (or possible) to define the ATXFER_NULL_TECH in
3603    features.c for atxferdropcall=no to work properly. This option now just
3604    works.
3605
3606 Logging
3607 -------------------
3608  * Added log rotation strategy 'none'. If set, no log rotation strategy will
3609    be used. Given that this can cause the Asterisk log files to grow quickly,
3610    this option should only be used if an external mechanism for log management
3611    is preferred.
3612
3613 Realtime
3614 ------------------
3615  * Dynamic realtime tables for SIP Users can now include a 'path' field. This
3616    will store the path information for that peer when it registers. Realtime
3617    tables can also use the 'supportpath' field to enable Path header support.
3618
3619  * LDAP realtime configurations for SIP Users now have the AstAccountPathSupport
3620    objectIdentifier. This maps to the supportpath option in sip.conf.
3621
3622 Sorcery
3623 ------------------
3624  * Sorcery is a new data abstraction and object persistence API in Asterisk. It
3625    provides modules a useful abstraction on top of the many storage mechanisms
3626    in Asterisk, including the Asterisk Database, static configuration files,
3627    static Realtime, and dynamic Realtime. It also provides a caching service.
3628    Users can configure a hierarchy of data storage layers for specific modules
3629    in sorcery.conf.
3630
3631  * All future modules which utilize Sorcery for object persistence must have a
3632    column named "id" within their schema when using the Sorcery realtime module.
3633    This column must be able to contain a string of up to 128 characters in length.
3634
3635 Security Events Framework
3636 ------------------
3637  * Security Event timestamps now use ISO 8601 formatted date/time instead of
3638    the "seconds-microseconds" format that it was using previously.
3639
3640 Stasis Message Bus
3641 ------------------
3642  * The Stasis message bus is a publish/subscribe message bus internal to
3643    Asterisk. Many services in Asterisk are built on the Stasis message bus,
3644    including AMI, ARI, CDRs, and CEL. Parameters controlling the operation of
3645    Stasis can be configured in stasis.conf. Note that these parameters operate
3646    at a very low level in Asterisk, and generally will not require changes.
3647
3648 Channel Drivers
3649 ------------------
3650  * When a channel driver is configured to enable jiterbuffers, they are now
3651    applied unconditionally when a channel joins a bridge. If a jitterbuffer
3652    is already set for that channel when it enters, such as by the JITTERBUFFER
3653    function, then the existing jitterbuffer will be used and the one set by
3654    the channel driver will not be applied.
3655
3656 chan_agent
3657 ------------------
3658  * chan_agent has been removed and replaced with AgentLogin and AgentRequest
3659    dialplan applications provided by the app_agent_pool module. Agents are
3660    connected with callers using the new AgentRequest dialplan application.
3661    The Agents:<agent-id> device state is available to monitor the status of an
3662    agent. See agents.conf.sample for valid configuration options.
3663
3664  * The updatecdr option has been removed. Altering the names of channels on a
3665    CDR is not supported - the name of the channel is the name of the channel,
3666    and pretending otherwise helps no one. The AGENTUPDATECDR channel variable
3667    has also been removed, for the same reason.
3668
3669  * The endcall and enddtmf configuration options are removed.  Use the
3670    dialplan function CHANNEL(dtmf_features) to set DTMF features on the agent
3671    channel before calling AgentLogin.
3672
3673 chan_bridge
3674 ------------------
3675  * chan_bridge has been removed. Its functionality has been incorporated
3676    directly into the ConfBridge application itself.
3677
3678 chan_dahdi
3679 ------------------
3680  * Added the CLI command 'pri destroy span'. This will destroy the D-channel
3681    of the specified span and its B-channels. Note that this command should
3682    only be used if you understand the risks it entails.
3683
3684  * The CLI command 'dahdi destroy channel' is now 'dahdi destroy channels'.
3685    A range of channels can be specified to be destroyed. Note that this command
3686    should only be used if you understand the risks it entails.
3687
3688  * Added the CLI command 'dahdi create channels'. A range of channels can be
3689    specified to be created, or the keyword 'new' can be used to add channels
3690    not yet created.
3691
3692  * The script specified by the chan_dahdi.conf mwimonitornotify option now gets
3693    the exact configured mailbox name.  For app_voicemail mailboxes this is
3694    mailbox@context.
3695
3696  * Added mwi_vm_boxes that also must be configured for ISDN MWI to be enabled.
3697
3698 chan_iax2
3699 ------------------
3700  * IPv6 support has been added.  We are now able to bind to and
3701    communicate using IPv6 addresses.
3702
3703 chan_local
3704 ------------------
3705  * The /b option has been removed.
3706
3707  * chan_local moved into the system core and is no longer a loadable module.
3708
3709 chan_mobile
3710 ------------------
3711  * Added general support for busy detection.
3712
3713  * Added ECAM command support for Sony Ericsson phones.
3714
3715 chan_pjsip
3716 ------------------
3717  * A new SIP channel driver for Asterisk, chan_pjsip is built on the PJSIP
3718    SIP stack. A collection of resource modules provides the bulk of the SIP
3719    functionality. For more information on the new SIP channel driver, see
3720    https://wiki.asterisk.org/wiki/x/JYGLAQ
3721
3722 chan_sip
3723 ------------------
3724  * Added support for RFC 3327 "Path" headers. This can be enabled in sip.conf
3725    using the 'supportpath' setting, either on a global basis or on a peer basis.
3726    This setting enables Asterisk to route outgoing out-of-dialog requests via a
3727    set of proxies by using a pre-loaded route-set defined by the Path headers in
3728    the REGISTER request. See Realtime updates for more configuration information.
3729
3730  * The SIP_CODEC family of variables may now specify more than one codec. Each
3731    codec must be separated by a comma. The first codec specified is the
3732    preferred codec for the offer. This allows a dialplan writer to specify both
3733    audio and video codecs, e.g., Set(SIP_CODEC=ulaw,h264)
3734
3735  * The 'callevents' parameter has been removed. Hold AMI events are now raised
3736    in the core, and can be filtered out using the 'eventfilter' parameter
3737    in manager.conf.
3738
3739  * Added 'ignore_requested_pref'. When enabled, this will use the preferred
3740    codecs configured for a peer instead of the requested codec.
3741
3742  * The option "register_retry_403" has been added to chan_sip to work around
3743    servers that are known to erroneously send 403 in response to valid
3744    REGISTER requests and allows Asterisk to continue attepmting to connect.
3745
3746 chan_skinny
3747 ------------------
3748  * Added the 'immeddialkey' parameter. If set, when the user presses the
3749    configured key the already entered number will be immediately dialed. This
3750    is useful when the dialplan allows for variable length pattern matching.
3751    Valid options are '*' and '#'.
3752
3753  * Added the 'callfwdtimeout' parameter. This configures the amount of time (in
3754    milliseconds) before a call forward is considered to not be answered.
3755
3756  * The 'serviceurl' parameter allows Service URLs to be attached to line
3757    buttons.
3758
3759
3760 Functions
3761 ------------------
3762
3763 AGENT
3764 ------------------
3765  * The password option has been disabled, as the AgentLogin application no
3766    longer provides authentication.
3767
3768 AUDIOHOOK_INHERIT
3769 ------------------
3770  * Due to changes in the Asterisk core, this function is no longer needed to
3771    preserve a MixMonitor on a channel during transfer operations and dialplan
3772    execution. It is effectively obsolete.
3773
3774 CDR (function)
3775 ------------------
3776  * The 'amaflags' and 'accountcode' attributes for the CDR function are
3777    deprecated. Use the CHANNEL function instead to access these attributes.
3778
3779  * The 'l' option has been removed. When reading a CDR attribute, the most
3780    recent record is always used. When writing a CDR attribute, all non-finalized
3781    CDRs are updated.
3782
3783  * The 'r' option has been removed, for the same reason as the 'l' option.
3784
3785  * The 's' option has been removed, as LOCKED semantics no longer exist in the
3786    CDR engine.
3787
3788 CDR_PROP
3789 ------------------
3790  * A new function CDR_PROP has been added. This function lets you set properties
3791    on a channel's active CDRs. This function is write-only. Properties accept
3792    boolean values to set/clear them on the channel's CDRs. Valid properties
3793    include:
3794    - 'party_a' - make this channel the preferred Party A in any CDR between two
3795      channels. If two channels have this property set, the creation time of the
3796      channel is used to determine who is Party A. Note that dialed channels are
3797      never Party A in a CDR.
3798    - 'disable' - disable CDRs on this channel. This is analogous to the NoCDR
3799      application when set to True, and analogous to the 'e' option in ResetCDR
3800      when set to False.
3801
3802 CHANNEL
3803 ------------------
3804  * Added the argument 'dtmf_features'. This sets the DTMF features that will be
3805    enabled on a channel when it enters a bridge. Allowed values are 'T', 'K',
3806    'H', 'W', and 'X', and are analogous to the parameters passed to the Dial
3807    application.
3808
3809  * Added the argument 'after_bridge_goto'. This can be set to a parseable Goto
3810    string, i.e., [[context],extension],priority. If set on a channel, if a
3811    channel leaves a bridge but is not hung up it will resume dialplan execution
3812    at that location.
3813
3814 JITTERBUFFER
3815 ------------------
3816  * JITTERBUFFER now accepts an argument of 'disabled' which can be used
3817    to remove jitterbuffers previously set on a channel with JITTERBUFFER.
3818    The value of this setting is ignored when disabled is used for the argument.
3819
3820 PJSIP_DIAL_CONTACTS
3821 ------------------
3822  * A new function provided by chan_pjsip, this function can be used in
3823    conjunction with the Dial application to construct a dial string that will
3824    dial all contacts on an Address of Record associated with a chan_pjsip
3825    endpoint.
3826
3827 PJSIP_MEDIA_OFFER
3828 ------------------
3829  * Provided by chan_pjsip, this function sets the codecs to be offerred on the
3830    outbound channel prior to dialing.
3831
3832 REDIRECTING
3833 ------------------
3834  * Redirecting reasons can now be set to arbitrary strings. This means
3835    that the REDIRECTING dialplan function can be used to set the redirecting
3836    reason to any string. It also allows for custom strings to be read as the
3837    redirecting reason from SIP Diversion headers.
3838
3839 SPEECH_ENGINE
3840 ------------------
3841  * The SPEECH_ENGINE function now supports read operations. When read from, it
3842    will return the current value of the requested attribute.
3843
3844 VMCOUNT:
3845 ------------------
3846  * Mailboxes defined by app_voicemail MUST be referenced by the rest of the
3847    system as mailbox@context.  The rest of the system cannot add @default
3848    to mailbox identifiers for app_voicemail that do not specify a context
3849    any longer.  It is a mailbox identifier format that should only be
3850    interpreted by app_voicemail.
3851
3852
3853 Resources
3854 ------------------
3855
3856 res_agi (Asterisk Gateway Interface)
3857 ------------------
3858  * The manager event AGIExec has been split into AGIExecStart and AGIExecEnd.
3859
3860  * The manager event AsyncAGI has been split into AsyncAGIStart, AsyncAGIExec,
3861    and AsyncAGIEnd.
3862
3863  * The CONTROL STREAM FILE command now accepts an offsetms parameter. This
3864    will start the playback of the audio at the position specified. It will
3865    also return the final position of the file in 'endpos'.
3866
3867  * The CONTROL STREAM FILE command will now populate the CPLAYBACKSTATUS
3868    channel variable if the user stopped the file playback or if a remote
3869    entity stopped the playback. If neither stopped the playback, it will
3870    indicate the overall success/failure of the playback. If stopped early,
3871    the final offset of the file will be set in the CPLAYBACKOFFSET channel
3872    variable.
3873
3874  * The SAY ALPHA command now accepts an additional parameter to control
3875    whether it specifies the case of uppercase, lowercase, or all letters to
3876    provide functionality similar to SayAlphaCase.
3877
3878 res_ari (Asterisk RESTful Interface) (and others)
3879 ------------------
3880  * The Asterisk RESTful Interface (ARI) provides a mechanism to expose and
3881    control telephony primitives in Asterisk by remote client. This includes
3882    channels, bridges, endpoints, media, and other fundamental concepts. Users
3883    of ARI can develop their own communications applications, controlling
3884    multiple channels using an HTTP RESTful interface and receiving JSON events
3885    about the objects via a WebSocket connection. ARI can be configured in
3886    Asterisk via ari.conf. For more information on ARI, see
3887    https://wiki.asterisk.org/wiki/x/0YCLAQ
3888
3889 res_parking
3890 -------------------
3891  * Parking has been extracted from the Asterisk core as a loadable module,
3892    res_parking. Configuration for parking is now provided by res_parking.conf.
3893    Configuration through features.conf is no longer supported.
3894
3895  * res_parking uses the configuration framework. If an invalid configuration is
3896    supplied, res_parking will fail to load or fail to reload. Previously,
3897    invalid configurations would generally be accepted, with certain errors
3898    resulting in individually disabled parking lots.
3899
3900  * Parked calls are now placed in bridges. While this is largely an
3901    architectural change, it does have implications on how channels in a parking
3902    lot are viewed. For example, commands that display channels in bridges will
3903    now also display the channels in a parking lot.
3904
3905  * The order of arguments for the new parking applications have been modified.
3906    Timeout and return context/exten/priority are now implemented as options,
3907    while the name of the parking lot is now the first parameter. See the
3908    application documentation for Park, ParkedCall, and ParkAndAnnounce for more
3909    in-depth information as well as syntax.
3910
3911  * Extensions are by default no longer automatically created in the dialplan to
3912    park calls or pickup parked calls. Generation of dialplan extensions can be
3913    enabled using the 'parkext' configuration option.
3914
3915  * ADSI functionality for parking is no longer supported. The 'adsipark'
3916    configuration option has been removed as a result.
3917
3918  * The PARKINGSLOT channel variable has been deprecated in favor of
3919    PARKING_SPACE to match the naming scheme of the new system.
3920
3921  * PARKING_SPACE and PARKEDLOT channel variables will now be set for a parked
3922    channel even when the configuration option 'comebactoorigin' is enabled.
3923
3924  * A new CLI command 'parking show' has been added. This allows a user to
3925    inspect the parking lots that are currently in use.
3926    'parking show <parkinglot>' will also show the parked calls in a specific
3927    parking lot.
3928
3929  * The CLI command 'parkedcalls' is now deprecated in favor of
3930    'parking show <parkinglot>'.
3931
3932  * The AMI command 'ParkedCalls' will now accept a 'ParkingLot' argument which
3933    can be used to get a list of parked calls for a specific parking lot.
3934
3935  * The AMI command 'Park' field 'Channel2' has been deprecated and replaced
3936    with 'TimeoutChannel'. If both 'Channel2' and 'TimeoutChannel' are
3937    specified, 'TimeoutChannel' will be used. The field 'TimeoutChannel' is no
3938    longer a required argument.
3939
3940  * The ParkAndAnnounce application is now provided through res_parking instead
3941    of through the separate app_parkandannounce module.
3942
3943  * ParkAndAnnounce will no longer go to the next position in dialplan on timeout
3944    by default. Instead, it will follow the timeout rules of the parking lot. The
3945    old behavior can be reproduced by using the 'c' option.
3946
3947  * Dynamic parking lots will now fail to be created under the following
3948    conditions:
3949    - if the parking lot specified by PARKINGDYNAMIC does not exist
3950    - if they require exclusive park and parkedcall extensions which overlap
3951      with existing parking lots.
3952
3953  * Dynamic parking lots will be cleared on reload for dynamic parking lots that
3954    currently contain no calls. Dynamic parking lots containing parked calls
3955    will persist through the reloads without alteration.
3956
3957  * If 'parkext_exclusive' is set for a parking lot and that extension is
3958    already in use when that parking lot tries to register it, this is now
3959    considered a parking system configuration error. Configurations which do
3960    this will be rejected.
3961
3962  * Added channel variable PARKER_FLAT. This contains the name of the extension
3963    that would be used if 'comebacktoorigin' is enabled. This can be useful when
3964    comebacktoorigin is disabled, but the dialplan or an external control
3965    mechanism wants to use the extension in the park-dial context that was
3966    generated to re-dial the parker on timeout.
3967
3968 res_pjsip (and many others)
3969 ------------------
3970  * A large number of resource modules make up the SIP stack based on pjsip.
3971    The chan_pjsip channel driver users these resource modules to provide
3972    various SIP functionality in Asterisk. The majority of configuration for
3973    these modules is performed in pjsip.conf. Other modules may use their
3974    own configuration files.
3975
3976  * Added 'set_var' option for an endpoint. For each variable specified that
3977    variable gets set upon creation of a channel involving the endpoint.
3978
3979 res_rtp_asterisk
3980 ------------------
3981  * ICE/STUN/TURN support in res_rtp_asterisk has been made optional.  To enable
3982    them, an Asterisk-specific version of PJSIP needs to be installed.
3983    Tarballs are available from https://github.com/asterisk/pjproject/tags/.
3984
3985 res_statsd/res_chan_stats
3986 ------------------
3987  * A new resource module, res_statsd, has been added, which acts as a statsd
3988    client. This module allows Asterisk to publish statistics to a statsd
3989    server. In conjunction with res_chan_stats, it will publish statistics about
3990    channels to the statsd server. It can be configured via res_statsd.conf.
3991
3992 res_xmpp
3993 ------------------
3994  * Device state for XMPP buddies is now available using the following format:
3995    XMPP/<client name>/<buddy address>
3996    If any resource is available the device state is considered to be not in use.
3997    If no resources exist or all are unavailable the device state is considered
3998    to be unavailable.
3999
4000
4001 Scripts
4002 ------------------
4003
4004 Realtime/Database Scripts
4005 ------------------
4006  * Asterisk previously included example db schemas in the contrib/realtime/
4007    directory of the source tree.  This has been replaced by a set of database
4008    migrations using the Alembic framework.  This allows you to use alembic to
4009    initialize the database for you.  It will also serve as a database migration
4010    tool when upgrading Asterisk in the future.
4011
4012    See contrib/ast-db-manage/README.md for more details.
4013
4014 sip_to_res_pjsip.py
4015 -------------------
4016  * A new script has been added in the contrib/scripts/sip_to_res_pjsip folder.
4017    This python script will convert an existing sip.conf file to a
4018    pjsip.conf file, for use with the chan_pjsip channel driver. This script
4019    is meant to be an aid in converting an existing chan_sip configuration to
4020    a chan_pjsip configuration, but it is expected that configuration beyond
4021    what the script provides will be needed.
4022
4023 ------------------------------------------------------------------------------
4024 --- Functionality changes from Asterisk 10 to Asterisk 11 --------------------
4025 ------------------------------------------------------------------------------
4026
4027 Build System
4028 -------------------
4029  * The Asterisk build system will now build and install a shared library
4030    (libasteriskssl.so) used to wrap various initialization and shutdown functions
4031    from the libssl and libcrypto libraries provided by OpenSSL. This is done so
4032    that Asterisk can ensure that these functions do *not* get called by any
4033    modules that are loaded into Asterisk, since they should only be called once
4034    in any single process. If desired, this feature can be disabled by supplying
4035    the "--disable-asteriskssl" option to the configure script.
4036
4037  * A new make target, 'full', has been added to the Makefile.  This performs
4038    the same compilation actions as make all, but will also scan the entirety of
4039    each source file for documentation.  This option is needed to generate AMI
4040    event documentation.  Note that your system must have Python in order for
4041    this make target to succeed.
4042
4043  * The optimization portion of the build system has been reworked to avoid
4044    broken builds on certain architectures.  All architecture-specific
4045    optimization has been removed in favor of using -march=native to allow gcc
4046    to detect the environment in which it is running when possible.  This can
4047    be toggled as BUILD_NATIVE under "Compiler Flags" in menuselect.
4048
4049  * BUILD_CFLAGS and BUILD_LDFLAGS can now be passed to menuselect, e.g.,
4050    make BUILD_CFLAGS="whatever" BUILD_LDFLAGS="whatever"
4051
4052  * Remove "asterisk/version.h" in favor of "asterisk/ast_version.h".  If you
4053    previously parsed the header file to obtain the version of Asterisk, you
4054    will now have to go through Asterisk to get the version information.
4055
4056
4057 Applications
4058 -------------------
4059
4060 Bridge
4061 -------------------
4062  * Added 'F()' option. Similar to the dial option, this can be supplied with
4063    arguments indicating where the callee should go after the caller is hung up,
4064    or without options specified, the priority after the Queue will be used.
4065
4066
4067 ConfBridge
4068 -------------------
4069  * Added menu action admin_toggle_mute_participants.  This will mute / unmute
4070    all non-admin participants on a conference.  The confbridge configuration
4071    file also allows for the default sounds played to all conference users when
4072    this occurs to be overriden using sound_participants_unmuted and
4073    sound_participants_muted.
4074
4075  * Added menu action participant_count.  This will playback the number of
4076    current participants in a conference.
4077
4078  * Added announcement configuration option to user profile. If set the sound
4079    file will be played to the user, and only the user, upon joining the
4080    conference bridge.
4081
4082  * Added record_file_append option that defaults to "yes", but if set to no
4083    will create a new file between each start/stop recording.
4084
4085
4086 Dial
4087 -------------------
4088  * Added 'b' and 'B' options to Dial that execute a Gosub on callee and caller
4089    channels respectively before the callee channels are called.
4090
4091
4092 ExternalIVR
4093 -------------------
4094  * Added support for IPv6.
4095
4096  * Add interrupt ('I') command to ExternalIVR.  Sending this command from an
4097    external process will cause the current playlist to be cleared, including
4098    stopping any audio file that is currently playing.  This is useful when you
4099    want to interrupt audio playback only when specific DTMF is entered by the
4100    caller.
4101
4102
4103 FollowMe
4104 -------------------
4105  * A new option, 'I' has been added to app_followme. By setting this option,
4106    Asterisk will not update the caller with connected line changes when they
4107    occur.  This is similar to app_dial and app_queue.
4108
4109  * The 'N' option is now ignored if the call is already answered.
4110
4111  * Added 'b' and 'B' options to FollowMe that execute a Gosub on callee
4112    and caller channels respectively before the callee channels are called.
4113
4114  * The winning FollowMe outgoing call is now put on hold if the caller put it on
4115    hold.
4116
4117
4118 MixMonitor
4119 ------------------
4120  * MixMonitor hooks now have IDs associated with them which can be used to
4121    assign a target to StopMixMonitor. Use of MixMonitor's i(variable) option
4122    will allow storage of the MixMontior ID in a channel variable. StopMixmonitor
4123    now accepts that ID as an argument.
4124
4125  * Added 'm' option, which stores a copy of the recording as a voicemail in the
4126    indicated mailboxes.
4127
4128
4129 MySQL
4130 -------------------
4131  * The connect action in app_mysql now allows you to specify a port number to
4132    connect to.  This is useful if you run a MySQL server on a non-standard
4133    port number.
4134
4135
4136 OSP Applications
4137 -------------------
4138  * Increased the default number of allowed destinations from 5 to 12.
4139
4140
4141 Page
4142 -------------------
4143  * The app_page application now no longer depends on DAHDI or app_meetme.  It
4144    has been re-architected to use app_confbridge internally.
4145
4146
4147 Queue
4148 -------------------
4149  * Added queue options autopausebusy and autopauseunavail for automatically
4150    pausing a queue member when their device reports busy or congestion.
4151
4152  * The 'ignorebusy' option for queue members has been deprecated in favor of
4153    the option 'ringinuse. Also a 'queue set ringinuse' CLI command has been
4154    added as well as an AMI action 'QueueMemberRingInUse' to set this variable on a
4155    per interface basis. Individual ringinuse values can now be set in
4156    queues.conf via an argument to member definitions. Lastly, the queue
4157    'ringinuse' setting now only determines defaults for the per member
4158    'ringinuse' setting and does not override per member settings like it does
4159    in earlier versions.
4160
4161  * Added 'F()' option. Similar to the dial option, this can be supplied with
4162    arguments indicating where the callee should go after the caller is hung up,
4163    or without options specified, the priority after the Queue will be used.
4164
4165  * Added new option log_member_name_as_agent, which will cause the membername to
4166    be logged in the agent field for ADDMEMBER and REMOVEMEMBER queue events if a
4167    state_interface has been set.
4168
4169  * Add queue monitoring hints.  exten => 8501,hint,Queue:markq.
4170
4171  * App_queue will now play periodic announcements for the caller that
4172    holds the first position in the queue while waiting for answer.
4173
4174 SayUnixTime
4175 ------------------
4176  * Added 'j' option to SayUnixTime. SayUnixTime no longer auto jumps to extension
4177    when receiving DTMF.  Use the 'j' option to enable extension jumping. Also
4178    changed arguments to SayUnixTime so that every option is truly optional even
4179    when using multiple options (so that j option could be used without having to
4180    manually specify timezone and format) There are other benefits, e.g., format
4181    can now be used without specifying time zone as well.
4182
4183
4184 Voicemail
4185 ------------------
4186  * Addition of the VM_INFO function - see Function changes.
4187
4188  * The imapserver, imapport, and imapflags configuration options can now be
4189    overriden on a user by user basis.
4190
4191  * When voicemail plays a message's envelope with saycid set to yes, when
4192    reaching the caller id field it will play a recording of a file with the same
4193    base name as the sender's callerid if there is a similarly named file in
4194    <astspooldir>/recordings/callerids/
4195
4196  * Voicemails now contains a unique message identifier "msg_id", which is stored
4197    in the message envelope with the sound files.  IMAP backends will now store
4198    the message identifiers with a header of "X-Asterisk-VM-Message-ID".  ODBC
4199    backends will store the message identifier in a "msg_id" column.  See
4200    UPGRADE.txt for more information.
4201
4202  * Added VoiceMailPlayMsg application.  This application will play a single
4203    voicemail message from a mailbox.  The result of the application, SUCCESS or
4204    FAILED, is stored in the channel variable VOICEMAIL_PLAYBACKSTATUS.
4205
4206
4207 Functions
4208 ------------------
4209  * Hangup handlers can be attached to channels using the CHANNEL() function.
4210    Hangup handlers will run when the channel is hung up similar to the h
4211    extension. The hangup_handler_push option will push a GoSub compatible
4212    location in the dialplan onto the channel's hangup handler stack.  The
4213    hangup_handler_pop option will remove the last added location, and optionally
4214    replace it with a new GoSub compatible location.  The hangup_handler_wipe
4215    option will remove all locations on the stack, and optionally add a new
4216    location.
4217
4218  * The expression parser now recognizes the ABS() absolute value function,
4219    which will convert negative floating point values to positive values.
4220
4221  * FAXOPT(faxdetect) will enable a generic fax detect framehook for dialplan
4222    control of faxdetect.
4223
4224  * Addition of the VM_INFO function that can be used to retrieve voicemail
4225    user information, such as the email address and full name.
4226    The MAILBOX_EXISTS dialplan function has been deprecated in favour of
4227    VM_INFO.
4228
4229  * The REDIRECTING function now supports the redirecting original party id
4230    and reason.
4231
4232  * Two new functions have been added: FEATURE() and FEATUREMAP().  FEATURE()
4233    lets you set some of the configuration options from