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