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