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