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