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