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