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