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