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