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