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