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