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