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