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