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