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