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