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