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