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