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