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