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