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