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