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