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