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