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