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