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