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