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