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