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