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