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