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