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