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