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