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