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