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