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