64e1d19a3d4ae75bd87911c6b9e2fa6bace274d7
[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 12 to Asterisk 13 --------------------
13 ------------------------------------------------------------------------------
14
15 Applications
16 --------------------------
17  * Record application now has an option 'o' which allows 0 to act as an exit
18    key setting the RECORD_STATUS variable to 'OPERATOR' instead of 'DTMF'
19
20 ChanSpy
21 --------------------------
22  * ChanSpy now accepts a channel uniqueid or a fully specified channel name
23    as the chanprefix parameter if the 'u' option is specified.
24
25 ConfBridge
26 --------------------------
27  * CONFBRIDGE dialplan function is now capable of creating/modifying dynamic
28    conference user menus.
29
30  * CONFBRIDGE dialplan function is now capable of removing dynamic conference
31    menus, bridge settings, and user settings that have been applied by the
32    CONFBRIDGE dialplan function.
33
34  * The ConfBridge dialplan application now sets a channel variable,
35    CONFBRIGE_RESULT, upon exiting. This variable can be used to determine
36    how a channel exited the conference.
37
38  * Added conference user option 'announce_join_leave_review'. This option
39    implies 'announce_join_leave' with the added effect that the user will
40    be asked if they want to confirm or re-record the recording of their
41    name when entering the conference
42
43 Directory
44 --------------------------
45  * At exit, the Directory application now sets a channel variable
46    DIRECTORY_RESULT to one of the following based on the reason for exiting:
47      OPERATOR    user requested operator by pressing '0' for operator
48      ASSISTANT   user requested assistant by pressing '*' for assistant
49      TIMEOUT     user pressed nothing and Directory stopped waiting
50      HANGUP      user's channel hung up
51      SELECTED    user selected a user from the directory and is routed
52      USEREXIT    user pressed '#' from the selection prompt to exit
53      FAILED      directory failed in a way that wasn't accounted for. Dang.
54
55 MusicOnHold
56 --------------------------
57  * MusicOnHold streams (all modes other than "files") now support wide band
58    audio too.
59
60 Page
61 --------------------------
62  * Added options 'b' and 'B' to apply predial handlers for outgoing calls
63    and for the channel executing Page respectively.
64
65 PickupChan
66 --------------------------
67  * PickupChan now accepts channel uniqueids of channels to pickup.
68
69 Say
70 --------------------------
71  * If a channel variable SAY_DTMF_INTERRUPT is present on a channel and set
72    to 'true' (case insensitive), then any Say application (SayNumber,
73    SayDigits, SayAlpha, SayAlphaCase, SayUnixTime, and SayCounted) will
74    anticipate DTMF. If DTMF is received, these applications will behave like
75    the background application and jump to the received extension once a match
76    is established or after a short period of inactivity.
77
78 MixMonitor
79 -------------------------
80  * A new function, MIXMONITOR, has been added to allow access to individual
81    instances of MixMonitor on a channel.
82
83 Debugging
84 -------------------------
85  * Core Show Locks output now includes Thread/LWP ID if the platform
86    supports this feature.
87  * New "logger add channel" and "logger remove channel" CLI commands have
88    been added to allow creation and deletion of dynamic logger channels
89    without configuration changes. These dynamic logger channels will only
90    exist until the next restart of asterisk.
91
92 ------------------------------------------------------------------------------
93 --- Functionality changes from Asterisk 12.1.0 to Asterisk 12.2.0 ------------
94 ------------------------------------------------------------------------------
95
96 ARI
97 ------------------
98  * The live recording object on recording events now contains a target_uri
99    field which contains the URI of what is being recorded.
100
101 Core
102 ------------------
103  * Exposed sorcery-based configuration files like pjsip.conf to dialplans via
104    the new AST_SORCERY diaplan function.
105
106  * A channelId can now be provided when creating a channel, either in the
107    uri (POST channels/my-channel-id) or as query parameter.  A local channel
108    will suffix the second channel id with ';2' unless provided as query
109    parameter otherChannelId.
110
111  * A bridgeId can now be provided when creating a bridge, either in the uri
112    (POST bridges/my-bridge-id) or as a query parameter.
113
114  * A playbackId can be provided when starting a playback, either in the uri
115    (POST channels/my-channel-id/play/my-playback-id) or as a query parameter.
116
117  * A snoop channel can be started with a snoopId, in the uri or query.
118
119 AMI
120 ------------------
121  * Originate now takes optional parameters ChannelId and OtherChannelId,
122    used to set the UniqueId on creation.  The other id is assigned to the
123    second channel when dialing LOCAL, or defaults to appending ;2 if only
124    the single Id is given.
125
126 res_pjsip
127 ------------------
128  * transport and endpoint ToS options (tos, tos_audio, and tos_video) may now
129    be set as the named set of ToS values (cs0-cs7, af11-af43, ef).
130
131 ------------------------------------------------------------------------------
132 --- Functionality changes from Asterisk 12.0.0 to Asterisk 12.1.0 ------------
133 ------------------------------------------------------------------------------
134
135 AMI
136 ------------------
137  * Added a new module that provides AMI control over MWI within Asterisk,
138    res_mwi_external_ami. Note that this module depends on res_mwi_external;
139    for more information on enabling this module, see res_mwi_external.
140    This module provides the MWIGet/MWIUpdate/MWIDelete actions, as well as
141    the MWIGet/MWIGetComplete events.
142
143  * The DialStatus field in the DialEnd event can now contain additional
144    statuses that convey how the dial operation terminated. This includes
145    ABORT, CONTINUE, and GOTO.
146
147  * AMI will now emit security events. A new class authorization has been
148    added in manager.conf for the security events, 'security'. The new events
149    are:
150     - FailedACL - raised when a request violates an ACL check
151     - InvalidAccountID - raised when a request fails an authentication
152       check due to an invalid account ID
153     - SessionLimit - raised when a request fails due to exceeding the
154       number of allowed concurrent sessions for a service
155     - MemoryLimit - raised when a request fails due to an internal memory
156       allocation failure
157     - LoadAverageLimit - raised when a request fails because a configured
158       load average limit has been reached
159     - RequestNotAllowed - raised when a request is not allowed by
160       the service
161     - AuthMethodNotAllowed - raised when a request used an authentication
162       method not allowed by the service
163     - RequestBadFormat - raised when a request is received with bad formatting
164     - SuccessfulAuth - raised when a request successfully authenticates
165     - UnexpectedAddress - raised when a request has a different source address
166       then what is expected for a session already in progress with a service
167     - ChallengeResponseFailed - raised when a request's attempt to authenticate
168       has been challenged, and the request failed the authentication challenge
169     - InvalidPassword - raised when a request provides an invalid password
170       during an authentication attempt
171     - ChallengeSent - raised when an Asterisk service send an authentication
172       challenge to a request
173     - InvalidTransport - raised when a request attempts to use a transport not
174       allowed by the Asterisk service
175
176  * Bridge related events now have two additional fields: BridgeName and
177    BridgeCreator. BridgeName is a descriptive name for the bridge;
178    BridgeCreator is the name of the entity that created the bridge. This
179    affects the following events: ConfbridgeStart, ConfbridgeEnd,
180    ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
181    ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
182    AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
183
184 ARI
185 ------------------
186  * The Bridge data model now contains the additional fields 'name' and
187    'creator'. The 'name' field conveys a descriptive name for the bridge;
188    the 'creator' field conveys the name of the entity that created the bridge.
189    This affects all responses to HTTP requests that return a Bridge data model
190    as well as all event derived data models that contain a Bridge data model.
191    The POST /bridges operation may now optionally specify a name to give to
192    the bridge being created.
193
194  * Added a new ARI resource 'mailboxes' which allows the creation and
195    modification of mailboxes managed by external MWI. Modules res_mwi_external
196    and res_stasis_mailbox must be enabled to use this resource. For more
197    information on external MWI control, see res_mwi_external.
198
199  * Added new events for externally initiated transfers. The event
200    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
201    of a bridge in the ARI controlled application to the dialplan; the
202    BridgeAttendedTransfer event is raised when a channel initiates an
203    attended transfer of a bridge in the ARI controlled application to the
204    dialplan.
205
206  * Channel variables may now be specified as a body parameter to the
207    POST /channels operation. The 'variables' key in the JSON is interpreted
208    as a sequence of key/value pairs that will be added to the created channel
209    as channel variables. Other parameters in the JSON body are treated as
210    query parameters of the same name.
211
212 HTTP
213 ------------------
214  * Asterisk's HTTP server now supports chunked Transfer-Encoding. This will be
215    automatically handled by the HTTP server if a request is received with a
216    Transfer-Encoding type of "chunked".
217
218 res_pjsip
219 ------------------
220  * Path support has been added with the 'support_path' option in registration
221    and aor sections.
222
223  * A 'debug' option has been added to the globals section that will allow
224    sip messages to be logged.
225
226  * A 'set_var' option has been added to endpoints that will automatically
227    set the desired variable(s) on a channel created for that endpoint.
228
229  * Several new tables and columns have been added to the realtime schema for
230    the res_pjsip related modules. See the UPGRADE.txt notes for updating
231    the database schema.
232
233 res_mwi_external
234 ------------------
235  * A new module, res_mwi_external, has been added to Asterisk. This module
236    acts as a base framework that other modules can build on top of to allow
237    an external system to control MWI within Asterisk. For implementations
238    that make use of res_mwi_external, see res_mwi_external_ami and
239    res_ari_mailboxes. Note that res_mwi_external canflicts with other modules
240    that may produce MWI themselves, such as app_voicemail. res_mwi_external
241    and other modules that depend on it cannot be built or loaded with
242    app_voicemail present.
243
244
245 ------------------------------------------------------------------------------
246 --- Functionality changes from Asterisk 11 to Asterisk 12 --------------------
247 ------------------------------------------------------------------------------
248
249 Overview
250 ------------------
251
252 Asterisk 12 is a standard release of the Asterisk project. As such, the
253 focus of development for this release was on core architectural changes and
254 major new features. This includes:
255  * A more flexible bridging core based on the Bridging API
256  * A new internal message bus, Stasis
257  * Major standardization and consistency improvements to AMI
258  * Addition of the Asterisk RESTful Interface (ARI)
259  * A new SIP channel driver, chan_pjsip
260 In addition, as the vast majority of bridging in Asterisk was migrated to the
261 Bridging API used by ConfBridge, major changes were made to most of the
262 interfaces in Asterisk. This includes not only AMI, but also CDRs and CEL.
263
264 Specifications have been written for the affected interfaces. These
265 specifications are available on the Asterisk wiki:
266  * AMI - https://wiki.asterisk.org/wiki/x/dAFRAQ
267  * CEL - https://wiki.asterisk.org/wiki/x/4ICLAQ
268  * CDRs - https://wiki.asterisk.org/wiki/x/pwpRAQ
269
270 It is *highly* recommended that anyone migrating to Asterisk 12 read the
271 information regarding its release both in this file and in the accompanying
272 UPGRADE.txt file. More detailed information on the major changes can be found
273 on the Asterisk wiki at https://wiki.asterisk.org/wiki/x/0YCLAQ.
274
275
276 Build System
277 ------------------
278  * Added build option DISABLE_INLINE. This option can be used to work around a
279    bug in gcc. For more information, see
280    http://gcc.gnu.org/bugzilla/show_bug.cgi?id=47816
281
282  * Removed the CHANNEL_TRACE development mode build option. Certain aspects of
283    the CHANNEL_TRACE build option were incompatible with the new bridging
284    architecture.
285
286  * Asterisk now optionally uses libxslt to improve XML documentation generation
287    and maintainability. If libxslt is not available on the system, some XML
288    documentation will be incomplete.
289
290  * Asterisk now depends on libjansson. If a package of libjansson is not
291    available on your distro, please see http://www.digip.org/jansson/.
292
293  * Asterisk now depends on libuuid and, optionally, uriparser. It is
294    recommended that you install uriparser, even if it is optional.
295
296  * The new SIP stack and channel driver uses a particular version of PJSIP.
297    Please see https://wiki.asterisk.org/wiki/x/J4GLAQ for more information on
298    configuring and installing PJSIP for usage with Asterisk.
299
300  * Optional API was re-implemented to be more portable, and no longer requires
301    weak reference support from the compiler. The build option OPTIONAL_API may
302    be disabled to disable Optional API support.
303
304 Applications
305 ------------------
306
307 AgentLogin
308 ------------------
309  * Along with AgentRequest, this application has been modified to be a
310    replacement for chan_agent. The act of a channel calling the AgentLogin
311    application places the channel into a pool of agents that can be
312    requested by the AgentRequest application. Note that this application, as
313    well as all other agent related functionality, is now provided by the
314    app_agent_pool module. See chan_agent and AgentRequest for more information.
315
316  * This application no longer performs agent authentication. If authentication
317    is desired, the dialplan needs to perform this function using the
318    Authenticate or VMAuthenticate application or through an AGI script before
319    running AgentLogin.
320
321  * If this application is called and the agent is already logged in, the
322    dialplan will continue exection with the AGENT_STATUS channel variable set
323    to ALREADY_LOGGED_IN.
324
325  * The agents.conf schema has changed. Rather than specifying agents on a
326    single line in comma delineated fashion, each agent is defined in a separate
327    context. This allows agents to use the power of context templates in their
328    definition.
329
330  * A number of parameters from agents.conf have been removed. This includes
331    maxloginretries, autologoffunavail, updatecdr, goodbye, group, recordformat,
332    urlprefix, and savecallsin. These options were obsoleted by the move from
333    a channel driver model to the bridging/application model provided by
334    app_agent_pool.
335
336 AgentRequest
337 ------------------
338  * A new application, this will request a logged in agent from the pool and
339    bridge the requested channel with the channel calling this application.
340    Logged in agents are those channels that called the AgentLogin application.
341    If an agent cannot be requested from the pool, the AGENT_STATUS dialplan
342    application will be set with an appropriate error value.
343
344 AgentMonitorOutgoing
345 ------------------
346  * This application has been removed. It was a holdover from when
347    AgentCallbackLogin was removed.
348
349 AlarmReceiver
350 ------------------
351  * Added support for additional Ademco DTMF signalling formats, including
352    Express 4+1, Express 4+2, High Speed and Super Fast.
353
354  * Added channel variable ALARMRECEIVER_CALL_LIMIT. This sets the maximum
355    call time, in milliseconds, to run the application.
356
357  * Added channel variable ALARMRECEIVER_RETRIES_LIMIT. This sets the
358    maximum number of times to retry the call.
359
360  * Added a new configuration option answait. If set, the AlarmReceiver
361    application will wait the number of milliseconds specified by answait
362    after the channel has answered. Valid values range between 500
363    milliseconds and 10000 milliseconds.
364
365  * Added configuration option no_group_meta. If enabled, grouping of metadata
366    information in the AlarmReceiver log file will be skipped.
367
368 Answer
369 ------------------
370  * It is now no longer possible to bypass updating the CDR on the channel
371    when answering. CDRs reflect the state of the channel and will always
372    reflect the time they were Answered.
373
374 BridgeWait
375 ------------------
376  * A new application in Asterisk, this will place the calling channel
377    into a holding bridge, optionally entertaining them with some form of
378    media. Channels participating in a holding bridge do not interact with
379    other channels in the same holding bridge. Optionally, however, a channel
380    may join as an announcer. Any media passed from an announcer channel is
381    played to all channels in the holding bridge. Channels leave a holding
382    bridge either when an optional timer expires, or via the ChannelRedirect
383    application or AMI Redirect action.
384
385 ConfBridge
386 ------------------
387  * All participants in a bridge can now be kicked out of a conference room
388    by specifying the channel parameter as 'all' in the ConfBridge kick CLI
389    command, i.e., 'confbridge kick <conference> all'
390
391  * CLI output for the 'confbridge list' command has been improved. When
392    displaying information about a particular bridge, flags will now be shown
393    for the participating users indicating properties of that user.
394
395  * The ConfbridgeList event now contains the following fields: WaitMarked,
396    EndMarked, and Waiting. This displays additional properties about the
397    user's profile, as well as whether or not the user is waiting for a
398    Marked user to enter the conference.
399
400  * Added a new option for conference recording, record_file_append. If enabled,
401    when the recording is stopped and then re-started, the existing recording
402    will be used and appended to.
403
404  * ConfBridge now has the ability to set the language of announcements to the
405    conference.  The language can be set on a bridge profile in confbridge.conf
406    or by the dialplan function CONFBRIDGE(bridge,language)=en.
407
408 ControlPlayback
409 ------------------
410  * The channel variable CPLAYBACKSTATUS may now return the value
411    'REMOTESTOPPED'. This occurs when playback is stopped by a remote interface,
412    such as AMI. See the AMI action ControlPlayback for more information.
413
414 Directory
415 ------------------
416  * Added the 'a' option, which allows the caller to enter in an additional
417    alias for the user in the directory. This option must be used in conjunction
418    with the 'f', 'l', or 'b' options. Note that the alias for a user can be
419    specified in voicemail.conf.
420
421 DumpChan
422 ------------------
423  * The output of DumpChan no longer includes the DirectBridge or IndirectBridge
424    fields. Instead, if a channel is in a bridge, it includes a BridgeID field
425    containing the unique ID of the bridge that the channel happens to be in.
426
427 ForkCDR
428 ------------------
429  * ForkCDR no longer automatically resets the forked CDR. See the 'r' option
430    for more information.
431
432  * Variables are no longer purged from the original CDR. See the 'v' option for
433    more information.
434
435  * The 'A' option has been removed. The Answer time on a CDR is never updated
436    once set.
437
438  * The 'd' option has been removed. The disposition on a CDR is a function of
439    the state of the channel and cannot be altered.
440
441  * The 'D' option has been removed. Who the Party B is on a CDR is a function
442    of the state of the respective channels involved in the CDR and cannot be
443    altered.
444
445  * The 'r' option has been changed. Previously, ForkCDR always reset the CDR
446    such that the start time and, if applicable, the answer time was updated.
447    Now, by default, ForkCDR simply forks the CDR, maintaining any times. The
448    'r' option now triggers the Reset, setting the start time (and answer time
449    if applicable) to the current time. Note that the 'a' option still sets
450    the answer time to the current time if the channel was already answered.
451
452  * The 's' option has been removed. A variable can be set on the original CDR
453    if desired using the CDR function, and removed from a forked CDR using the
454    same function.
455
456  * The 'T' option has been removed. The concept of DONT_TOUCH and LOCKED no
457    longer applies in the CDR engine.
458
459  * The 'v' option now prevents the copy of the variables from the original CDR
460    to the forked CDR. Previously the variables were always copied but were
461    removed from the original. This was changed as removing variables from a CDR
462    can have unintended side effects - this option allows the user to prevent
463    propagation of variables from the original to the forked without modifying
464    the original.
465
466 MeetMe
467 -------------------
468  * Added the 'n' option to MeetMe to prevent application of the DENOISE
469    function to a channel joining a conference. Some channel drivers that vary
470    the number of audio samples in a voice frame will experience significant
471    quality problems if a denoiser is attached to the channel; this option gives
472    them the ability to remove the denoiser without having to unload func_speex.
473
474 MixMonitor
475 ------------------
476  * The 'b' option now includes conferences as well as sounds played to the
477    participants.
478
479  * The AUDIOHOOK_INHERIT function is no longer needed to keep a MixMonitor
480    running during a transfer. If a MixMonitor is started on a channel,
481    the MixMonitor will continue to record the audio passing through the
482    channel even in the presence of transfers.
483
484 NoCDR
485 ------------------
486  * The NoCDR application is deprecated. Please use the CDR_PROP function to
487    disable CDRs.
488
489  * While the NoCDR application will prevent CDRs for a channel from being
490    propagated to registered CDR backends, it will not prevent that data from
491    being collected. Hence, a subsequent call to ResetCDR or the CDR_PROP
492    function that enables CDRs on a channel will restore those records that have
493    not yet been finalized.
494
495 ParkAndAnnounce
496 -------------------
497  * The app_parkandannounce module has been removed. The application
498    ParkAndAnnounce is now provided by the res_parking module. See the
499    res_parking changes for more information.
500
501 Queue
502 -------------------
503  * Added queue available hint. The hint can be added to the dialplan using the
504    following syntax: exten,hint,Queue:{queue_name}_avail
505    For example, if the name of the queue is 'markq':
506         exten => 8501,hint,Queue:markq_avail
507    This will report 'InUse' if there are no logged in agents or no free agents.
508    It will report 'Idle' when an agent is free.
509
510  * Queues now support a hint for member paused state. The hint uses the form
511    'Queue:{queue_name}_pause_{member_name}', where {queue_name} and {member_name}
512    are the name of the queue and the name of the member to subscribe to,
513    respectively. For example: exten => 8501,hint,Queue:sales_pause_mark.
514    Members will show as In Use when paused.
515
516  * The configuration options eventwhencalled and eventmemberstatus have been
517    removed.  As a result, the AMI events QueueMemberStatus, AgentCalled,
518    AgentConnect, AgentComplete, AgentDump, and AgentRingNoAnswer will always be
519    sent.  The "Variable" fields will also no longer exist on the Agent* events.
520    These events can be filtered out from a connected AMI client using the
521    eventfilter setting in manager.conf.
522
523  * The queue log now differentiates between blind and attended transfers. A
524    blind transfer will result in a BLINDTRANSFER message with the destination
525    context and extension. An attended transfer will result in an
526    ATTENDEDTRANSFER message. This message will indicate the method by which
527    the attended transfer was completed: "BRIDGE" for a bridge merge, "APP"
528    for running an application on a bridge or channel, or "LINK" for linking
529    two bridges together with local channels. The queue log will also now detect
530    externally initiated blind and attended transfers and record the transfer
531    status accordingly.
532
533  * When performing queue pause/unpause on an interface without specifying an
534    individual queue, the PAUSEALL/UNPAUSEALL event will only be logged if at
535    least one member of any queue exists for that interface.
536
537  * Added the 'queue_log_realtime_use_gmt' option to have timestamps in GMT
538    for realtime queue log entries.
539
540 ResetCDR
541 ------------------
542  * The 'e' option has been deprecated. Use the CDR_PROP function to re-enable
543    CDRs when they were previously disabled on a channel.
544
545  * The 'w' and 'a' options have been removed. Dispatching CDRs to registered
546    backends occurs on an as-needed basis in order to preserve linkedid
547    propagation and other needed behavior.
548
549 SayAlphaCase
550 ------------------
551  * A new application, this is similar to SayAlpha except that it supports
552    case sensitive playback of the specified characters. For example,
553    SayAlphaCase(u,aBc) will result in 'a uppercase b c'.
554
555 SetAMAFlags
556 ------------------
557  * This application is deprecated in favor of CHANNEL(amaflags).
558
559 SendDTMF
560 ------------------
561  * The SendDTMF application will now accept 'W' as valid input. This will cause
562    the application to delay one second while streaming DTMF.
563
564 Stasis
565 ------------------
566  * A new application in Asterisk 12, this hands control of the channel calling
567    the application over to an external system. Currently, external systems
568    manipulate channels in Stasis through the Asterisk RESTful Interface (ARI).
569
570 UserEvent
571 ------------------
572  * UserEvent will now handle duplicate keys by overwriting the previous value
573    assigned to the key.
574
575  * In addition to AMI, UserEvent invocations will now be distributed to any
576    interested Stasis applications.
577
578 VoiceMail
579 ------------------
580  * Mailboxes defined by app_voicemail MUST be referenced by the rest of the
581    system as mailbox@context.  The rest of the system cannot add @default
582    to mailbox identifiers for app_voicemail that do not specify a context
583    any longer.  It is a mailbox identifier format that should only be
584    interpreted by app_voicemail.
585
586  * The voicemail.conf configuration file now has an 'alias' configuration
587    parameter for use with the Directory application. The voicemail realtime
588    database table schema has also been updated with an 'alias' column.
589
590
591 Codecs
592 ------------------
593  * Pass through support has been added for both VP8 and Opus.
594
595  * Added format attribute negotiation for the Opus codec. Format attribute
596    negotiation is provided by the res_format_attr_opus module.
597
598
599 Core
600 ------------------
601  * Masquerades as an operation inside Asterisk have been effectively hidden
602    by the migration to the Bridging API. As such, many 'quirks' of Asterisk
603    no longer occur. This includes renaming of channels, "<ZOMBIE>" channels,
604    dropping of frame/audio hooks, and other internal implementation details
605    that users had to deal with. This fundamental change has large implications
606    throughout the changes documented for this version. For more information
607    about the new core architecture of Asterisk, please see the Asterisk wiki.
608
609  * Multiple parties in a bridge may now be transferred. If a participant in a
610    multi-party bridge initiates a blind transfer, a Local channel will be used
611    to execute the dialplan location that the transferer sent the parties to. If
612    a participant in a multi-party bridge initiates an attended transfer,
613    several options are possible. If the attended transfer results in a transfer
614    to an application, a Local channel is used. If the attended transfer results
615    in a transfer to another channel, the resulting channels will be merged into
616    a single bridge.
617
618  * The channel variable ATTENDED_TRANSFER_COMPLETE_SOUND is no longer channel
619    driver specific.  If the channel variable is set on the transferrer channel,
620    the sound will be played to the target of an attended transfer.
621
622  * The channel variable BRIDGEPEER becomes a comma separated list of peers in
623    a multi-party bridge.  The BRIDGEPEER value can have a maximum of 10 peers
624    listed.  Any more peers in the bridge will not be included in the list.
625    BRIDGEPEER is not valid in holding bridges like parking since those channels
626    do not talk to each other even though they are in a bridge.
627
628  * The channel variable BRIDGEPVTCALLID is only valid for two party bridges
629    and will contain a value if the BRIDGEPEER's channel driver supports it.
630
631  * A channel variable ATTENDEDTRANSFER is now set which indicates which channel
632    was responsible for an attended transfer in a similar fashion to
633    BLINDTRANSFER.
634
635  * Modules using the Configuration Framework or Sorcery must have XML
636    configuration documentation. This configuration documentation is included
637    with the rest of Asterisk's XML documentation, and is accessible via CLI
638    commands. See the CLI changes for more information.
639
640 AMI (Asterisk Manager Interface)
641 ------------------
642  * Major changes were made to both the syntax as well as the semantics of the
643    AMI protocol. In particular, AMI events have been substantially improved
644    in this version of Asterisk. For more information, please see the AMI
645    specification at https://wiki.asterisk.org/wiki/x/dAFRAQ
646
647  * AMI events that reference a particular channel or bridge will now always
648    contain a standard set of fields. When multiple channels or bridges are
649    referenced in an event, fields for at least some subset of the channels
650    and bridges in the event will be prefixed with a descriptive name to avoid
651    name collisions. See the AMI event documentation on the Asterisk wiki for
652    more information.
653
654  * The CLI command 'manager show commands' no longer truncates command names
655    longer than 15 characters and no longer shows authorization requirement
656    for commands. 'manager show command' now displays the privileges needed
657    for using a given manager command instead.
658
659  * The SIPshowpeer action will now include a 'SubscribeContext' field for a
660    peer in its response if the peer has a subscribe context set.
661
662  * The SIPqualifypeer action now acknowledges the request once it has
663    established that the request is against a known peer. It also issues a new
664    event, 'SIPQualifyPeerDone', once the qualify action has been completed.
665
666  * The PlayDTMF action now supports an optional 'Duration' parameter.  This
667    specifies the duration of the digit to be played, in milliseconds.
668
669  * Added VoicemailRefresh action to allow an external entity to trigger mailbox
670    updates when changes occur instead of requiring the use of pollmailboxes.
671
672  * Added a new action 'ControlPlayback'. The ControlPlayback action allows an
673    AMI client to manipulate audio currently being played back on a channel. The
674    supported operations depend on the application being used to send audio to
675    the channel. When the audio playback was initiated using the ControlPlayback
676    application or CONTROL STREAM FILE AGI command, the audio can be paused,
677    stopped, restarted, reversed, or skipped forward. When initiated by other
678    mechanisms (such as the Playback application), the audio can be stopped,
679    reversed, or skipped forward.
680
681  * Channel related events now contain a snapshot of channel state, adding new
682    fields to many of these events.
683
684  * The AMI event 'Newexten' field 'Extension' is deprecated, and may be removed
685    in a future release. Please use the common 'Exten' field instead.
686
687  * The AMI event 'UserEvent' from app_userevent now contains the channel state
688    fields. The channel state fields will come before the body fields.
689
690  * The AMI events 'ParkedCall', 'ParkedCallTimeOut', 'ParkedCallGiveUp', and
691    'UnParkedCall' have changed significantly in the new res_parking module.
692
693    The 'Channel' and 'From' headers are gone. For the channel that was parked
694    or is coming out of parking, a 'Parkee' channel snapshot is issued and it
695    has a number of fields associated with it. The old 'Channel' header relayed
696    the same data as the new 'ParkeeChannel' header.
697
698    The 'From' field was ambiguous and changed meaning depending on the event.
699    for most of these, it was the name of the channel that parked the call
700    (the 'Parker'). There is no longer a header that provides this channel name,
701    however the 'ParkerDialString' will contain a dialstring to redial the
702    device that parked the call.
703
704    On UnParkedCall events, the 'From' header would instead represent the
705    channel responsible for retrieving the parkee. It receives a channel
706    snapshot labeled 'Retriever'. The 'from' field is is replaced with
707    'RetrieverChannel'.
708
709    Lastly, the 'Exten' field has been replaced with 'ParkingSpace'.
710
711  * The AMI event 'Parkinglot' (response to 'Parkinglots' command) in a similar
712    fashion has changed the field names 'StartExten' and 'StopExten' to
713    'StartSpace' and 'StopSpace' respectively.
714
715  * The deprecated use of | (pipe) as a separator in the channelvars setting in
716    manager.conf has been removed.
717
718  * Channel Variables conveyed with a channel no longer contain the name of the
719    channel as part of the key field, i.e., ChanVariable(SIP/foo): bar=baz is now
720    ChanVariable: bar=baz. When multiple channels are present in a single AMI
721    event, the various ChanVariable fields will contain a suffix that specifies
722    which channel they correspond to.
723
724  * The NewPeerAccount AMI event is no longer raised. The NewAccountCode AMI
725    event always conveys the AMI event for a particular channel.
726
727  * All 'Reload' events have been consolidated into a single event type. This
728    event will always contain a Module field specifying the name of the module
729    and a Status field denoting the result of the reload. All modules now issue
730    this event when being reloaded.
731
732  * The 'ModuleLoadReport' event has been removed. Most AMI connections would
733    fail to receive this event due to being connected after modules have loaded.
734    AMI connections that want to know when Asterisk is ready should listen for
735    the 'FullyBooted' event.
736
737  * app_fax now sends the same send fax/receive fax events as res_fax. The
738    'FaxSent' event is now the 'SendFAX' event, and the 'FaxReceived' event is
739    now the 'ReceiveFAX' event.
740
741  * The 'MusicOnHold' event is now two events: 'MusicOnHoldStart' and
742    'MusicOnHoldStop'. The sub type field has been removed.
743
744  * The 'JabberEvent' event has been removed. It is not AMI's purpose to be a
745    carrier for another protocol.
746
747  * The Bridge Manager action's 'Playtone' header now accepts more fine-grained
748    options. 'Channel1' and 'Channel2' may be specified in order to play a tone
749    to the specific channel. 'Both' may be specified to play a tone to both
750    channels. The old 'yes' option is still accepted as a way of playing the
751    tone to Channel2 only.
752
753  * The AMI 'Status' response event to the AMI Status action replaces the
754    'BridgedChannel' and 'BridgedUniqueid' headers with the 'BridgeID' header to
755    indicate what bridge the channel is currently in.
756
757  * The AMI 'Hold' event has been moved out of individual channel drivers, into
758    core, and is now two events: 'Hold' and 'Unhold'.  The status field has been
759    removed.
760
761  * The AMI events in app_queue have been made more consistent with each other.
762    Events that reference channels (QueueCaller* and Agent*) will show
763    information about each channel.  The (infamous) 'Join' and 'Leave' AMI
764    events have been changed to 'QueueCallerJoin' and 'QueueCallerLeave'.
765
766  * The 'MCID' AMI event now publishes a channel snapshot when available and
767    its non-channel-snapshot parameters now use either the "MCallerID" or
768    'MConnectedID' prefixes with Subaddr*, Name*, and Num* suffixes instead
769    of 'CallerID' and 'ConnectedID' to avoid confusion with similarly named
770    parameters in the channel snapshot.
771
772  * The AMI events 'Agentlogin' and 'Agentlogoff' have been renamed
773    'AgentLogin' and 'AgentLogoff' respectively.
774
775  * The 'Channel' key used in the 'AlarmClear', 'Alarm', and 'DNDState' has been
776    renamed "DAHDIChannel" since it does not convey an Asterisk channel name.
777
778  * 'ChannelUpdate' events have been removed.
779
780  * All AMI events now contain a 'SystemName' field, if available.
781
782  * Local channel optimization is now conveyed in two events:
783    'LocalOptimizationBegin' and 'LocalOptimizationEnd'. The Begin event is sent
784    when the Local channel driver begins attempting to optimize itself out of
785    the media path; the End event is sent after the channel halves have
786    successfully optimized themselves out of the media path.
787
788  * Local channel information in events is now prefixed with 'LocalOne' and
789    'LocalTwo'. This replaces the suffix of '1' and '2' for the two halves of
790    the Local channel. This affects the 'LocalBridge', 'LocalOptimizationBegin',
791    and 'LocalOptimizationEnd' events.
792
793  * The option 'allowmultiplelogin' can now be set or overriden in a particular
794    account. When set in the general context, it will act as the default
795    setting for defined accounts.
796
797  * The 'BridgeAction' event was removed. It technically added no value, as the
798    Bridge Action already receives confirmation of the bridge through a
799    successful completion Event.
800
801  * The 'BridgeExec' events were removed. These events duplicated the events that
802    occur in the Briding API, and are conveyed now through BridgeCreate,
803    BridgeEnter, and BridgeLeave events.
804
805  * The 'RTCPSent'/'RTCPReceived' events have been significantly modified from
806    previous versions. They now report all SR/RR packets sent/received, and
807    have been restructured to better reflect the data sent in a SR/RR. In
808    particular, the event structure now supports multiple report blocks.
809
810  * Added 'BlindTransfer' and 'AttendedTransfer' events. These events are
811    raised when a blind transfer/attended transfer completes successfully.
812    They contain information about the transfer that just completed, including
813    the location of the transfered channel.
814
815  * Added a 'security' class to AMI which outputs the required fields for
816    security messages similar to the log messages from res_security_log
817
818  * The AMI event 'ExtensionStatus' now contains a 'StatusText' field
819    that describes the status value in a human readable string.
820
821 CDR (Call Detail Records)
822 ------------------
823  * Significant changes have been made to the behavior of CDRs. The CDR engine
824    was effectively rewritten and built on the Stasis message bus. For a full
825    definition of CDR behavior in Asterisk 12, please read the specification
826    on the Asterisk wiki (wiki.asterisk.org).
827
828  * CDRs will now be created between all participants in a bridge. For each
829    pair of channels in a bridge, a CDR is created to represent the path of
830    communication between those two endpoints. This lets an end user choose who
831    to bill for what during bridge operations with multiple parties.
832
833  * The duration, billsec, start, answer, and end times now reflect the times
834    associated with the current CDR for the channel, as opposed to a cumulative
835    measurement of all CDRs for that channel.
836
837  * When a CDR is dispatched, user defined CDR variables from both parties are
838    included in the resulting CDR. If both parties have the same variable, only
839    the Party A value is provided.
840
841  * Added a new option to cdr.conf, 'debug'. When enabled, significantly more
842    information regarding the CDR engine is logged as verbose messages. This
843    option should only be used if the behavior of the CDR engine needs to be
844    debugged.
845
846  * Added CLI command 'cdr set debug {on|off}'. This toggles the 'debug' setting
847    normally configured in cdr.conf.
848
849  * Added CLI command 'cdr show active {channel}'. When {channel} is not
850    specified, this command provides a summary of the channels with CDR
851    information and their statistics. When {channel} is specified, it shows
852    detailed information about all records associated with {channel}.
853
854 CEL (Channel Event Logging)
855 ------------------
856  * CEL has undergone significant rework in Asterisk 12, and is now built on the
857    Stasis message bus. Please see the specification for CEL on the Asterisk
858    wiki at https://wiki.asterisk.org/wiki/x/4ICLAQ for more detailed
859    information.
860
861  * The 'extra' field of all CEL events that use it now consists of a JSON blob
862    with key/value pairs which are defined in the Asterisk 12 CEL documentation.
863
864  * BLINDTRANSFER events now report the transferee bridge unique
865    identifier, extension, and context in a JSON blob as the extra string
866    instead of the transferee channel name as the peer.
867
868  * ATTENDEDTRANSFER events now report the peer as NULL and additional
869    information in the 'extra' string as a JSON blob. For transfers that occur
870    between two bridged channels, the 'extra' JSON blob contains the primary
871    bridge unique identifier, the secondary channel name, and the secondary
872    bridge unique identifier. For transfers that occur between a bridged channel
873    and a channel running an app, the 'extra' JSON blob contains the primary
874    bridge unique identifier, the secondary channel name, and the app name.
875
876  * LOCAL_OPTIMIZE events have been added to convey local channel
877    optimizations with the record occurring for the semi-one channel and
878    the semi-two channel name in the peer field.
879
880  * BRIDGE_START, BRIDGE_END, BRIDGE_UPDATE, 3WAY_START, 3WAY_END, CONF_ENTER,
881    CONF_EXIT, CONF_START, and CONF_END events have all been removed. These
882    events have been replaced by BRIDGE_ENTER/BRIDGE_EXIT. The BRIDGE_ENTER
883    and BRIDGE_EXIT events are raised when a channel enters/exits any bridge,
884    regardless of whether or not that bridge happens to contain multiple
885    parties.
886
887 CLI
888 -------------------
889  * When compiled with '--enable-dev-mode', the astobj2 library will now add
890    several CLI commands that allow for inspection of ao2 containers that
891    register themselves with astobj2. The CLI commands are 'astobj2 container
892    dump', 'astobj2 container stats', and 'astobj2 container check'.
893
894  * Added specific CLI commands for bridge inspection. This includes 'bridge
895    show all', which lists all bridges in the system, and 'bridge show {id}',
896    which provides specific information about a bridge.
897
898  * Added CLI command 'bridge destroy'. This will destroy the specified bridge,
899    ejecting the channels currently in the bridge. If the channels cannot
900    continue in the dialplan or application that put them in the bridge, they
901    will be hung up.
902
903  * Added command 'bridge kick'. This will eject a single channel from a bridge.
904
905  * Added commands to inspect and manipulate the registered bridge technologies.
906    This include 'bridge technology show', which lists the registered bridge
907    technologies, as well as 'bridge technology {suspend|unsuspend} {tech}',
908    which controls whether or not a registered bridge technology can be used
909    during smart bridge operations. If a technology is suspended, it will not
910    be used when a bridge technology is picked for channels; when unsuspended,
911    it can be used again.
912
913  * The command 'config show help {module} {type} {option}' will show
914    configuration documentation for modules with XML configuration
915    documentation. When {module}, {type}, and {option} are omitted, a listing
916    of all modules with registered documentation is displayed. When {module}
917    is specified, a listing of all configuration types for that module is
918    displayed, along with their synopsis. When {module} and {type} are
919    specified, a listing of all configuration options for that type are
920    displayed along with their synopsis. When {module}, {type}, and {option}
921    are specified, detailed information for that configuration option is
922    displayed.
923
924  * Added 'core show sounds' and 'core show sound' CLI commands. These display
925    a listing of all installed media sounds available on the system and
926    detailed information about a sound, respectively.
927
928  * 'xmldoc dump' has been added. This CLI command will dump the XML
929    documentation DOM as a string to the specified file. The Asterisk core
930    will populate certain XML elements pulled from the source files with
931    additional run-time information; this command lets a user produce the
932    XML documentation with all information.
933
934 Features
935 -------------------
936  * Parking has been pulled from core and placed into a separate module called
937    res_parking. See Parking changes below for more details. Configuration for
938    parking should now be performed in res_parking.conf. Configuration for
939    parking in features.conf is now unsupported.
940
941  * Core attended transfers now have several new options. While performing an
942    attended transfer, the transferer now has the following options:
943    - *1 - cancel the attended transfer (configurable via atxferabort)
944    - *2 - complete the attended transfer, dropping out of the call
945           (configurable via atxfercomplete)
946    - *3 - complete the attended transfer, but stay in the call. This will turn
947           the call into a multi-party bridge (configurable via atxferthreeway)
948    - *4 - swap to the other party. Once an attended transfer has begun, this
949           options may be used multiple times (configurable via atxferswap)
950
951  * For DTMF blind and attended transfers, the channel variable TRANSFER_CONTEXT
952    must be on the channel initiating the transfer to have any effect.
953
954  * The BRIDGE_FEATURES channel variable would previously only set features for
955    the calling party and would set this feature regardless of whether the
956    feature was in caps or in lowercase. Use of a caps feature for a letter
957    will now apply the feature to the calling party while use of a lowercase
958    letter will apply that feature to the called party.
959
960  * Add support for automixmon to the BRIDGE_FEATURES channel variable.
961
962  * The channel variable DYNAMIC_PEERNAME is redundant with BRIDGEPEER and is
963    removed.  The more useful DYNAMIC_WHO_ACTIVATED gives the channel name that
964    activated the dynamic feature.
965
966  * The channel variables DYNAMIC_FEATURENAME and DYNAMIC_WHO_ACTIVATED are set
967    only on the channel executing the dynamic feature.  Executing a dynamic
968    feature on the bridge peer in a multi-party bridge will execute it on all
969    peers of the activating channel.
970
971  * You can now have the settings for a channel updated using the FEATURE()
972    and FEATUREMAP() functions inherited to child channels by setting
973    FEATURE(inherit)=yes.
974
975  * automixmon now supports additional channel variables from automon including:
976    TOUCH_MIXMONITOR_PREFIX, TOUCH_MIXMONITOR_MESSAGE_START,
977    and TOUCH_MIXMONITOR_MESSAGE_STOP
978
979  * A new general features.conf option 'recordingfailsound' has been added which
980    allowssetting a failure sound for a user tries to invoke a recording feature
981    such as automon or automixmon and it fails.
982
983  * It is no longer necessary (or possible) to define the ATXFER_NULL_TECH in
984    features.c for atxferdropcall=no to work properly. This option now just
985    works.
986
987 Logging
988 -------------------
989  * Added log rotation strategy 'none'. If set, no log rotation strategy will
990    be used. Given that this can cause the Asterisk log files to grow quickly,
991    this option should only be used if an external mechanism for log management
992    is preferred.
993
994 Realtime
995 ------------------
996  * Dynamic realtime tables for SIP Users can now include a 'path' field. This
997    will store the path information for that peer when it registers. Realtime
998    tables can also use the 'supportpath' field to enable Path header support.
999
1000  * LDAP realtime configurations for SIP Users now have the AstAccountPathSupport
1001    objectIdentifier. This maps to the supportpath option in sip.conf.
1002
1003 Sorcery
1004 ------------------
1005  * Sorcery is a new data abstraction and object persistence API in Asterisk. It
1006    provides modules a useful abstraction on top of the many storage mechanisms
1007    in Asterisk, including the Asterisk Database, static configuration files,
1008    static Realtime, and dynamic Realtime. It also provides a caching service.
1009    Users can configure a hierarchy of data storage layers for specific modules
1010    in sorcery.conf.
1011
1012  * All future modules which utilize Sorcery for object persistence must have a
1013    column named "id" within their schema when using the Sorcery realtime module.
1014    This column must be able to contain a string of up to 128 characters in length.
1015
1016 Security Events Framework
1017 ------------------
1018  * Security Event timestamps now use ISO 8601 formatted date/time instead of
1019    the "seconds-microseconds" format that it was using previously.
1020
1021 Stasis Message Bus
1022 ------------------
1023  * The Stasis message bus is a publish/subscribe message bus internal to
1024    Asterisk. Many services in Asterisk are built on the Stasis message bus,
1025    including AMI, ARI, CDRs, and CEL. Parameters controlling the operation of
1026    Stasis can be configured in stasis.conf. Note that these parameters operate
1027    at a very low level in Asterisk, and generally will not require changes.
1028
1029 Channel Drivers
1030 ------------------
1031  * When a channel driver is configured to enable jiterbuffers, they are now
1032    applied unconditionally when a channel joins a bridge. If a jitterbuffer
1033    is already set for that channel when it enters, such as by the JITTERBUFFER
1034    function, then the existing jitterbuffer will be used and the one set by
1035    the channel driver will not be applied.
1036
1037 chan_agent
1038 ------------------
1039  * chan_agent has been removed and replaced with AgentLogin and AgentRequest
1040    dialplan applications provided by the app_agent_pool module. Agents are
1041    connected with callers using the new AgentRequest dialplan application.
1042    The Agents:<agent-id> device state is available to monitor the status of an
1043    agent. See agents.conf.sample for valid configuration options.
1044
1045  * The updatecdr option has been removed. Altering the names of channels on a
1046    CDR is not supported - the name of the channel is the name of the channel,
1047    and pretending otherwise helps no one. The AGENTUPDATECDR channel variable
1048    has also been removed, for the same reason.
1049
1050  * The endcall and enddtmf configuration options are removed.  Use the
1051    dialplan function CHANNEL(dtmf-features) to set DTMF features on the agent
1052    channel before calling AgentLogin.
1053
1054 chan_bridge
1055 ------------------
1056  * chan_bridge has been removed. Its functionality has been incorporated
1057    directly into the ConfBridge application itself.
1058
1059 chan_dahdi
1060 ------------------
1061  * Added the CLI command 'pri destroy span'. This will destroy the D-channel
1062    of the specified span and its B-channels. Note that this command should
1063    only be used if you understand the risks it entails.
1064
1065  * The CLI command 'dahdi destroy channel' is now 'dahdi destroy channels'.
1066    A range of channels can be specified to be destroyed. Note that this command
1067    should only be used if you understand the risks it entails.
1068
1069  * Added the CLI command 'dahdi create channels'. A range of channels can be
1070    specified to be created, or the keyword 'new' can be used to add channels
1071    not yet created.
1072
1073  * The script specified by the chan_dahdi.conf mwimonitornotify option now gets
1074    the exact configured mailbox name.  For app_voicemail mailboxes this is
1075    mailbox@context.
1076
1077  * Added mwi_vm_boxes that also must be configured for ISDN MWI to be enabled.
1078
1079 chan_iax2
1080 ------------------
1081  * IPv6 support has been added.  We are now able to bind to and
1082    communicate using IPv6 addresses.
1083
1084 chan_local
1085 ------------------
1086  * The /b option has been removed.
1087
1088  * chan_local moved into the system core and is no longer a loadable module.
1089
1090 chan_mobile
1091 ------------------
1092  * Added general support for busy detection.
1093
1094  * Added ECAM command support for Sony Ericsson phones.
1095
1096 chan_pjsip
1097 ------------------
1098  * A new SIP channel driver for Asterisk, chan_pjsip is built on the PJSIP
1099    SIP stack. A collection of resource modules provides the bulk of the SIP
1100    functionality. For more information on the new SIP channel driver, see
1101    https://wiki.asterisk.org/wiki/x/JYGLAQ
1102
1103 chan_sip
1104 ------------------
1105  * Added support for RFC 3327 "Path" headers. This can be enabled in sip.conf
1106    using the 'supportpath' setting, either on a global basis or on a peer basis.
1107    This setting enables Asterisk to route outgoing out-of-dialog requests via a
1108    set of proxies by using a pre-loaded route-set defined by the Path headers in
1109    the REGISTER request. See Realtime updates for more configuration information.
1110
1111  * The SIP_CODEC family of variables may now specify more than one codec. Each
1112    codec must be separated by a comma. The first codec specified is the
1113    preferred codec for the offer. This allows a dialplan writer to specify both
1114    audio and video codecs, e.g., Set(SIP_CODEC=ulaw,h264)
1115
1116  * The 'callevents' parameter has been removed. Hold AMI events are now raised
1117    in the core, and can be filtered out using the 'eventfilter' parameter
1118    in manager.conf.
1119
1120  * Added 'ignore_requested_pref'. When enabled, this will use the preferred
1121    codecs configured for a peer instead of the requested codec.
1122
1123  * The option "register_retry_403" has been added to chan_sip to work around
1124    servers that are known to erroneously send 403 in response to valid
1125    REGISTER requests and allows Asterisk to continue attepmting to connect.
1126
1127 chan_skinny
1128 ------------------
1129  * Added the 'immeddialkey' parameter. If set, when the user presses the
1130    configured key the already entered number will be immediately dialed. This
1131    is useful when the dialplan allows for variable length pattern matching.
1132    Valid options are '*' and '#'.
1133
1134  * Added the 'callfwdtimeout' parameter. This configures the amount of time (in
1135    milliseconds) before a call forward is considered to not be answered.
1136
1137  * The 'serviceurl' parameter allows Service URLs to be attached to line
1138    buttons.
1139
1140
1141 Functions
1142 ------------------
1143
1144 AGENT
1145 ------------------
1146  * The password option has been disabled, as the AgentLogin application no
1147    longer provides authentication.
1148
1149 AUDIOHOOK_INHERIT
1150 ------------------
1151  * Due to changes in the Asterisk core, this function is no longer needed to
1152    preserve a MixMonitor on a channel during transfer operations and dialplan
1153    execution. It is effectively obsolete.
1154
1155 CDR (function)
1156 ------------------
1157  * The 'amaflags' and 'accountcode' attributes for the CDR function are
1158    deprecated. Use the CHANNEL function instead to access these attributes.
1159
1160  * The 'l' option has been removed. When reading a CDR attribute, the most
1161    recent record is always used. When writing a CDR attribute, all non-finalized
1162    CDRs are updated.
1163
1164  * The 'r' option has been removed, for the same reason as the 'l' option.
1165
1166  * The 's' option has been removed, as LOCKED semantics no longer exist in the
1167    CDR engine.
1168
1169 CDR_PROP
1170 ------------------
1171  * A new function CDR_PROP has been added. This function lets you set properties
1172    on a channel's active CDRs. This function is write-only. Properties accept
1173    boolean values to set/clear them on the channel's CDRs. Valid properties
1174    include:
1175    - 'party_a' - make this channel the preferred Party A in any CDR between two
1176      channels. If two channels have this property set, the creation time of the
1177      channel is used to determine who is Party A. Note that dialed channels are
1178      never Party A in a CDR.
1179    - 'disable' - disable CDRs on this channel. This is analogous to the NoCDR
1180      application when set to True, and analogous to the 'e' option in ResetCDR
1181      when set to False.
1182
1183 CHANNEL
1184 ------------------
1185  * Added the argument 'dtmf_features'. This sets the DTMF features that will be
1186    enabled on a channel when it enters a bridge. Allowed values are 'T', 'K',
1187    'H', 'W', and 'X', and are analogous to the parameters passed to the Dial
1188    application.
1189
1190  * Added the argument 'after_bridge_goto'. This can be set to a parseable Goto
1191    string, i.e., [[context],extension],priority. If set on a channel, if a
1192    channel leaves a bridge but is not hung up it will resume dialplan execution
1193    at that location.
1194
1195 JITTERBUFFER
1196 ------------------
1197  * JITTERBUFFER now accepts an argument of 'disabled' which can be used
1198    to remove jitterbuffers previously set on a channel with JITTERBUFFER.
1199    The value of this setting is ignored when disabled is used for the argument.
1200
1201 PJSIP_DIAL_CONTACTS
1202 ------------------
1203  * A new function provided by chan_pjsip, this function can be used in
1204    conjunction with the Dial application to construct a dial string that will
1205    dial all contacts on an Address of Record associated with a chan_pjsip
1206    endpoint.
1207
1208 PJSIP_MEDIA_OFFER
1209 ------------------
1210  * Provided by chan_pjsip, this function sets the codecs to be offerred on the
1211    outbound channel prior to dialing.
1212
1213 REDIRECTING
1214 ------------------
1215  * Redirecting reasons can now be set to arbitrary strings. This means
1216    that the REDIRECTING dialplan function can be used to set the redirecting
1217    reason to any string. It also allows for custom strings to be read as the
1218    redirecting reason from SIP Diversion headers.
1219
1220 SPEECH_ENGINE
1221 ------------------
1222  * The SPEECH_ENGINE function now supports read operations. When read from, it
1223    will return the current value of the requested attribute.
1224
1225 VMCOUNT:
1226 ------------------
1227  * Mailboxes defined by app_voicemail MUST be referenced by the rest of the
1228    system as mailbox@context.  The rest of the system cannot add @default
1229    to mailbox identifiers for app_voicemail that do not specify a context
1230    any longer.  It is a mailbox identifier format that should only be
1231    interpreted by app_voicemail.
1232
1233
1234 Resources
1235 ------------------
1236
1237 res_agi (Asterisk Gateway Interface)
1238 ------------------
1239  * The manager event AGIExec has been split into AGIExecStart and AGIExecEnd.
1240
1241  * The manager event AsyncAGI has been split into AsyncAGIStart, AsyncAGIExec,
1242    and AsyncAGIEnd.
1243
1244  * The CONTROL STREAM FILE command now accepts an offsetms parameter. This
1245    will start the playback of the audio at the position specified. It will
1246    also return the final position of the file in 'endpos'.
1247
1248  * The CONTROL STREAM FILE command will now populate the CPLAYBACKSTATUS
1249    channel variable if the user stopped the file playback or if a remote
1250    entity stopped the playback. If neither stopped the playback, it will
1251    indicate the overall success/failure of the playback. If stopped early,
1252    the final offset of the file will be set in the CPLAYBACKOFFSET channel
1253    variable.
1254
1255  * The SAY ALPHA command now accepts an additional parameter to control
1256    whether it specifies the case of uppercase, lowercase, or all letters to
1257    provide functionality similar to SayAlphaCase.
1258
1259 res_ari (Asterisk RESTful Interface) (and others)
1260 ------------------
1261  * The Asterisk RESTful Interface (ARI) provides a mechanism to expose and
1262    control telephony primitives in Asterisk by remote client. This includes
1263    channels, bridges, endpoints, media, and other fundamental concepts. Users
1264    of ARI can develop their own communications applications, controlling
1265    multiple channels using an HTTP RESTful interface and receiving JSON events
1266    about the objects via a WebSocket connection. ARI can be configured in
1267    Asterisk via ari.conf. For more information on ARI, see
1268    https://wiki.asterisk.org/wiki/x/0YCLAQ
1269
1270 res_parking
1271 -------------------
1272  * Parking has been extracted from the Asterisk core as a loadable module,
1273    res_parking. Configuration for parking is now provided by res_parking.conf.
1274    Configuration through features.conf is no longer supported.
1275
1276  * res_parking uses the configuration framework. If an invalid configuration is
1277    supplied, res_parking will fail to load or fail to reload. Previously,
1278    invalid configurations would generally be accepted, with certain errors
1279    resulting in individually disabled parking lots.
1280
1281  * Parked calls are now placed in bridges. While this is largely an
1282    architectural change, it does have implications on how channels in a parking
1283    lot are viewed. For example, commands that display channels in bridges will
1284    now also display the channels in a parking lot.
1285
1286  * The order of arguments for the new parking applications have been modified.
1287    Timeout and return context/exten/priority are now implemented as options,
1288    while the name of the parking lot is now the first parameter. See the
1289    application documentation for Park, ParkedCall, and ParkAndAnnounce for more
1290    in-depth information as well as syntax.
1291
1292  * Extensions are by default no longer automatically created in the dialplan to
1293    park calls or pickup parked calls. Generation of dialplan extensions can be
1294    enabled using the 'parkext' configuration option.
1295
1296  * ADSI functionality for parking is no longer supported. The 'adsipark'
1297    configuration option has been removed as a result.
1298
1299  * The PARKINGSLOT channel variable has been deprecated in favor of
1300    PARKING_SPACE to match the naming scheme of the new system.
1301
1302  * PARKING_SPACE and PARKEDLOT channel variables will now be set for a parked
1303    channel even when the configuration option 'comebactoorigin' is enabled.
1304
1305  * A new CLI command 'parking show' has been added. This allows a user to
1306    inspect the parking lots that are currently in use.
1307    'parking show <parkinglot>' will also show the parked calls in a specific
1308    parking lot.
1309
1310  * The CLI command 'parkedcalls' is now deprecated in favor of
1311    'parking show <parkinglot>'.
1312
1313  * The AMI command 'ParkedCalls' will now accept a 'ParkingLot' argument which
1314    can be used to get a list of parked calls for a specific parking lot.
1315
1316  * The AMI command 'Park' field 'Channel2' has been deprecated and replaced
1317    with 'TimeoutChannel'. If both 'Channel2' and 'TimeoutChannel' are
1318    specified, 'TimeoutChannel' will be used. The field 'TimeoutChannel' is no
1319    longer a required argument.
1320
1321  * The ParkAndAnnounce application is now provided through res_parking instead
1322    of through the separate app_parkandannounce module.
1323
1324  * ParkAndAnnounce will no longer go to the next position in dialplan on timeout
1325    by default. Instead, it will follow the timeout rules of the parking lot. The
1326    old behavior can be reproduced by using the 'c' option.
1327
1328  * Dynamic parking lots will now fail to be created under the following
1329    conditions:
1330    - if the parking lot specified by PARKINGDYNAMIC does not exist
1331    - if they require exclusive park and parkedcall extensions which overlap
1332      with existing parking lots.
1333
1334  * Dynamic parking lots will be cleared on reload for dynamic parking lots that
1335    currently contain no calls. Dynamic parking lots containing parked calls
1336    will persist through the reloads without alteration.
1337
1338  * If 'parkext_exclusive' is set for a parking lot and that extension is
1339    already in use when that parking lot tries to register it, this is now
1340    considered a parking system configuration error. Configurations which do
1341    this will be rejected.
1342
1343  * Added channel variable PARKER_FLAT. This contains the name of the extension
1344    that would be used if 'comebacktoorigin' is enabled. This can be useful when
1345    comebacktoorigin is disabled, but the dialplan or an external control
1346    mechanism wants to use the extension in the park-dial context that was
1347    generated to re-dial the parker on timeout.
1348
1349 res_pjsip (and many others)
1350 ------------------
1351  * A large number of resource modules make up the SIP stack based on pjsip.
1352    The chan_pjsip channel driver users these resource modules to provide
1353    various SIP functionality in Asterisk. The majority of configuration for
1354    these modules is performed in pjsip.conf. Other modules may use their
1355    own configuration files.
1356
1357  * Added 'set_var' option for an endpoint. For each variable specified that
1358    variable gets set upon creation of a channel involving the endpoint.
1359
1360 res_rtp_asterisk
1361 ------------------
1362  * ICE/STUN/TURN support in res_rtp_asterisk has been made optional.  To enable
1363    them, an Asterisk-specific version of PJSIP needs to be installed.
1364    Tarballs are available from https://github.com/asterisk/pjproject/tags/.
1365
1366 res_statsd/res_chan_stats
1367 ------------------
1368  * A new resource module, res_statsd, has been added, which acts as a statsd
1369    client. This module allows Asterisk to publish statistics to a statsd
1370    server. In conjunction with res_chan_stats, it will publish statistics about
1371    channels to the statsd server. It can be configured via res_statsd.conf.
1372
1373 res_xmpp
1374 ------------------
1375  * Device state for XMPP buddies is now available using the following format:
1376    XMPP/<client name>/<buddy address>
1377    If any resource is available the device state is considered to be not in use.
1378    If no resources exist or all are unavailable the device state is considered
1379    to be unavailable.
1380
1381
1382 Scripts
1383 ------------------
1384
1385 Realtime/Database Scripts
1386 ------------------
1387  * Asterisk previously included example db schemas in the contrib/realtime/
1388    directory of the source tree.  This has been replaced by a set of database
1389    migrations using the Alembic framework.  This allows you to use alembic to
1390    initialize the database for you.  It will also serve as a database migration
1391    tool when upgrading Asterisk in the future.
1392
1393    See contrib/ast-db-manage/README.md for more details.
1394
1395 sip_to_res_pjsip.py
1396 -------------------
1397  * A new script has been added in the contrib/scripts/sip_to_res_pjsip folder.
1398    This python script will convert an existing sip.conf file to a
1399    pjsip.conf file, for use with the chan_pjsip channel driver. This script
1400    is meant to be an aid in converting an existing chan_sip configuration to
1401    a chan_pjsip configuration, but it is expected that configuration beyond
1402    what the script provides will be needed.
1403
1404
1405 ------------------------------------------------------------------------------
1406 --- Functionality changes from Asterisk 10 to Asterisk 11 --------------------
1407 ------------------------------------------------------------------------------
1408
1409 Build System
1410 -------------------
1411  * The Asterisk build system will now build and install a shared library
1412    (libasteriskssl.so) used to wrap various initialization and shutdown functions
1413    from the libssl and libcrypto libraries provided by OpenSSL. This is done so
1414    that Asterisk can ensure that these functions do *not* get called by any
1415    modules that are loaded into Asterisk, since they should only be called once
1416    in any single process. If desired, this feature can be disabled by supplying
1417    the "--disable-asteriskssl" option to the configure script.
1418
1419  * A new make target, 'full', has been added to the Makefile.  This performs
1420    the same compilation actions as make all, but will also scan the entirety of
1421    each source file for documentation.  This option is needed to generate AMI
1422    event documentation.  Note that your system must have Python in order for
1423    this make target to succeed.
1424
1425  * The optimization portion of the build system has been reworked to avoid
1426    broken builds on certain architectures.  All architecture-specific
1427    optimization has been removed in favor of using -march=native to allow gcc
1428    to detect the environment in which it is running when possible.  This can
1429    be toggled as BUILD_NATIVE under "Compiler Flags" in menuselect.
1430
1431  * BUILD_CFLAGS and BUILD_LDFLAGS can now be passed to menuselect, e.g.,
1432    make BUILD_CFLAGS="whatever" BUILD_LDFLAGS="whatever"
1433
1434  * Remove "asterisk/version.h" in favor of "asterisk/ast_version.h".  If you
1435    previously parsed the header file to obtain the version of Asterisk, you
1436    will now have to go through Asterisk to get the version information.
1437
1438
1439 Applications
1440 -------------------
1441
1442 Bridge
1443 -------------------
1444  * Added 'F()' option. Similar to the dial option, this can be supplied with
1445    arguments indicating where the callee should go after the caller is hung up,
1446    or without options specified, the priority after the Queue will be used.
1447
1448
1449 ConfBridge
1450 -------------------
1451  * Added menu action admin_toggle_mute_participants.  This will mute / unmute
1452    all non-admin participants on a conference.  The confbridge configuration
1453    file also allows for the default sounds played to all conference users when
1454    this occurs to be overriden using sound_participants_unmuted and
1455    sound_participants_muted.
1456
1457  * Added menu action participant_count.  This will playback the number of
1458    current participants in a conference.
1459
1460  * Added announcement configuration option to user profile. If set the sound
1461    file will be played to the user, and only the user, upon joining the
1462    conference bridge.
1463
1464  * Added record_file_append option that defaults to "yes", but if set to no
1465    will create a new file between each start/stop recording.
1466
1467
1468 Dial
1469 -------------------
1470  * Added 'b' and 'B' options to Dial that execute a Gosub on callee and caller
1471    channels respectively before the callee channels are called.
1472
1473
1474 ExternalIVR
1475 -------------------
1476  * Added support for IPv6.
1477
1478  * Add interrupt ('I') command to ExternalIVR.  Sending this command from an
1479    external process will cause the current playlist to be cleared, including
1480    stopping any audio file that is currently playing.  This is useful when you
1481    want to interrupt audio playback only when specific DTMF is entered by the
1482    caller.
1483
1484
1485 FollowMe
1486 -------------------
1487  * A new option, 'I' has been added to app_followme. By setting this option,
1488    Asterisk will not update the caller with connected line changes when they
1489    occur.  This is similar to app_dial and app_queue.
1490
1491  * The 'N' option is now ignored if the call is already answered.
1492
1493  * Added 'b' and 'B' options to FollowMe that execute a Gosub on callee
1494    and caller channels respectively before the callee channels are called.
1495
1496  * The winning FollowMe outgoing call is now put on hold if the caller put it on
1497    hold.
1498
1499
1500 MixMonitor
1501 ------------------
1502  * MixMonitor hooks now have IDs associated with them which can be used to
1503    assign a target to StopMixMonitor. Use of MixMonitor's i(variable) option
1504    will allow storage of the MixMontior ID in a channel variable. StopMixmonitor
1505    now accepts that ID as an argument.
1506
1507  * Added 'm' option, which stores a copy of the recording as a voicemail in the
1508    indicated mailboxes.
1509
1510
1511 MySQL
1512 -------------------
1513  * The connect action in app_mysql now allows you to specify a port number to
1514    connect to.  This is useful if you run a MySQL server on a non-standard
1515    port number.
1516
1517
1518 OSP Applications
1519 -------------------
1520  * Increased the default number of allowed destinations from 5 to 12.
1521
1522
1523 Page
1524 -------------------
1525  * The app_page application now no longer depends on DAHDI or app_meetme.  It
1526    has been re-architected to use app_confbridge internally.
1527
1528
1529 Queue
1530 -------------------
1531  * Added queue options autopausebusy and autopauseunavail for automatically
1532    pausing a queue member when their device reports busy or congestion.
1533
1534  * The 'ignorebusy' option for queue members has been deprecated in favor of
1535    the option 'ringinuse. Also a 'queue set ringinuse' CLI command has been
1536    added as well as an AMI action 'QueueMemberRingInUse' to set this variable on a
1537    per interface basis. Individual ringinuse values can now be set in
1538    queues.conf via an argument to member definitions. Lastly, the queue
1539    'ringinuse' setting now only determines defaults for the per member
1540    'ringinuse' setting and does not override per member settings like it does
1541    in earlier versions.
1542
1543  * Added 'F()' option. Similar to the dial option, this can be supplied with
1544    arguments indicating where the callee should go after the caller is hung up,
1545    or without options specified, the priority after the Queue will be used.
1546
1547  * Added new option log_member_name_as_agent, which will cause the membername to
1548    be logged in the agent field for ADDMEMBER and REMOVEMEMBER queue events if a
1549    state_interface has been set.
1550
1551  * Add queue monitoring hints.  exten => 8501,hint,Queue:markq.
1552
1553  * App_queue will now play periodic announcements for the caller that
1554    holds the first position in the queue while waiting for answer.
1555
1556 SayUnixTime
1557 ------------------
1558  * Added 'j' option to SayUnixTime. SayUnixTime no longer auto jumps to extension
1559    when receiving DTMF.  Use the 'j' option to enable extension jumping. Also
1560    changed arguments to SayUnixTime so that every option is truly optional even
1561    when using multiple options (so that j option could be used without having to
1562    manually specify timezone and format) There are other benefits, e.g., format
1563    can now be used without specifying time zone as well.
1564
1565
1566 Voicemail
1567 ------------------
1568  * Addition of the VM_INFO function - see Function changes.
1569
1570  * The imapserver, imapport, and imapflags configuration options can now be
1571    overriden on a user by user basis.
1572
1573  * When voicemail plays a message's envelope with saycid set to yes, when
1574    reaching the caller id field it will play a recording of a file with the same
1575    base name as the sender's callerid if there is a similarly named file in
1576    <astspooldir>/recordings/callerids/
1577
1578  * Voicemails now contains a unique message identifier "msg_id", which is stored
1579    in the message envelope with the sound files.  IMAP backends will now store
1580    the message identifiers with a header of "X-Asterisk-VM-Message-ID".  ODBC
1581    backends will store the message identifier in a "msg_id" column.  See
1582    UPGRADE.txt for more information.
1583
1584  * Added VoiceMailPlayMsg application.  This application will play a single
1585    voicemail message from a mailbox.  The result of the application, SUCCESS or
1586    FAILED, is stored in the channel variable VOICEMAIL_PLAYBACKSTATUS.
1587
1588
1589 Functions
1590 ------------------
1591  * Hangup handlers can be attached to channels using the CHANNEL() function.
1592    Hangup handlers will run when the channel is hung up similar to the h
1593    extension. The hangup_handler_push option will push a GoSub compatible
1594    location in the dialplan onto the channel's hangup handler stack.  The
1595    hangup_handler_pop option will remove the last added location, and optionally
1596    replace it with a new GoSub compatible location.  The hangup_handler_wipe
1597    option will remove all locations on the stack, and optionally add a new
1598    location.
1599
1600  * The expression parser now recognizes the ABS() absolute value function,
1601    which will convert negative floating point values to positive values.
1602
1603  * FAXOPT(faxdetect) will enable a generic fax detect framehook for dialplan
1604    control of faxdetect.
1605
1606  * Addition of the VM_INFO function that can be used to retrieve voicemail
1607    user information, such as the email address and full name.
1608    The MAILBOX_EXISTS dialplan function has been deprecated in favour of
1609    VM_INFO.
1610
1611  * The REDIRECTING function now supports the redirecting original party id
1612    and reason.
1613
1614  * Two new functions have been added: FEATURE() and FEATUREMAP().  FEATURE()
1615    lets you set some of the configuration options from the [general] section
1616    of features.conf on a per-channel basis.  FEATUREMAP() lets you customize
1617    the key sequence used to activate built-in features, such as blindxfer,
1618    and automon.  See the built-in documentation for details.
1619
1620  * MESSAGE(from) for incoming SIP messages now returns "display-name" <uri>
1621    instead of simply the uri.  This is the format that MessageSend() can use
1622    in the from parameter for outgoing SIP messages.
1623
1624  * Added the PRESENCE_STATE function.  This allows retrieving presence state
1625    information from any presence state provider.  It also allows setting
1626    presence state information from a CustomPresence presence state provider.
1627    See AMI/CLI changes for related commands.
1628
1629  * Added the AMI_CLIENT function to make manager account attributes available
1630    to the dialplan. It currently supports returning the current number of
1631    active sessions for a given account.
1632
1633  * Added support for private party ID information to CALLERID, CONNECTEDLINE,
1634    and the REDIRECTING functions.
1635
1636
1637 Channel Drivers
1638 ------------------
1639
1640 chan_local
1641 ------------------
1642  * Added a manager event "LocalBridge" for local channel call bridges between
1643    the two pseudo-channels created.
1644
1645
1646 chan_dahdi
1647 ------------------
1648  * Added dialtone_detect option for analog ports to disconnect incoming
1649    calls when dialtone is detected.
1650
1651  * Added option colp_send to send ISDN connected line information.  Allowed
1652    settings are block, to not send any connected line information; connect, to
1653    send connected line information on initial connect; and update, to send
1654    information on any update during a call.  Default is update.
1655
1656  * Add options namedcallgroup and namedpickupgroup to support installations
1657    where a higher number of groups (>64) is required.
1658
1659  * Added support to use private party ID information with PRI calls.
1660
1661
1662 chan_motif
1663 ------------------
1664  * A new channel driver named chan_motif has been added which provides support for
1665    Google Talk and Jingle in a single channel driver. This new channel driver includes
1666    support for both audio and video, RFC2833 DTMF, all codecs supported by Asterisk,
1667    hold, unhold, and ringing notification. It is also compliant with the current Jingle
1668    specification, current Google Jingle specification, and the original Google Talk
1669    protocol.
1670
1671
1672 chan_ooh323
1673 ------------------
1674  * Added NAT support for RTP.  Setting in config is 'nat', which can be set
1675    globally and overriden on a peer by peer basis.
1676
1677  * Direct media functionality has been added. Options in config are:
1678    directmedia (directrtp) and directrtpsetup (earlydirect)
1679
1680  * ChannelUpdate events now contain a CallRef header.
1681
1682
1683 chan_sip
1684 ------------------
1685  * Asterisk will no longer substitute CID number for CID name in the display
1686    name field if CID number exists without a CID name. This change improves
1687    compatibility with certain device features such as Avaya IP500's directory
1688    lookup service.
1689
1690  * A new setting for autocreatepeer (autocreatepeer=persistent) allows peers
1691    created using that setting to not be removed during SIP reload.
1692
1693  * Added settings recordonfeature and recordofffeature.  When receiving an INFO
1694    request with a "Record:" header, this will turn the requested feature on/off.
1695    Allowed values are 'automon', 'automixmon', and blank to disable.  Note that
1696    dynamic features must be enabled and configured properly on the requesting
1697    channel for this to function properly.
1698
1699  * Add support to realtime for the 'callbackextension' option.
1700
1701  * When multiple peers exist with the same address, but differing
1702    callbackextension options, incoming requests that are matched by address
1703    will be matched to the peer with the matching callbackextension if it is
1704    available.
1705
1706  * Two new NAT options, auto_force_rport and auto_comedia, have been added
1707    which set the force_rport and comedia options automatically if Asterisk
1708    detects that an incoming SIP request crossed a NAT after being sent by
1709    the remote endpoint.
1710
1711  * The default global nat setting in sip.conf has been changed from force_rport
1712    to auto_force_rport.
1713
1714  * NAT settings are now a combinable list of options. The equivalent of the
1715    deprecated nat=yes is nat=force_rport,comedia. nat=no behaves as before.
1716
1717  * Adds an option send_diversion which can be disabled to prevent
1718    diversion headers from automatically being added to INVITE requests.
1719
1720  * Add support for lightweight NAT keepalive. If enabled a blank packet will
1721    be sent to the remote host at a given interval to keep the NAT mapping open.
1722    This can be enabled using the keepalive configuration option.
1723
1724  * Add option 'tonezone' to specify country code for indications.  This option
1725    can be set both globally and overridden for specific peers.
1726
1727  * The SIP Security Events Framework now supports IPv6.
1728
1729  * Add a new setting for directmedia, 'outgoing', to alleviate INVITE glares
1730    between multiple user agents. When set, for directmedia reinvites,
1731    Asterisk will not send an immediate reinvite on an incoming call leg. This
1732    option is useful when peered with another SIP user agent that is known to
1733    send immediate direct media reinvites upon call establishment.
1734
1735  * Add support for WebSocket transport. This can be configured using 'ws' or 'wss'
1736    as the transport.
1737
1738  * Add options subminexpiry and submaxexpiry to set limits of subscription
1739    timer independently from registration timer settings. The setting of the
1740    registration timer limits still is done by options minexpiry, maxexpiry
1741    and defaultexpiry. For backwards compatibility the setting of minexpiry
1742    and maxexpiry also is used to configure the subscription timer limits if
1743    subminexpiry and submaxexpiry are not set in sip.conf.
1744
1745  * Set registration timer limits to default values when reloading sip
1746    configuration and values are not set by configuration.
1747
1748  * Add options namedcallgroup and namedpickupgroup to support installations
1749    where a higher number of groups (>64) is required.
1750
1751  * When a MESSAGE request is received, the address the request was received from
1752    is now saved in the SIP_RECVADDR variable.
1753
1754  * Add ANI2/OLI parsing for SIP.  The "From" header in INVITE requests is now
1755    parsed for the presence of "isup-oli", "ss7-oli", or "oli" tags.  If present,
1756    the ANI2/OLI information is set on the channel, which can be retrieved using
1757    the CALLERID function.
1758
1759  * Peers can now be configured to support negotiation of ICE candidates using
1760    the setting icesupport.  See res_rtp_asterisk changes for more information.
1761
1762  * Added support for format attribute negotiation.  See the Codecs changes for
1763    more information.
1764
1765  * Extra headers specified with SIPAddHeader are sent with the REFER message
1766    when using Transfer application. See refer_addheaders in sip.conf.sample.
1767
1768  * Added support to use private party ID information with calls.
1769
1770  * Adds an option discard_remote_hold_retrieval that when set stops telling
1771    the peer to start music on hold.
1772
1773
1774 chan_skinny
1775 ------------------
1776  * Added skinny version 17 protocol support.
1777
1778
1779 chan_unistim
1780 --------------------
1781  * Added ability to use multiple lines for a single phone.  This allows multiple
1782    calls to occur on a single phone, using callwaiting and switching between calls.
1783
1784  * Added option 'sharpdial' allowing end dialing by pressing # key
1785
1786  * Added option 'interdigit_timer' to control phone dial timeout
1787
1788  * Added options 'cwstyle', 'cwvolume' controlling callwaiting appearance
1789
1790  * Added global 'debug' option, that enables debug in channel driver
1791
1792  * Added ability to translate on-screen menu in multiple languages. Tested on
1793    Russian languages.  Supported encodings: ISO 8859-1, ISO 8859-2, ISO 8859-4,
1794    ISO 8859-5, ISO 2022-JP. Language controlled by 'language' and on-screen
1795    menu of phone
1796
1797  * In addition to English added French and Russian languages for on-screen menus
1798
1799  * Reworked dialing number input: added dialing by timeout, immediate dial on
1800    on dialplan compare, phone number length now not limited by screen size
1801
1802  * Added ability to pickup a call using features.conf defined value and
1803    on-screen key
1804
1805
1806 chan_mISDN:
1807 ------------------
1808  * Add options namedcallgroup and namedpickupgroup to support installations
1809    where a higher number of groups (>64) is required.
1810
1811  * Added support to use private party ID information with calls.
1812
1813
1814 Core
1815 ------------------
1816  * The minimum DTMF duration can now be configured in asterisk.conf
1817    as "mindtmfduration". The default value is (as before) set to 80 ms.
1818    (previously it was only available in source code)
1819
1820  * Named ACLs can now be specified in acl.conf and used in configurations that
1821    use ACLs. As a general rule, if some derivative of 'permit' or 'deny' is
1822    used to specify an ACL, a similar form of 'acl' will add a named ACL to the
1823    working ACL. In addition, some CLI commands have been added to provide
1824    show information and allow for module reloading - see CLI Changes.
1825
1826  * Rules in ACLs (specified using 'permit' and 'deny') can now contain multiple
1827    items (separated by commas), and items in the rule can be negated by prefixing
1828    them with '!'. This simplifies Asterisk Realtime configurations, since it is no
1829    longer necessray to control the order that the 'permit' and 'deny' columns are
1830    returned from queries.
1831
1832  * DUNDi now allows the built in variables ${NUMBER}, ${IPADDR} and ${SECRET} to
1833    be used within the dynamic weight attribute when specifying a mapping.
1834
1835  * CEL backends can now be configured to show "USER_DEFINED" in the EventName
1836    header, instead of putting the user defined event name there.  When enabled
1837    the UserDefType header is added for user defined events.  This feature is
1838    enabled with the setting show_user_defined.
1839
1840  * Macro has been deprecated in favor of GoSub.  For redirecting and connected
1841    line purposes use the following variables instead of their macro equivalents:
1842    REDIRECTING_SEND_SUB, REDIRECTING_SEND_SUB_ARGS, CONNECTED_LINE_SEND_SUB,
1843    CONNECTED_LINE_SEND_SUB_ARGS.  For CCSS, use cc_callback_sub instead of
1844    cc_callback_macro in channel configurations.
1845
1846  * Asterisk can now use a system-provided NetBSD editline library (libedit) if it
1847    is available.
1848
1849  * Call files now support the "early_media" option to connect with an outgoing
1850    extension when early media is received.
1851
1852  * Added support to use private party ID information with calls.
1853
1854
1855 AGI
1856 ------------------
1857  * A new channel variable, AGIEXITONHANGUP, has been added which allows
1858    Asterisk to behave like it did in Asterisk 1.4 and earlier where the
1859    AGI application would exit immediately after a channel hangup is detected.
1860
1861  * IPv6 addresses are now supported when using FastAGI (agi://).  Hostnames
1862    are resolved and each address is attempted in turn until one succeeds or
1863    all fail.
1864
1865
1866 AMI (Asterisk Manager Interface)
1867 ------------------
1868  * The originate action now has an option "EarlyMedia" that enables the
1869    call to bridge when we get early media in the call. Previously,
1870    early media was disregarded always when originating calls using AMI.
1871
1872  * Added setvar= option to manager accounts (much like sip.conf)
1873
1874  * Originate now generates an error response if the extension given is not found
1875    in the dialplan
1876
1877  * MixMonitor will now show IDs associated with the mixmonitor upon creating
1878    them if the i(variable) option is used. StopMixMonitor will accept
1879    MixMonitorID as an option to close specific MixMonitors.
1880
1881  * The SIPshowpeer manager action response field "SIP-Forcerport" has been
1882    updated to include information about peers configured with
1883    nat=auto_force_rport by returning "A" if auto_force_rport is set and nat is
1884    detected, and "a" if it is set and nat is not detected. "Y" and "N" are still
1885    returned if auto_force_rport is not enabled.
1886
1887  * Added SIPpeerstatus manager command which will generate PeerStatus events
1888    similar to the existing PeerStatus events found in chan_sip on demand.
1889
1890  * Hangup now can take a regular expression as the Channel option.  If you want
1891    to hangup multiple channels, use /regex/ as the Channel option.  Existing
1892    behavior to hanging up a single channel is unchanged, but if you pass a regex,
1893    the manager will send you a list of channels back that were hung up.
1894
1895  * Support for IPv6 addresses has been added.
1896
1897  * AMI Events can now be documented in the Asterisk source. Note that AMI event
1898    documentation is only generated when Asterisk is compiled using 'make full'.
1899    See the CLI section for commands to display AMI event information.
1900
1901  * The AMI Hangup event now includes the AccountCode header so you can easily
1902    correlate with AMI Newchannel events.
1903
1904  * The QueueMemberStatus, QueueMemberAdded, and QueueMember events now include
1905    the StateInterface of the queue member.
1906
1907  * Added AMI event SessionTimeout in the Call category that is issued when a
1908    call is terminated due to either RTP stream inactivity or SIP session timer
1909    expiration.
1910
1911  * CEL events can now contain a user defined header UserDefType.  See core
1912    changes for more information.
1913
1914  * OOH323 ChannelUpdate events now contain a CallRef header.
1915
1916  * Added PresenceState command.  This command will report the presence state for
1917    the given presence provider.
1918
1919  * Added Parkinglots command.  This will list all parking lots as a series of
1920    AMI Parkinglot events.
1921
1922  * Added MessageSend command.  This behaves in the same manner as the
1923    MessageSend application, and is a technolgoy agnostic mechanism to send out
1924    of call text messages.
1925
1926  * Added "message" class authorization.  This grants an account permission to
1927    send out of call messages.  Write-only.
1928
1929
1930 CLI
1931 -------------------
1932  * The "dialplan add include" command has been modified to create context a context
1933    if one does not already exist. For instance, "dialplan add include foo into bar"
1934    will create context "bar" if it does not already exist.
1935
1936  * A  "dialplan remove context" command has been added to remove a context from
1937    the dialplan
1938
1939  * The "mixmonitor list <channel>" command will now show MixMonitor ID, and the
1940    filenames of all running mixmonitors on a channel.
1941
1942  * The debug level of "pri set debug" is now a bitmask ranging from 0 to 15 if
1943    numeric instead of 0, 1, or 2.
1944
1945  * "stun show status" will show a table describing how the STUN client is
1946    behaving.
1947
1948  * "acl show [named acl]" will show information regarding a Named ACL.  The
1949    acl module can be reloaded with "reload acl".
1950
1951  * Added CLI command to display AMI event information - "manager show events",
1952    which shows a list of all known and documented AMI events, and "manager show
1953    event [event name]", which shows detail information about a specific AMI
1954    event.
1955
1956  * The result of the CLI command "queue show" now includes the state interface
1957    information of the queue member.
1958
1959  * The command "core set verbose" will now set a separate level of logging for
1960    each remote console without affecting any other console.
1961
1962  * Added command "cdr show pgsql status" to check connection status
1963
1964  * "sip show channel" will now display the complete route set.
1965
1966  * Added "presencestate list" command.  This command will list all custom
1967    presence states that have been set by using the PRESENCE_STATE dialplan
1968    function.
1969
1970  * Added "presencestate change <entity> <state>[,<subtype>[,message[,options]]]"
1971    command.  This changes a custom presence to a new state.
1972
1973
1974 Codecs
1975 -------------------
1976  * Codec lists may now be modified by the '!' character, to allow succinct
1977    specification of a list of codecs allowed and disallowed, without the
1978    requirement to use two different keywords.  For example, to specify all
1979    codecs except g729 and g723, one need only specify allow=all,!g729,!g723.
1980
1981  * Add support for parsing SDP attributes, generating SDP attributes, and
1982    passing it through. This support includes codecs such as H.263, H.264, SILK,
1983    and CELT. You are able to set up a call and have attribute information pass.
1984    This should help considerably with video calls.
1985
1986  * The iLBC codec can now use a system-provided iLBC library if one is installed,
1987    just like the GSM codec.
1988
1989 DUNDi changes
1990 -------------
1991  * Added CLI commands dundi show hints and dundi show cache which will list DUNDi
1992    'DONTASK' hints in the cache and list all DUNDi cache entires respectively.
1993
1994 Logging
1995 -------------------
1996  * Asterisk version and build information is now logged at the beginning of a
1997    log file.
1998
1999  * Threads belonging to a particular call are now linked with callids which get
2000    added to any log messages produced by those threads. Log messages can now be
2001    easily identified as involved with a certain call by looking at their call id.
2002    Call ids may also be attached to log messages for just about any case where
2003    it can be determined to be related to a particular call.
2004
2005  * Each logging destination and console now have an independent notion of the
2006    current verbosity level.  Logger.conf now allows an optional argument to
2007    the 'verbose' specifier, indicating the level of verbosity sent to that
2008    particular logging destination.  Additionally, remote consoles now each
2009    have their own verbosity level.  The command 'core set verbose' will now set
2010    a separate level for each remote console without affecting any other
2011    console.
2012
2013
2014 Music On Hold
2015 -------------------
2016  * Added 'announcement' option which will play at the start of MOH and between
2017    songs in modes of MOH that can detect transitions between songs (eg.
2018    files, mp3, etc).
2019
2020
2021 Parking
2022 -------------------
2023  * New per parking lot options: comebackcontext and comebackdialtime. See
2024    configs/features.conf.sample for more details.
2025
2026  * Channel variable PARKER is now set when comebacktoorigin is disabled in
2027    a parking lot.
2028
2029  * Channel variable PARKEDCALL is now set with the name of the parking lot
2030    when a timeout occurs.
2031
2032
2033 CDRs
2034 -------------------
2035
2036 CDR Postgresql Driver
2037 -------------------
2038  * Added command "cdr show pgsql status" to check connection status
2039
2040
2041 CDR Adaptive ODBC Driver
2042 -------------------
2043  * Added schema option for databases that support specifying a schema.
2044
2045
2046 Resource Modules
2047 -------------------
2048
2049 Calendars
2050 -------------------
2051  * A CALENDAR_SUCCESS=1/0 channel variable is now set to show whether or not
2052    CALENDAR_WRITE has completed successfully.
2053
2054
2055 res_rtp_asterisk
2056 -------------------
2057  * A new option, 'probation' has been added to rtp.conf
2058    RTP in strictrtp mode can now require more than 1 packet to exit learning
2059    mode with a new source (and by default requires 4). The probation option
2060    allows the user to change the required number of packets in sequence to any
2061    desired value. Use a value of 1 to essentially restore the old behavior.
2062    Also, with strictrtp on, Asterisk will now drop all packets until learning
2063    mode has successfully exited. These changes are based on how pjmedia handles
2064    media sources and source changes.
2065
2066  * Add support for ICE/STUN/TURN in res_rtp_asterisk.  This option can be
2067    enabled or disabled using the icesupport setting.  A variety of other
2068    settings have been introduced to configure STUN/TURN connections.
2069
2070
2071 res_corosync
2072 -------------------
2073  * A new module, res_corosync, has been introduced.  This module uses the
2074    Corosync cluster enginer (http://www.corosync.org) to allow a local cluster
2075    of Asterisk servers to both Message Waiting Indication (MWI) and/or
2076    Device State (presence) information.  This module is very similar to, and
2077    is a replacement for the res_ais module that was in previous releases of
2078    Asterisk.
2079
2080
2081 res_xmpp
2082 -------------------
2083  * This module adds a cleaned up, drop-in replacement for res_jabber called
2084    res_xmpp. This provides the same externally facing functionality but is
2085    implemented differently internally.  res_jabber has been deprecated in favor
2086    of res_xmpp; please see the UPGRADE.txt file for more information.
2087
2088
2089 Scripts
2090 -------------------
2091  * The safe_asterisk script has been updated to allow several of its parameters
2092    to be set from environment variables.  This also enables a custom run
2093    directory of Asterisk to be specified, instead of defaulting to /tmp.
2094
2095  * The live_ast script will now look for the LIVE_AST_BASE_DIR variable and use
2096    its value to determine the directory to assume is the top-level directory of
2097    the source tree.  If the variable is not set, it defaults to the current
2098    behavior and uses the current working directory.
2099
2100 ------------------------------------------------------------------------------
2101 --- Functionality changes from Asterisk 1.8 to Asterisk 10 -------------------
2102 ------------------------------------------------------------------------------
2103
2104 Text Messaging
2105 --------------
2106  * Asterisk now has protocol independent support for processing text messages
2107    outside of a call.  Messages are routed through the Asterisk dialplan.
2108    SIP MESSAGE and XMPP are currently supported.  There are options in
2109    jabber.conf and sip.conf to allow enabling these features.
2110      -> jabber.conf: see the "sendtodialplan" and "context" options.
2111      -> sip.conf: see the "accept_outofcall_message", "auth_message_requests"
2112         and "outofcall_message_context" options.
2113    The MESSAGE() dialplan function and MessageSend() application have been
2114    added to go along with this functionality.  More detailed usage information
2115    can be found on the Asterisk wiki (http://wiki.asterisk.org/).
2116  * If real-time text support (T.140) is negotiated, it will be preferred for
2117    sending text via the SendText application. For example, via SIP, messages
2118    that were once sent via the SIP MESSAGE request would be sent via RTP if
2119    T.140 text is negotiated for a call.
2120
2121 Parking
2122 -------
2123  * parkedmusicclass can now be set for non-default parking lots.
2124
2125 Asterisk Manager Interface
2126 --------------------------
2127  * PeerStatus now includes Address and Port.
2128  * Added Hold events for when the remote party puts the call on and off hold
2129    for chan_dahdi ISDN channels.
2130  * Added new action MeetmeListRooms to list active conferences (shows same
2131    data as "meetme list" at the CLI).
2132  * DAHDIShowChannels, SIPshowpeer, SIPpeers, and IAXpeers now contains a
2133    Description field that is set by 'description' in the channel configuration
2134    file.
2135  * Added Uniqueid header to UserEvent.
2136  * Added new action FilterAdd to control event filters for the current session.
2137    This requires the system permission and uses the same filter syntax as
2138    filters that can be defined in manager.conf
2139  * The Unlink event is now a Bridge event with Bridgestatus: Unlink. Previous
2140    versions had some instances of the event converted, but others were left
2141    as-is. All Unlink events should now be converted to Bridge events. The AMI
2142    protocol version number was incremented to 1.2 as a result of this change.
2143
2144 Asterisk HTTP Server
2145 --------------------------
2146  * The HTTP Server can bind to IPv6 addresses.
2147
2148 chan_dahdi
2149 --------------------------
2150  * Busy tone patterns featuring 2 silence and 2 tone lengths can now be used
2151    with busydetect.  usage example: busypattern=200,200,200,600
2152
2153 CLI Changes
2154 --------------------------
2155  * New 'gtalk show settings' command showing the current settings loaded from
2156    gtalk.conf.
2157  * The 'logger reload' command now supports an optional argument, specifying an
2158    alternate configuration file to use.
2159  * 'dialplan add extension' command will now automatically create a context if
2160    the specified context does not exist with a message indicated it did so.
2161  * 'sip show peers', 'iax show peers', and 'dahdi show peers' now contains a
2162    Description field which can be populated with 'description' in the channel
2163    configuration files (sip.conf, iax2.conf, and chan_dahdi.conf).
2164
2165 CDR
2166 --------------------------
2167  * The filter option in cdr_adaptive_odbc now supports negating the argument,
2168    thus allowing records which do NOT match the specified filter.
2169  * Added ability to log CONGESTION calls to CDR
2170
2171 CODECS
2172 --------------------------
2173  * Ability to define custom SILK formats in codecs.conf.
2174  * Addition of speex32 audio format with translation.
2175  * CELT codec pass-through support and ability to define
2176    custom CELT formats in codecs.conf.
2177  * Ability to read raw signed linear files with sample rates
2178    ranging from 8khz - 192khz.  The new file extensions introduced
2179    are .sln12, .sln24, .sln32, .sln44, .sln48, .sln96, .sln192.
2180  * Due to protocol limitations, channel drivers other than SIP (eg. IAX2, MGCP,
2181    Skinny, H.323, etc) can still only support the following codecs:
2182    Audio: ulaw, alaw, slin, slin16, g719, g722, g723, g726, g726aal2, g729, gsm,
2183           siren7, siren14, speex, speex16, ilbc, lpc10, adpcm
2184    Video: h261, h263, h263p, h264, mpeg4
2185    Image: jpeg, png
2186    Text:  red, t140
2187
2188 ConfBridge
2189 --------------------------
2190  * New highly optimized and customizable ConfBridge application capable of
2191    mixing audio at sample rates ranging from 8khz-96khz.
2192  * CONFBRIDGE dialplan function capable of creating dynamic ConfBridge user
2193    and bridge profiles on a channel.
2194  * CONFBRIDGE_INFO dialplan function capable of retrieving information
2195    about a conference such as locked status and number of parties, admins,
2196    and marked users.
2197  * Addition of video_mode option in confbridge.conf for adding video support
2198    into a bridge profile.
2199  * Addition of the follow_talker video_mode in confbridge.conf.  This video
2200    mode dynamically switches the video feed to always display the loudest talker
2201    supplying video in the conference.
2202
2203 Dialplan Variables
2204 ------------------
2205  * Added ASTETCDIR, ASTMODDIR, ASTVARLIBDIR, ASTDBDIR, ASTKEYDIR, ASTDATADIR,
2206    ASTAGIDIR, ASTSPOOLDIR, ASTRUNDIR, ASTLOGDIR which hold the equivalent
2207    variables from asterisk.conf.
2208
2209 Dialplan Functions
2210 ------------------
2211  * Addition of the JITTERBUFFER dialplan function. This function allows
2212    for jitterbuffering to occur on the read side of a channel.  By using
2213    this function conference applications such as ConfBridge and MeetMe can
2214    have the rx streams jitterbuffered before conference mixing occurs.
2215  * Added DB_KEYS, which lists the next set of keys in the Asterisk database
2216    hierarchy.
2217  * Added STRREPLACE function.  This function let's the user search a variable
2218    for a given string to replace with another string as many times as the
2219    user specifies or just throughout the whole string.
2220  * Added option to CHANNEL(pickupgroup) allow reading and setting the pickupgroup of channel.
2221  * Mark VALID_EXTEN() deprecated in favor of DIALPLAN_EXISTS()
2222  * Added extensions to chan_ooh323 in function CHANNEL()
2223
2224 libpri channel driver (chan_dahdi) DAHDI changes
2225 --------------------------
2226  * Added moh_signaling option to specify what to do when the channel's bridged
2227    peer puts the ISDN channel on hold.
2228  * Added display_send and display_receive options to control how the display ie
2229    is handled.  To send display text from the dialplan use the SendText()
2230    application when the option is enabled.
2231  * Added mcid_send option to allow sending a MCID request on a span.
2232
2233 Calendaring
2234 --------------------------
2235  * Added setvar option to calendar.conf to allow setting channel variables on
2236    notification channels.
2237  * Added "calendar show types" CLI command to list registered calendar
2238    connectors.
2239
2240 MixMonitor
2241 --------------------------
2242  * Added two new options, r and t with file name arguments to record
2243    single direction (unmixed) audio recording separate from the bidirectional
2244    (mixed) recording.  The mixed file name argument is optional now as long
2245    as at least one recording option is used.
2246
2247 FollowMe
2248 --------------------------
2249  * Added a new option, l, which will disable local call optimization for
2250    channels involved with the FollowMe thread.  Use this option to improve
2251    compatability for a FollowMe call with certain dialplan apps, options, and
2252    functions.
2253
2254 Meetme
2255 --------------------------
2256  * Added option "k" that will automatically close the conference when there's
2257    only one person left when a user exits the conference.
2258
2259 CEL
2260 --------------------------
2261  * cel_pgsql now supports the 'extra' column for data added using the
2262    CELGenUserEvent() application.
2263
2264 pbx_lua
2265 --------------------------
2266  * Support for defining hints has been added to pbx_lua.  See the 'hints' table
2267    in the sample extensions.lua file for syntax details.
2268  * Applications that perform jumps in the dialplan such as Goto will now
2269    execute properly.  When pbx_lua detects that the context, extension, or
2270    priority we are executing on has changed it will immediately return control
2271    to the asterisk PBX engine.  Currently the engine cannot detect a Goto to
2272    the priority after the currently executing priority.
2273  * An autoservice is now started by default for pbx_lua channels.  It can be
2274    stopped and restarted using the autoservice_stop() and autoservice_start()
2275    functions.
2276
2277 res_fax
2278 --------------------------
2279  * The ReceiveFAXStatus and SendFAXStatus manager events have been consolidated
2280    into a FAXStatus event with an 'Operation' header that will be either
2281    'send', 'receive', and 'gateway'.
2282  * T.38 gateway functionality has been added to res_fax (and res_fax_spandsp).
2283    Set FAXOPT(gateway)=yes to enable this functionality on a channel. This
2284    feature will handle converting a fax call between an audio T.30 fax terminal
2285    and an IFP T.38 fax terminal.
2286
2287 SIP Changes
2288 -----------
2289  * Add T38 support for REJECTED state where T.38 Negotiation is explicitly rejected.
2290  * Add option encryption_taglen to set auth taglen only 32 and 80 are supported currently.
2291  * SIP now generates security events using the Security Events Framework for REGISTER and INVITE.
2292
2293 Queue changes
2294 -------------
2295  * Added general option negative_penalty_invalid default off. when set
2296    members are seen as invalid/logged out when there penalty is negative.
2297    for realtime members when set remove from queue will set penalty to -1.
2298  * Added queue option autopausedelay when autopause is enabled it will be
2299    delayed for this number of seconds since last successful call if there
2300    was no prior call the agent will be autopaused immediately.
2301  * Added member option ignorebusy this when set and ringinuse is not
2302    will allow per member control of multiple calls as ringinuse does for
2303    the Queue.
2304
2305 Applications
2306 ------------
2307  * Added 'v' option to MeetMe to play voicemail greetings when a user joins/leaves
2308    a MeetMe conference
2309  * Added 'k' option to MeetMe to automatically kill the conference when there's only
2310    one participant left (much like a normal call bridge)
2311  * Added extra argument to Originate to set timeout.
2312
2313 Asterisk Database
2314 -----------------
2315  * The internal Asterisk database has been switched from Berkeley DB 1.86 to
2316    SQLite 3. An existing Berkeley astdb file can be converted with the astdb2sqlite3
2317    utility in the UTILS section of menuselect. If an existing astdb is found and no
2318    astdb.sqlite3 exists, astdb2sqlite3 will be compiled automatically. Asterisk will
2319    convert an existing astdb to the SQLite3 version automatically at runtime.
2320
2321 Asterisk Modules
2322 ----------------
2323  * Modules marked as deprecated are no longer marked as building by default. Enabling
2324    these modules is still available via menuselect.
2325
2326 IAX2 Changes
2327 ------------
2328  * authdebug is now disabled by default. To enable this functionaility again
2329    set authdebug = yes in iax.conf.
2330
2331 RTP Changes
2332 -----------
2333  * The rtp.conf setting "strictrtp" is now enabled by default. In previous
2334    releases it was disabled.
2335
2336 PBX Core
2337 --------
2338  * The PBX core previously made a call with a non-existing extension test for
2339    extension s@default and jump there if the extension existed.
2340    This was a bad default behaviour and violated the principle of least surprise.
2341    It has therefore been changed in this release. It may affect some
2342    applications and configurations that rely on this behaviour. Most channel
2343    drivers have avoided this for many releases by testing whether the extension
2344    called exists before starting the PBX and generating a local error.
2345    This behaviour still exists and works as before.
2346
2347    Extension "s" is used when no extension is given in a channel driver,
2348    like immediate answer in DAHDI or calling to a domain with no user part
2349    in a SIP uri.
2350
2351 ------------------------------------------------------------------------------
2352 --- Functionality changes from Asterisk 1.6.2 to Asterisk 1.8 ----------------
2353 ------------------------------------------------------------------------------
2354
2355 SIP Changes
2356 -----------
2357  * Due to potential username discovery vulnerabilities, the 'nat' setting in sip.conf
2358    now defaults to force_rport. It is very important that phones requiring nat=no be
2359    specifically set as such instead of relying on the default setting. If at all
2360    possible, all devices should have nat settings configured in the general section as
2361    opposed to configuring nat per-device.
2362  * Added preferred_codec_only option in sip.conf. This feature limits the joint
2363    codecs sent in response to an INVITE to the single most preferred codec.
2364  * Added SIP_CODEC_OUTBOUND dialplan variable which can be used to set the codec
2365    to be used for the outgoing call. It must be one of the codecs configured
2366    for the device.
2367  * Added tlsprivatekey option to sip.conf.  This allows a separate .pem file
2368    to be used for holding a private key.  If tlsprivatekey is not specified,
2369    tlscertfile is searched for both public and private key.
2370  * Added tlsclientmethod option to sip.conf.  This allows the protocol for
2371    outbound client connections to be specified.
2372  * The sendrpid parameter has been expanded to include the options
2373    'rpid' and 'pai'. Setting sendrpid to 'rpid' will cause Remote-Party-ID
2374    header to be sent (equivalent to setting sendrpid=yes) and setting
2375    sendrpid to 'pai' will cause P-Asserted-Identity header to be sent.
2376  * The 'ignoresdpversion' behavior has been made automatic when the SDP received
2377    is in response to a T.38 re-INVITE that Asterisk initiated. In this situation,
2378    since the call will fail if Asterisk does not process the incoming SDP, Asterisk
2379    will accept the SDP even if the SDP version number is not properly incremented,
2380    but will generate a warning in the log indicating that the SIP peer that sent
2381    the SDP should have the 'ignoresdpversion' option set.
2382  * The 'nat' option has now been been changed to have yes, no, force_rport, and
2383    comedia as valid values. Setting it to yes forces RFC 3581 behavior and enables
2384    symmetric RTP support. Setting it to no only enables RFC 3581 behavior if the
2385    remote side requests it and disables symmetric RTP support. Setting it to
2386    force_rport forces RFC 3581 behavior and disables symmetric RTP support.
2387    Setting it to comedia enables RFC 3581 behavior if the remote side requests it
2388    and enables symmetric RTP support.
2389  * Slave SIP channels now set HASH(SIP_CAUSE,<slave-channel-name>) on each
2390    response.  This permits the master channel to know how each channel dialled
2391    in a multi-channel setup resolved in an individual way. This carries a
2392    performance penalty and can be disabled in sip.conf using the
2393    'storesipcause' option.
2394  * Added 'externtcpport' and 'externtlsport' options to allow custom port
2395    configuration for the externip and externhost options when tcp or tls is used.
2396  * Added support for message body (stored in content variable) to SIP NOTIFY message
2397    accessible via AMI and CLI.
2398  * Added 'media_address' configuration option which can be used to explicitly specify
2399    the IP address to use in the SDP for media (audio, video, and text) streams.
2400  * Added 'unsolicited_mailbox' configuration option which specifies the virtual mailbox
2401    that the new/old count should be stored on if an unsolicited MWI NOTIFY message is
2402    received.
2403  * Added 'use_q850_reason' configuration option for generating and parsing
2404    if available  Reason: Q.850;cause=<cause code> header. It is implemented
2405    in some gateways for better passing PRI/SS7 cause codes via SIP.
2406  * When dialing SIP peers, a new component may be added to the end of the dialstring
2407    to indicate that a specific remote IP address or host should be used when dialing
2408    the particular peer. The dialstring format is SIP/peer/exten/host_or_IP.
2409  * SRTP SDES support for encrypting calls to/from Asterisk over SIP. The
2410    ability to selectively force bridged channels to also be encrypted is also
2411    implemented. Branching in the dialplan can be done based on whether or not
2412    a channel has secure media and/or signaling.
2413  * Added directmediapermit/directmediadeny to limit which peers can send direct media
2414    to each other
2415  * Added the 'snom_aoc_enabled' option to turn on support for sending Advice of
2416    Charge messages to snom phones.
2417  * Added support for G.719 media streams.
2418  * Added support for 16khz signed linear media streams.
2419  * SIP is now able to bind to and communicate with IPv6 addresses. In addition,
2420    RTP has been outfitted with the same abilities.
2421  * Added support for setting the Max-Forwards: header in SIP requests. Setting is
2422    available in device configurations as well as in the dial plan.
2423  * Addition of the 'subscribe_network_change' option for turning on and off
2424    res_stun_monitor module support in chan_sip.
2425  * Addition of the 'auth_options_requests' option for turning on and off
2426    authentication for OPTIONS requests in chan_sip.
2427
2428 Configuration files
2429 -------------------
2430  * Add #tryinclude statement for config files.  This provides the same
2431    functionality as the #include statement however an asterisk module will
2432    still load if the filename does not exist.  Using the #include statement
2433    Asterisk will not allow the module to load.
2434
2435 IAX2 Changes
2436 -----------
2437  * Added rtsavesysname option into iax.conf to allow the systname to be saved
2438    on realtime updates.
2439  * Added the ability for chan_iax2 to inform the dialplan whether or not
2440    encryption is being used. This interoperates with the SIP SRTP implementation
2441    so that a secure SIP call can be bridged to a secure IAX call when the
2442    dialplan requires bridged channels to be "secure".
2443  * Addition of the 'subscribe_network_change' option for turning on and off
2444    res_stun_monitor module support in chan_iax.
2445
2446
2447 MGCP Changes
2448 ------------
2449  * Added ability to preset channel variables on indicated lines with the setvar
2450    configuration option.  Also, clearvars=all resets the list of variables back
2451    to none.
2452  * PacketCable NCS 1.0 support has been added for Docsis/Eurodocsis Networks.
2453    See configs/res_pktccops.conf for more information.
2454
2455 XMPP Google Talk/Jingle changes
2456 -------------------------------
2457   * Added the externip option to gtalk.conf.
2458   * Added the stunaddr option to gtalk.conf which allows for the automatic
2459     retrieval of the external ip from a stun server.
2460
2461 Applications
2462 ------------
2463  * Added 'p' option to PickupChan() to allow for picking up channel by the first
2464    match to a partial channel name.
2465  * Added .m3u support for Mp3Player application.
2466  * Added progress option to the app_dial D() option.  When progress DTMF is
2467    present, those values are sent immediately upon receiving a PROGRESS message
2468    regardless if the call has been answered or not.
2469  * Added functionality to the app_dial F() option to continue with execution
2470    at the current location when no parameters are provided.
2471  * Added the 'a' option to app_dial to answer the calling channel before any
2472    announcements or macros are executed.
2473  * Modified app_dial to set answertime when the called channel answers even if
2474    the called channel hangs up during playback of an announcement.
2475  * Modified app_dial 'r' option to support an additional parameter to play an
2476    indication tone from indications.conf
2477  * Added c() option to app_chanspy. This option allows custom DTMF to be set
2478    to cycle through the next available channel.  By default this is still '*'.
2479  * Added x() option to app_chanspy.  This option allows DTMF to be set to
2480    exit the application.
2481  * The Voicemail application has been improved to automatically ignore messages
2482    that only contain silence.
2483  * If you set maxmsg to 0 in voicemail.conf, Voicemail will consider the
2484    associated mailbox(es) to be greetings-only.
2485  * The ChanSpy application now has the 'S' option, which makes the application
2486    automatically exit once it hits a point where no more channels are available
2487    to spy on.
2488  * The ChanSpy application also now has the 'E' option, which spies on a single
2489    channel and exits when that channel hangs up.
2490  * The MeetMe application now turns on the DENOISE() function by default, for
2491    each participant.  In our tests, this has significantly decreased background
2492    noise (especially noisy data centers).
2493  * Voicemail now permits storage of secrets in a separate file, located in the
2494    spool directory of each individual user.  The control for this is located in
2495    the "passwordlocation" option in voicemail.conf.  Please see the sample
2496    configuration for more information.
2497  * The ChanIsAvail application now exposes the returned cause code using a separate
2498    variable, AVAILCAUSECODE, instead of overwriting the device state in AVAILSTATUS.
2499  * Added 'd' option to app_followme.  This option disables the "Please hold"
2500    announcement.
2501  * Added 'y' option to app_record. This option enables a mode where any DTMF digit
2502    received will terminate recording.
2503  * Voicemail now supports per mailbox settings for folders when using IMAP storage.
2504    Previously the folder could only be set per context, but has now been extended
2505    using the imapfolder option.
2506  * Voicemail now supports per mailbox settings for nextaftercmd and minsecs.
2507  * Voicemail now allows the pager date format to be specified separately from the
2508    email date format.
2509  * New applications JabberJoin, JabberLeave, and JabberSendGroup have been added
2510    to allow joining, leaving, and sending text to group chats.
2511  * MeetMe has a new option 'G' to play an announcement before joining a conference.
2512  * Page has a new option 'A(x)' which will playback an announcement simultaneously
2513    to all paged phones (and optionally excluding the caller's one using the new
2514    option 'n') before the call is bridged.
2515  * The 'f' option to Dial has been augmented to take an optional argument. If no
2516    argument is provided, the 'f' option works as it always has. If an argument is
2517    provided, then the connected party information of all outgoing channels created
2518    during the Dial will be set to the argument passed to the 'f' option.
2519  * Dial now inherits the GOSUB_RETVAL from the peer, when the U() option runs a
2520    Gosub on the peer.
2521  * The OSP lookup application adds in/outbound network ID, optional security,
2522    number portability, QoS reporting, destination IP port, custom info and service
2523    type features.
2524  * Added new application VMSayName that will play the recorded name of the voicemail
2525    user if it exists, otherwise will play the mailbox number.
2526  * Added custom device states to ConfBridge bridges.  Use 'confbridge:<name>' to
2527    retrieve state for a particular bridge, where <name> is the conference name
2528  * app_directory now allows exiting at any time using the operator or pound key.
2529  * Voicemail now supports setting a locale per-mailbox.
2530  * Two new applications are provided for declining counting phrases in multiple
2531    languages.  See the application notes for SayCountedNoun and SayCountedAdj for
2532    more information.
2533  * Voicemail now runs the externnotify script when pollmailboxes is activated and
2534    notices a change.
2535  * Voicemail now includes rdnis within msgXXXX.txt file.
2536  * ExternalIVR now supports IPv6 addresses.
2537  * Added 'D' command to ExternalIVR. Details are available on the Asterisk wiki
2538    at https://wiki.asterisk.org/wiki/x/oQBB
2539  * ParkedCall and Park can now specify the parking lot to use.
2540
2541 Dialplan Functions
2542 ------------------
2543  * SRVQUERY and SRVRESULT functions added. This can be used to query and iterate
2544    over SRV records associated with a specific service. From the CLI, type
2545    'core show function SRVQUERY' and 'core show function SRVRESULT' for more
2546    details on how these may be used.
2547  * PITCH_SHIFT dialplan function added. This function can be used to modify the
2548    pitch of a channel's tx and rx audio streams.
2549  * Added new dialplan functions CONNECTEDLINE and REDIRECTING which permits
2550    setting various connected line and redirecting party information.
2551  * CALLERID and CONNECTEDLINE dialplan functions have been extended to
2552    support ISDN subaddressing.
2553  * The CHANNEL() function now supports the "name" and "checkhangup" options.
2554  * For DAHDI channels, the CHANNEL() dialplan function now allows
2555    the dialplan to request changes in the configuration of the active
2556    echo canceller on the channel (if any), for the current call only.
2557    The syntax is:
2558
2559    exten => s,n,Set(CHANNEL(echocan_mode)=off)
2560
2561    The possible values are:
2562
2563      on - normal mode (the echo canceller is actually reinitialized)
2564      off - disabled
2565      fax - FAX/data mode (NLP disabled if possible, otherwise completely
2566            disabled)
2567      voice - voice mode (returns from FAX mode, reverting the changes that
2568              were made when FAX mode was requested)
2569  * Added new dialplan function MASTER_CHANNEL(), which permits retrieving
2570    and setting variables on the channel which created the current channel.
2571    Administrators should take care to avoid naming conflicts, when multiple
2572    channels are dialled at once, especially when used with the Local channel
2573    construct (which all could set variables on the master channel).  Usage
2574    of the HASH() dialplan function, with the key set to the name of the slave
2575    channel, is one approach that will avoid conflicts.
2576  * Added new dialplan function MUTEAUDIO() for muting inbound and/or outbound
2577    audio in a channel.
2578  * func_odbc now allows multiple row results to be retrieved without using
2579    mode=multirow.  If rowlimit is set, then additional rows may be retrieved
2580    from the same query by using the name of the function which retrieved the
2581    first row as an argument to ODBC_FETCH().
2582  * Added JABBER_RECEIVE, which permits receiving XMPP messages from the
2583    dialplan. This function returns the content of the received message.
2584  * Added REPLACE, which searches a given variable name for a set of characters,
2585    then either replaces them with a single character or deletes them.
2586  * Added PASSTHRU, which literally passes the same argument back as its return
2587    value.  The intent is to be able to use a literal string argument to
2588    functions that currently require a variable name as an argument.
2589  * HASH-associated variables now can be inherited across channel creation, by
2590    prefixing the name of the hash at assignment with the appropriate number of
2591    underscores, just like variables.
2592  * GROUP_MATCH_COUNT has been improved to allow regex matching on category
2593  * CHANNEL(secure_bridge_signaling) and CHANNEL(secure_bridge_media) to set/get
2594    whether or not channels that are bridged to the current channel will be
2595    required to have secure signaling and/or media.
2596  * CHANNEL(secure_signaling) and CHANNEL(secure_media) to get whether or not
2597    the current channel has secure signaling and/or media.
2598  * For DAHDI/ISDN channels, the CHANNEL() dialplan function now supports the
2599    "no_media_path" option.
2600    Returns "0" if there is a B channel associated with the call.
2601    Returns "1" if no B channel is associated with the call.  The call is either
2602    on hold or is a call waiting call.
2603  * Added option to dialplan function CDR(), the 'f' option
2604    allows for high resolution times for billsec and duration fields.
2605  * FILE() now supports line-mode and writing.
2606  * Added FIELDNUM(), which returns the 1-based offset of a field in a list.
2607  * FRAME_TRACE(), for tracking internal ast_frames on a channel.
2608
2609 Dialplan Variables
2610 ------------------
2611  * Added DYNAMIC_FEATURENAME which holds the last triggered dynamic feature.
2612  * Added DYNAMIC_PEERNAME which holds the unique channel name on the other side
2613    and is set when a dynamic feature is triggered.
2614  * Added PARKINGLOT which can be used with parkeddynamic feature.conf option
2615    to dynamically create a new parking lot matching the value this varible is
2616    set to.
2617  * Added PARKINGDYNAMIC which represents the template parkinglot defined in
2618    features.conf that should be the base for dynamic parkinglots.
2619  * Added PARKINGDYNCONTEXT which tells what context a newly created dynamic
2620    parkinglot should have.
2621  * Added PARKINGDYNEXTEN which tells what parking exten a newly created dynamic
2622    parkinglot should have.
2623  * Added PARKINGDYNPOS which holds what parking positions a dynamic parkinglot
2624    should have.
2625
2626 Queue changes
2627 -------------
2628  * Added "ready" option to QUEUE_MEMBER counting to count free agents whose wrap-up
2629    timeout has expired.
2630  * Added 'R' option to app_queue.  This option stops moh and indicates ringing
2631    to the caller when an Agent's phone is ringing.  This can be used to indicate
2632    to the caller that their call is about to be picked up, which is nice when
2633    one has been on hold for an extened period of time.
2634  * A new config option, penaltymemberslimit, has been added to queues.conf.
2635    When set this option will disregard penalty settings when a queue has too
2636    few members.
2637  * A new option, 'I' has been added to both app_queue and app_dial.
2638    By setting this option, Asterisk will not update the caller with
2639    connected line changes or redirecting party changes when they occur.
2640  * A 'relative-periodic-announce' option has been added to queues.conf.  When
2641    enabled, this option will cause periodic announce times to be calculated
2642    from the end of announcements rather than from the beginning.
2643  * The autopause option in queues.conf can be passed a new value, "all." The
2644    result is that if a member becomes auto-paused, he will be paused in all
2645    queues for which he is a member, not just the queue that failed to reach
2646    the member.
2647  * Added dialplan function QUEUE_EXISTS to check if a queue exists
2648  * The queue logger now allows events to optionally propagate to a file,
2649    even when realtime logging is turned on.  Additionally, realtime logging
2650    supports sending the event arguments to 5 individual fields, although it
2651    will fallback to the previous data definition, if the new table layout is
2652    not found.
2653
2654 mISDN channel driver (chan_misdn) changes
2655 ----------------------------------------
2656  * Added display_connected parameter to misdn.conf to put a display string
2657    in the CONNECT message containing the connected name and/or number if
2658    the presentation setting permits it.
2659  * Added display_setup parameter to misdn.conf to put a display string
2660    in the SETUP message containing the caller name and/or number if the
2661    presentation setting permits it.
2662  * Made misdn.conf parameters localdialplan and cpndialplan take a -1 to
2663    indicate the dialplan settings are to be obtained from the asterisk
2664    channel.
2665  * Made misdn.conf parameter callerid accept the "name" <number> format
2666    used by the rest of the system.
2667  * Made use the nationalprefix and internationalprefix misdn.conf
2668    parameters to prefix any received number from the ISDN link if that
2669    number has the corresponding Type-Of-Number.  NOTE:  This includes
2670    comparing the incoming call's dialed number against the MSN list.
2671  * Added the following new parameters: unknownprefix, netspecificprefix,
2672    subscriberprefix, and abbreviatedprefix in misdn.conf to prefix any
2673    received number from the ISDN link if that number has the corresponding
2674    Type-Of-Number.
2675  * Added new dialplan application misdn_command which permits controlling
2676    the CCBS/CCNR functionality.
2677  * Added new dialplan function mISDN_CC which permits retrieval of various
2678    values from an active call completion record.
2679  * For PTP, you should manually send the COLR of the redirected-to party
2680    for an incomming redirected call if the incoming call could experience
2681    further redirects.  Just set the REDIRECTING(to-num,i) = ${EXTEN} and
2682    set the REDIRECTING(to-pres) to the COLR.  A call has been redirected
2683    if the REDIRECTING(from-num) is not empty.
2684  * For outgoing PTP redirected calls, you now need to use the inhibit(i)
2685    option on all of the REDIRECTING statements before dialing the
2686    redirected-to party.  You still have to set the REDIRECTING(to-xxx,i)
2687    and the REDIRECTING(from-xxx,i) values.  The PTP call will update the
2688    redirecting-to presentation (COLR) when it becomes available.
2689  * Added outgoing_colp parameter to misdn.conf to filter outgoing COLP
2690    information.
2691
2692 thirdparty mISDN enhancements
2693 -----------------------------
2694 mISDN has been modified by Digium, Inc. to greatly expand facility message
2695 support to allow:
2696   * Enhanced COLP support for call diversion and transfer.
2697   * CCBS/CCNR support.
2698
2699 The latest modified mISDN v1.1.x based version is available at:
2700 http://svn.digium.com/svn/thirdparty/mISDN/trunk
2701 http://svn.digium.com/svn/thirdparty/mISDNuser/trunk
2702
2703 Tagged versions of the modified mISDN code are available under:
2704 http://svn.digium.com/svn/thirdparty/mISDN/tags
2705 http://svn.digium.com/svn/thirdparty/mISDNuser/tags
2706
2707 libpri channel driver (chan_dahdi) DAHDI changes
2708 -------------------------------------------
2709  * The channel variable PRIREDIRECTREASON is now just a status variable
2710    and it is also deprecated.  Use the REDIRECTING(reason) dialplan function
2711    to read and alter the reason.
2712  * For Q.SIG and ETSI PRI/BRI-PTP, you should manually send the COLR of the
2713    redirected-to party for an incomming redirected call if the incoming call
2714    could experience further redirects.  Just set the
2715    REDIRECTING(to-num,i) = CALLERID(dnid) and set the REDIRECTING(to-pres)
2716    to the COLR.  A call has been redirected if the REDIRECTING(count) is not
2717    zero.
2718  * For outgoing Q.SIG and ETSI PRI/BRI-PTP redirected calls, you need to
2719    use the inhibit(i) option on all of the REDIRECTING statements before
2720    dialing the redirected-to party.  You still have to set the
2721    REDIRECTING(to-xxx,i) and the REDIRECTING(from-xxx,i) values.  The call
2722    will update the redirecting-to presentation (COLR) when it becomes available.
2723  * Added the ability to ignore calls that are not in a Multiple Subscriber
2724    Number (MSN) list for PTMP CPE interfaces.
2725  * Added dynamic range compression support for dahdi channels.  It is
2726    configured via the rxdrc and txdrc parameters in chan_dahdi.conf.
2727  * Added support for ISDN calling and called subaddress with partial support
2728    for connected line subaddress.
2729  * Added support for BRI PTMP NT mode. (Requires latest LibPRI.)
2730  * Added handling of received HOLD/RETRIEVE messages and the optional ability
2731    to transfer a held call on disconnect similar to an analog phone.
2732  * Added CallRerouting/CallDeflection support for Q.SIG, ETSI PTP, ETSI PTMP.
2733    Will reroute/deflect an outgoing call when receive the message.
2734    Can use the DAHDISendCallreroutingFacility to send the message for the
2735    supported switches.
2736  * Added standard location to add options to chan_dahdi dialing:
2737    Dial(DAHDI/g1[/extension[/options]])
2738    Current options:
2739    K(<keypad_digits>)
2740    R Reverse charging indication
2741  * Added Reverse Charging Indication (Collect calls) send/receive option.
2742    Send reverse charging in SETUP message with the chan_dahdi R dialing option.
2743    Dial(DAHDI/g1/extension/R)
2744    Access received reverse charge in SETUP message by: ${CHANNEL(reversecharge)}
2745    (requires latest LibPRI)
2746  * Added ability to send/receive keypad digits in the SETUP message.
2747    Send keypad digits in SETUP message with the chan_dahdi K(<keypad_digits>)
2748    dialing option.  Dial(DAHDI/g1/[extension]/K(<keypad_digits>))
2749    Access any received keypad digits in SETUP message by: ${CHANNEL(keypad_digits)}
2750    (requires latest LibPRI)
2751  * Added ability to send and receive ETSI Explicit Call Transfer (ECT) messages
2752    to eliminate tromboned calls.  A tromboned call goes out an interface and comes
2753    back into the same interface.  Tromboned calls happen because of call routing,
2754    call deflection, call forwarding, and call transfer.
2755  * Added the ability to send and receive ETSI Advice-Of-Charge messages.
2756  * Added the ability to support call waiting calls.  (The SETUP has no B channel
2757    assigned.)
2758  * Added Malicious Call ID (MCID) event to the AMI call event class.
2759  * Added Message Waiting Indication (MWI) support for ISDN PTMP endpoints (phones).
2760
2761 Asterisk Manager Interface
2762 --------------------------
2763  * The Hangup action now accepts a Cause header which may be used to
2764    set the channel's hangup cause.
2765  * sslprivatekey option added to manager.conf and http.conf.  Adds the ability
2766    to specify a separate .pem file to hold a private key.  By default sslcert
2767    is used to hold both the public and private key.
2768  * Options in manager.conf and http.conf with the 'ssl' prefix have been replaced
2769    for options containing the 'tls' prefix.  For example, 'sslenable' is now
2770    'tlsenable'.  This has been done in effort to keep ssl and tls options consistent
2771    across all .conf files. All affected sample.conf files have been modified to
2772    reflect this change.  Previous options such as 'sslenable' still work,
2773    but options with the 'tls' prefix are preferred.
2774  * Added a MuteAudio AMI action for muting inbound and/or outbound audio
2775    in a channel. (res_mutestream.so)
2776  * The configuration file manager.conf now supports a channelvars option, which
2777    specifies a list of channel variables to include in each channel-oriented
2778    event.
2779  * The redirect command now has new parameters ExtraContext, ExtraExtension,
2780    and ExtraPriority to allow redirecting the second channel to a different
2781    location than the first.
2782  * Added new event "JabberStatus" in the Jabber module to monitor buddies
2783    status.
2784  * Added a "MixMonitorMute" AMI action for muting inbound and/or outbound audio
2785    in a MixMonitor recording.
2786  * The 'iax2 show peers' output is now similar to the expected output of
2787    'sip show peers'.
2788  * Added Advice-Of-Charge events (AOC-S, AOC-D, and AOC-E) in the new
2789    aoc event class.
2790  * Added Advice-Of-Charge manager action, AOCMessage, for generating AOC-D and
2791    AOC-E messages on a channel.
2792  * A DBGetComplete event now follows a DBGetResponse, to make the DBGet action
2793    conform more closely to similar events.
2794  * Added a new eventfilter option per user to allow whitelisting and blacklisting
2795    of events.
2796  * Added optional parkinglot variable for park command.
2797  * Added ConnectedLineNum and ConnectedLineName headers to AMI events/responses
2798    if CallerIDNum and CallerIDName headers are also present.
2799
2800 Channel Event Logging
2801 ---------------------
2802  * A new interface, CEL, is introduced here. CEL logs single events, much like
2803    the AMI, but it differs from the AMI in that it logs to db backends much
2804    like CDR does; is based on the event subsystem introduced by Russell, and
2805    can share in all its benefits; allows multiple backends to operate like CDR;
2806    is specialized to event data that would be of concern to billing sytems,
2807    like CDR. Backends for logging and accounting calls have been produced,
2808    but a new CDR backend is still in development.
2809
2810 CDR
2811 ---
2812  * 'linkedid' and 'peeraccount' are new CDR fields available to CDR aficionados.
2813    linkedid is based on uniqueID, but spreads to other channels as transfers, dials,
2814    etc are performed. Thus the pieces of CDR can be grouped into multilegged sets.
2815  * Multiple files and formats can now be specified in cdr_custom.conf.
2816  * cdr_syslog has been added which allows CDRs to be written directly to syslog.
2817    See configs/cdr_syslog.conf.sample for more information.
2818  * A 'sequence' field has been added to CDRs which can be combined with
2819    linkedid or uniqueid to uniquely identify a CDR.
2820  * Handling of billsec and duration field has changed. If your table definition
2821    specifies those fields as float,double or similar they will now be logged with
2822    microsecond accuracy instead of a whole integer.
2823
2824 Calendaring for Asterisk
2825 ------------------------
2826  * A new set of modules were added supporing calendar integration with Asterisk.
2827    Dialplan functions for reading from and writing to calendars are included,
2828    as well as the ability to execute dialplan logic upon calendar event notifications.
2829    iCalendar, CalDAV, and Exchange Server calendars (via res_calendar_exchange for
2830    Exchange Server 2003 with no write or attendee support, and res_calendar_ews for
2831    Exchange Server 2007+ with full write and attendee support) are supported (Exchange
2832    2003 support does not support forms-based authentication).
2833
2834 Call Completion Supplementary Services for Asterisk
2835 ---------------------------------------------------
2836  * Call completion support has been added for SIP, DAHDI/ISDN, and DAHDI/analog.
2837    DAHDI/ISDN supports call completion for the following switch types:
2838    EuroIsdn(ETSI) for PTP and PTMP modes, and Qsig.
2839    See https://wiki.asterisk.org/wiki/x/2ABQ for details.
2840
2841 Multicast RTP Support
2842 ---------------------
2843  * A new RTP engine and channel driver have been added which supports Multicast RTP.
2844    The channel driver can be used with the Page application to perform multicast RTP
2845    paging. The dial string format is: MulticastRTP/<type>/<destination>/<control address>
2846    Type can be either basic or linksys.
2847    Destination is the IP address and port for the RTP packets.
2848    Control address is specific to the linksys type and is used for sending the control
2849    packets unique to them.
2850
2851 Security Events Framework
2852 -------------------------
2853  * Asterisk has a new C API for reporting security events.  The module res_security_log
2854    sends these events to the "security" logger level.  Currently, AMI is the only
2855    Asterisk component that reports security events.  However, SIP support will be
2856    coming soon.  For more information on the security events framework, see the
2857    "Asterisk Security Framework" section of the Asterisk wiki at
2858    https://wiki.asterisk.org/wiki/x/wgBQ
2859  * SIP support was added in Asterisk 10
2860  * This API now supports IPv6 addresses
2861
2862 Fax
2863 ---
2864  * A technology independent fax frontend (res_fax) has been added to Asterisk.
2865  * A spandsp based fax backend (res_fax_spandsp) has been added.
2866  * The app_fax module has been deprecated in favor of the res_fax module and
2867    the new res_fax_spandsp backend.
2868  * The SendFAX and ReceiveFAX applications now send their log messages to a
2869    'fax' logger level, instead of to the generic logger levels. To see these
2870    messages, the system's logger.conf file will need to direct the 'fax' logger
2871    level to one or more destinations; the logger.conf.sample file includes an
2872    example of how to do this. Note that if the 'fax' logger level is *not*
2873    directed to at least one destination, log messages generated by these
2874    applications will be lost, and that if the 'fax' logger level is directed to
2875    the console, the 'core set verbose' and 'core set debug' CLI commands will
2876    have no effect on whether the messages appear on the console or not.
2877
2878 Miscellaneous
2879 -------------
2880  * The transmit_silence_during_record option in asterisk.conf.sample has been removed.
2881    Now, in order to enable transmitting silence during record the transmit_silence
2882    option should be used.  transmit_silence_during_record remains a valid option, but
2883    defaults to the behavior of the transmit_silence option.
2884  * Addition of the Unit Test Framework API for managing registration and execution
2885    of unit tests with the purpose of verifying the operation of C functions.
2886  * SendText is now implemented in chan_gtalk and chan_jingle. It will simply send
2887    XMPP text messages to the remote JID.
2888  * Modules.conf has a new option - "require" - that marks a module as critical for
2889    the execution of Asterisk.
2890    If one of the required modules fail to load, Asterisk will exit with a return
2891    code set to 2.
2892  * An 'X' option has been added to the asterisk application which enables #exec support.
2893    This allows #exec to be used in asterisk.conf.
2894  * jabber.conf supports a new option auth_policy that toggles auto user registration.
2895  * A new lockconfdir option has been added to asterisk.conf to protect the
2896    configuration directory (/etc/asterisk by default) during reloads.
2897  * The parkeddynamic option has been added to features.conf to enable the creation
2898    of dynamic parkinglots.
2899  * chan_dahdi now supports reporting alarms over AMI either by channel or span via
2900    the reportalarms config option.
2901  * chan_dahdi supports dialing configuring and dialing by device file name.
2902    DAHDI/span-name!local!1 will use /dev/dahdi/span-name/local/1 . Likewise
2903    it may appear in chan_dahdi.conf as 'channel => span-name!local!1'.
2904  * A new options for chan_dahdi.conf: 'ignore_failed_channels'. Boolean.
2905    False by default. If set, chan_dahdi will ignore failed 'channel' entries.
2906    Handy for the above name-based syntax as it does not depend on
2907    initialization order.
2908  * The Realtime dialplan switch now caches entries for 1 second.  This provides a
2909    significant increase in performance (about 3X) for installations using this switchtype.
2910  * Distributed devicestate now supports the use of the XMPP protocol, in addition to
2911    AIS.  For more information, please see the Distributed Device State section of the
2912    Asterisk wiki at https://wiki.asterisk.org/wiki/x/jw4iAQ
2913  * The addition of G.719 pass-through support.
2914  * Added support for 16khz Speex audio.  This can be enabled by using 'allow=speex16'
2915    during device configuration.
2916  * The UNISTIM channel driver (chan_unistim) has been updated to support devices that
2917    have less than 3 lines on the LCD.
2918  * Realtime now supports database failover.  See the sample extconfig.conf for details.
2919  * The addition of improved translation path building for wideband codecs.  Sample
2920    rate changes during translation are now avoided unless absolutely necessary.
2921  * The addition of the res_stun_monitor module for monitoring and reacting to network
2922    changes while behind a NAT.
2923  * DTMF: Normal and Reverse Twist acceptance values can be set in dsp.conf.
2924    DTMF Valid/Invalid number of hits/misses can be set in dsp.conf.
2925    These allow support for any Administration. Default is AT&T values.
2926
2927 CLI Changes
2928 -----------
2929  * The 'core set debug' and 'core set verbose' commands, in previous versions, could
2930    optionally accept a filename, to apply the setting only to the code generated from
2931    that source file when Asterisk was built. However, there are some modules in Asterisk
2932    that are composed of multiple source files, so this did not result in the behavior
2933    that users expected. In this version, 'core set debug' and 'core set verbose'
2934    can optionally accept *module* names instead (with or without the .so extension),
2935    which applies the setting to the entire module specified, regardless of which source
2936    files it was built from.
2937  * New 'manager show settings' command showing the current settings loaded from
2938    manager.conf.
2939  * Added 'all' keyword to the CLI command "channel request hangup" so that you can send
2940    the channel hangup request to all channels.
2941  * Added a "core reload" CLI command that executes a global reload of Asterisk.
2942
2943 ------------------------------------------------------------------------------
2944 --- Functionality changes from Asterisk 1.6.1 to Asterisk 1.6.2  -------------
2945 ------------------------------------------------------------------------------
2946
2947 SIP Changes
2948 -----------
2949  * Added support for SUBSCRIBE/NOTIFY with dialog-info based call pickups.
2950    Snom phones use this for call pickup of extensions that the phone is
2951    subscribed to.
2952  * Added support for setting the domain in the URI for caller of an
2953    outbound call by using the SIPFROMDOMAIN channel variable.
2954  * Added a new configuration option "remotesecret" for authentication to
2955    remote services. For backwards compatibility, "secret" still has the
2956    same function as before, but now you can configure both a remote secret and a
2957    local secret for mutual authentication.
2958  * If the channel variable  ATTENDED_TRANSFER_COMPLETE_SOUND is set,
2959    the sound will be played to the target of an attended transfer
2960  * Added two new configuration options, "qualifygap" and "qualifypeers", which allow
2961    finer control over how many peers Asterisk will qualify and the gap between them
2962    when all peers need to be qualified at the same time.
2963  * Added a new 'ignoresdpversion' option to sip.conf.  When this is enabled
2964    (either globally or for a specific peer), chan_sip will treat any SDP data
2965    it receives as new data and update the media stream accordingly.  By
2966    default, Asterisk will only modify the media stream if the SDP session
2967    version received is different from the current SDP session version.  This
2968    option is required to interoperate with devices that have non-standard SDP
2969    session version implementations (observed with Microsoft OCS).  This option
2970    is disabled by default.
2971  * The parsing of register => lines in sip.conf has been modified to allow a port
2972    to be present in the "user" portion. Please see the sip.conf.sample file for more
2973    information
2974  * Added support for subscribing to MWI on a remote server and making the status available
2975    as a mailbox. Please see the sip.conf.sample file for more information.
2976  * Added a function to remove SIP headers added in the dialplan before the
2977    first INVITE is generated - SIPRemoveHeader()
2978  * Channel variables set with setvar= in a device configuration is now
2979    set both for inbound and outbound calls.
2980  * Added support for ITU G.722.1 and G.722.1C (Siren7 and Siren14) media streams.
2981
2982 IAX2 changes
2983 ------------
2984   * Added immediate option to iax.conf
2985   * Added forceencryption option to iax.conf
2986   * Added Encryption and Trunk status to manager command "iaxpeers"
2987
2988 Skinny Changes
2989 --------------
2990  * The configuration file now holds separate sections for devices and lines.
2991    Please have a look at configs/skinny.conf.sample and change your skinny.conf
2992    accordingly.
2993
2994 DAHDI Changes
2995 -------------
2996  * chan_dahdi now supports MFC/R2 signaling when Asterisk is compiled with
2997    support for LibOpenR2.  http://www.libopenr2.org/
2998  * The UK option waitfordialtone has been added for use with BT analog
2999    lines.
3000  * Added a 'faxbuffers' configuration option to chan_dahdi.conf.  This option
3001    is used in conjunction with the 'faxdetect' configuration option.  When
3002    'faxbuffers' is used and fax tones are detected, the channel will dynamically
3003    switch to the configured faxbuffers policy.  For example, to use 6 buffers
3004    and a 'full' buffer policy for a fax transmission, add:
3005      faxbuffers=>6,full
3006    The faxbuffers configuration will be in affect until the call is torn down.
3007  * Added service message support for 4ESS/5ESS switches.
3008
3009 Dialplan Functions
3010 ------------------
3011  * For DAHDI channels, the CHANNEL() dialplan function now
3012    supports changing the channel's buffer policy (for the current
3013    call only), using this syntax:
3014
3015    exten => s,n,Set(CHANNEL(buffers)=6,full)
3016
3017    This would change the channel to the 'full' buffer policy and
3018    6 (six) buffers. Possible options for this setting are the same
3019    as those in chan_dahdi.conf.
3020  * Added a new dialplan function, CURLOPT, which permits setting various
3021    options that may be useful with the CURL dialplan function, such as
3022    cookies, proxies, connection timeouts, passwords, etc.
3023  * Permit the syntax and synopsis fields of the corresponding dialplan
3024    functions to be individually set from func_odbc.conf.
3025  * Added debugging CLI functions to func_odbc, 'odbc read' and 'odbc write'.
3026  * func_odbc now may specify an insert query to execute, when the write query
3027    affects 0 rows (usually indicating that no such row exists).
3028  * Added a new dialplan function, LISTFILTER, which permits removing elements
3029    from a set list, by name.  Uses the same general syntax as the existing CUT
3030    and FIELDQTY dialplan functions, which also manage lists.
3031  * Added REALTIME_FIELD and REALTIME_HASH, which should aid users in better
3032    obtaining realtime data from the dialplan.
3033  * Added LOCAL_PEEK, which allows access to variables in any stack frame within
3034    a subroutine when using the GoSub() and Return() applications.
3035  * Added AUDIOHOOK_INHERIT. For information on its use, please see the output
3036    of "core show function AUDIOHOOK_INHERIT" from the CLI
3037  * Added AES_ENCRYPT. For information on its use, please see the output
3038    of "core show function AES_ENCRYPT" from the CLI
3039  * Added AES_DECRYPT. For information on its use, please see the output
3040    of "core show function AES_DECRYPT" from the CLI
3041  * func_odbc now supports database transactions across multiple queries.
3042
3043 Applications
3044 ------------
3045  * Scheduled meetme conferences may now have their end times extended by
3046    using MeetMeAdmin.
3047  * app_authenticate now gives the ability to select a prompt other than
3048    the default.
3049  * app_directory now pays attention to the searchcontexts setting in
3050    voicemail.conf and will look through all contexts, if no context is
3051    specified in the initial argument.
3052  * A new application, Originate, has been introduced, that allows asynchronous
3053    call origination from the dialplan.
3054  * Voicemail now permits setting the emailsubject and emailbody per mailbox,
3055    in addition to the setting in the "general" context.
3056  * Added ConfBridge dialplan application which does conference bridges without
3057    DAHDI. For information on its use, please see the output of
3058    "core show application ConfBridge" from the CLI.
3059
3060 Miscellaneous
3061 -------------
3062  * The Asterisk CLI has a new command, "channel redirect", which is similar in
3063    operation to the AMI Redirect action.
3064  * extensions.conf now allows you to use keyword "same" to define an extension
3065    without actually specifying an extension.  It uses exactly the same pattern
3066    as previously used on the last "exten" line.  For example:
3067      exten => 123,1,NoOp(something)
3068      same  =>     n,SomethingElse()
3069  * musiconhold.conf classes of type 'files' can now use relative directory paths,
3070    which are interpreted as relative to the astvarlibdir setting in asterisk.conf.
3071  * All deprecated CLI commands are removed from the sourcecode. They are now handled
3072    by the new clialiases module. See cli_aliases.conf.sample file.
3073  * Times within timespecs are now accurate down to the minute.  This is a change
3074    from historical Asterisk, which only provided timespecs rounded to the nearest
3075    even (read: evenly divisible by 2) minute mark.
3076  * The realtime switch now supports an option flag, 'p', which disables searches for
3077    pattern matches.
3078  * In addition to a time range and date range, timespecs now accept a 5th optional
3079    argument, timezone.  This allows you to perform time checks on alternate
3080    timezones, especially if those daylight savings time ranges vary from your
3081    machine's native timezone.  See GotoIfTime, ExecIfTime, IFTIME(), and timed
3082    includes.
3083  * The contrib/scripts/ directory now has a script called sip_nat_settings that will
3084    give you the correct output for an asterisk box behind nat. It will give you the
3085    externhost and localnet settings.
3086  * The Asterisk core now supports ITU G.722.1 and G.722.1C media streams, and
3087    can connect calls in passthrough mode, as well as record and play back files.
3088  * Successful and unsuccessful call pickup can now be alerted through sounds, by
3089    using pickupsound and pickupfailsound in features.conf.
3090  * ASTVARRUNDIR is now set to $(localstatedir)/run/asterisk by default.
3091    This means the asterisk pid file will now be in /var/run/asterisk/asterisk.pid on LINUX
3092    instead of the /var/run/asterisk.pid where it used to be. This will make
3093    installs as non-root easier to manage.
3094
3095 CDR
3096 ---
3097
3098 * The cdr.conf file must exist and be correctly programmed in order for CDR records to
3099   be written; they will no longer be explicitly written.
3100
3101 Asterisk Manager Interface
3102 --------------------------
3103  * When using the AMI over HTTP, you can now include a 'SuppressEvents' header (with
3104    a non-empty value) in your request. If you do this, any pending AMI events will
3105    *not* be included in the response to your request as they would normally, but
3106    will be left in the event queue for the next request you make to retrieve. For
3107    some applications, this will allow you to guarantee that you will only see
3108    events in responses to 'WaitEvent' actions, and can better know when to expect them.
3109    To know whether the Asterisk server supports this header or not, your client can
3110    inspect the first response back from the server to see if it includes this header:
3111
3112    Pragma: SuppressEvents
3113
3114    If this is included, the server supports event suppression.
3115
3116  * Added 4 new Actions to list skinny device(s) and line(s)
3117    SKINNYdevices
3118    SKINNYshowdevice
3119    SKINNYlines
3120    SKINNYshowline
3121
3122 LDAP Schema File Additions
3123 --------------------------
3124  * Added AsteriskDialplan, AsteriskAccount and AsteriskMailbox  objectClasses
3125    to allow standalone dialplan, account and mailbox entries (STRUCTURAL)
3126  * Added new Fields:
3127    - AstAccountLanguage, AstAccountTransport, AstAccountPromiscRedir,
3128    - AstAccountAccountCode, AstAccountSetVar, AstAccountAllowOverlap,
3129    - AstAccountVideoSupport, AstAccountIgnoreSDPVersion
3130  * Removed redundant IPaddr (there's already IPAddress)
3131    - Gives more configuration Flags for SIP-Users available (tested)
3132    - Allows to create Asterisk Attributes in defined Asterisk ObjectClasses
3133      without extensibleObject (which really should be the last resort); gives
3134      also additional possibilities for LDAP-filter
3135
3136 ------------------------------------------------------------------------------
3137 --- Functionality changes from Asterisk 1.6.0 to Asterisk 1.6.1  -------------
3138 ------------------------------------------------------------------------------
3139
3140 Device State Handling
3141 ---------------------
3142  * The event infrastructure in Asterisk got another big update to help support
3143    distributed events.  It currently supports distributed device state and
3144    distributed Voicemail MWI (Message Waiting Indication).  A new module has
3145    been merged, res_ais, which facilitates communicating events between servers.
3146    It uses the SAForum AIS (Service Availability Forum Application Interface
3147    Specification) CLM (Cluster Management) and EVT (Event) services to maintain
3148    a cluster of Asterisk servers, and to share events between them.  For more
3149    information on setting this up, refer to the Distributed Device State section
3150    of the Asterisk wiki at https://wiki.asterisk.org/wiki/x/jw4iAQ
3151
3152 Dialplan Functions
3153 ------------------
3154  * Added a new dialplan function, AST_CONFIG(), which allows you to access
3155    variables from an Asterisk configuration file.
3156  * The JACK_HOOK function now has a c() option to supply a custom client name.
3157  * Added two new dialplan functions from libspeex for audio gain control and
3158    denoise, AGC() and DENOISE(). Both functions can be applied to the tx and
3159    rx directions of a channel from the dialplan.
3160  * The SMDI_MSG_RETRIEVE function now has the ability to search for SMDI messages
3161    based on other parameters.  The default is still to search based on the
3162    forwarding station ID.  However, there are new options that allow you to search
3163    based on the message desk terminal ID, or the message desk number.
3164  * TIMEOUT() has been modified to be accurate down to the millisecond.
3165  * ENUM*() functions now include the following new options:
3166      - 'u' returns the full URI and does not strip off the URI-scheme.
3167      - 's' triggers ISN specific rewriting
3168      - 'i' looks for branches into an Infrastructure ENUM tree
3169      - 'd' for a direct DNS lookup without any flipping of digits.
3170  * TXCIDNAME() has a new zone-suffix parameter (which defaults to 'e164.arpa')
3171  * CHANNEL() now has options for the maximum, minimum, and standard or normal
3172    deviation of jitter, rtt, and loss for a call using chan_sip.
3173
3174 DAHDI channel driver (chan_dahdi) Changes
3175 ----------------------------------------
3176  * Channels can now be configured using named sections in chan_dahdi.conf, just
3177    like other channel drivers, including the use of templates.
3178  * The default for pridialplan has changed from 'national' to 'unknown'.
3179
3180 PBX Changes
3181 -----------
3182  * It is now possible to specify a pattern match as a hint. Once a phone subscribes
3183    to something that matches the pattern a hint will be created using the contents
3184    and variables evaluated.
3185  * Dialplan matching has been extended to allow an extension to return to the
3186    PBX core to wait for more digits.  This is done by using the new dialplan
3187    application called "Incomplete".  This will permit a whole new level of
3188    extension control, by giving the administrator more control over early
3189    matches employing one of the short-circuit pattern match operators.  Note
3190    that custom applications can trigger this same behavior by returning the
3191    special value AST_PBX_INCOMPLETE.
3192
3193 Application Changes
3194 -------------------
3195  * Directory now permits both first and last names to be matched at the same
3196    time.  In addition, the number of digits to enter of the name can be set in
3197    the arguments to Directory; previously, you could enter only 3, regardless
3198    of how many names are in your company.  For large companies, this should be
3199    quite helpful.
3200  * Voicemail now permits a mailbox setting to wrap around from first to last
3201    messages, if the "messagewrap" option is set to a true value.
3202  * Voicemail now permits an external script to be run, for password validation.
3203    The script should output "VALID" or "INVALID" on stdout, depending upon the
3204    wish to validate or invalidate the password given.  Arguments are:
3205    "mailbox" "context" "oldpass" "newpass".  See the sample voicemail.conf for
3206    more details
3207  * Dial has a new option: F(context^extension^pri), which permits a callee to
3208    continue in the dialplan, at the specified label, if the caller hangs up.
3209  * ChanSpy and ExtenSpy have a new option, 's' which suppresses speaking the
3210    technology name (e.g. SIP, IAX, etc) of the channel being spied on.
3211  * The Jack application now has a c() option to supply a custom client name.
3212  * Chanspy has a new option, 'B', which can be used to "barge" on a call. This is
3213    like the pre-existing whisper mode, except that the spy can also talk to the
3214    participant on the bridged channel as well.
3215  * Chanspy has a new option, 'n', which will allow for the spied-on party's name
3216    to be spoken instead of the channel name or number. For more information on the
3217    use of this option, issue the command "core show application ChanSpy" from the
3218    Asterisk CLI.
3219  * Chanspy has a new option, 'd', which allows the spy to use DTMF to swap between
3220    spy modes. Use of this feature overrides the typical use of numeric DTMF. In other
3221    words, if using the 'd' option, it is not possible to enter a number to append to
3222    the first argument to Chanspy(). Pressing 4 will change to spy mode, pressing 5 will
3223    change to whisper mode, and pressing 6 will change to barge mode.
3224  * ExternalIVR now takes several options that affect the way it performs, as
3225    well as having several new commands.  Please see the External IVR page on the Asterisk
3226    wiki for complete documentation: https://wiki.asterisk.org/wiki/x/oQBB
3227  * Added ability to communicate over a TCP socket instead of forking a child process for the
3228    ExternalIVR application.
3229  * ChanIsAvail has a new option, 'a', which will return all available channels instead
3230    of just the first one if you give the function more then one channel to check.
3231  * PrivacyManager now takes an option where you can specify a context where the
3232    given number will be matched. This way you have more control over who is allowed
3233    and it stops the people who blindly enter 10 digits.
3234  * ForkCDR has new options: 'a' updates the answer time on the new CDR; 'A' locks
3235    answer times, disposition, on orig CDR against updates; 'D' Copies the disposition
3236    from the orig CDR to the new CDR after reset; 'e' sets the 'end' time on the
3237    original CDR; 'R' prevents the new CDR from being reset; 's(var=val)' adds/changes
3238    the 'var' variable on the original CDR; 'T' forces ast_cdr_end(), ast_cdr_answer(),
3239    obey the LOCKED flag on cdr's in the chain, and also the ast_cdr_setvar() func.
3240  * The Dial() application no longer copies the language used by the caller to the callee's
3241    channel. If you desire for the caller's channel's language to be used for file playback
3242    to the callee, then the file specified may be prepended with "${CHANNEL(language)}/" .
3243  * SendImage() no longer hangs up the channel on error; instead, it sets the
3244    status variable SENDIMAGESTATUS to one of 'SUCCESS', 'FAILURE', or
3245    'UNSUPPORTED'.  This change makes SendImage() more consistent with other
3246    applications.
3247  * Park has a new option, 's', which silences the announcement of the parking space number.
3248  * A non-numeric, zero, or negative timeout specified to Dial() will now be interpreted as
3249    invalid input and will be assumed to mean that no timeout is desired.
3250
3251 SIP Changes
3252 -----------
3253  * Added DNS manager support to registrations for peers referencing peer entries.
3254    DNS manager runs in the background which allows DNS lookups to be run asynchronously
3255    as well as periodically updating the IP address. These properties allow for
3256    better performance as well as recovery in the event of an IP change.
3257  * Performance improvements via using hash tables (astobj2) and doubly-linked lists to improve
3258    load/reload of large numbers of peers/users by ~40x (for large lists of peers).
3259    These changes also provide performance improvements for call setup and tear down.
3260  * Added ability to specify registration expiry time on a per registration basis in
3261    the register line.
3262  * Added support for T140 RED - redundancy in T.140 to prevent text loss due to
3263    lost packets.
3264  * Added t38pt_usertpsource option. See sip.conf.sample for details.
3265  * Added SIPnotify AMI command, for sending arbitrary SIP notify commands.
3266  * 'sip show peers' and 'sip show users' display their entries sorted in
3267     alphabetical order, as opposed to the order they were in, in the config
3268     file or database.
3269  * Videosupport now supports an additional option, "always", which always sets
3270     up video RTP ports, even on clients that don't support it.  This helps with
3271     callfiles and certain transfers to ensure that if two video phones are
3272     connected, they will always share video feeds.
3273
3274 IAX Changes
3275 -----------
3276  * Existing DNS manager lookups extended to check for SRV records.
3277  * IAX2 encryption support has been improved to support periodic key rotation
3278    within a call for enhanced security.  The option "keyrotate" has been
3279    provided to disable this functionality to preserve backwards compatibility
3280    with older versions of IAX2 that do not support key rotation.
3281
3282 CLI Changes
3283 -----------
3284   * New CLI command, "data get <path> [<search> [<filter>]]" which retrieves the
3285      data tree based on the given <path>.
3286   * New CLI command "data show providers" that will display all the registered
3287      callbacks.
3288   * New CLI command, "config reload <file.conf>" which reloads any module that
3289      references that particular configuration file.  Also added "config list"
3290      which shows which configuration files are in use.
3291   * New CLI commands, "pri show version" and "ss7 show version" that will
3292      display which version of libpri and libss7 are being used, respectively.
3293      A new API call was added so trunk will now have to be compiled against
3294      a versions of libpri and libss7 that have them or it will not know that
3295      these libraries exist.
3296   * The commands "core show globals", "core set global" and "core set chanvar" has
3297      been deprecated in favor of the more semanticly correct "dialplan show globals",
3298      "dialplan set chanvar" and "dialplan set global".
3299   * New CLI command "dialplan show chanvar" to list all variables associated
3300     with a given channel.
3301
3302 DNS manager changes
3303 -------------------
3304   * Addresses managed by DNS manager now can check to see if there is a DNS
3305     SRV record for a given domain and will use that hostname/port if present.
3306
3307 AMI - The manager (TCP/TLS/HTTP)
3308 --------------------------------
3309   * The Status command now takes an optional list of variables to display
3310     along with channel status.
3311   * The QueueEntry event now also includes the channel's uniqueid
3312
3313 ODBC Changes
3314 ------------
3315   * res_odbc no longer has a limit of 1023 total possible unshared connections,
3316     as some people were running into this limit.  This limit has been increased
3317     to 4.2 billion.
3318
3319 Queue changes
3320 -------------
3321   * The TRANSFER queue log entry now includes the the caller's original
3322     position in the transferred-from queue.
3323   * A new configuration option, "timeoutpriority" has been added. Please see the section labeled
3324     "QUEUE TIMING OPTIONS" in configs/queues.conf.sample for a detailed explanation of the option
3325     as well as an explanation about timeout options in general
3326   * Added a new option - C - for forcing the "answered elsewhere" flag on
3327     cancellation of calls in to members of the queue. This is to avoid the
3328     call to a member of a queue having the call listed as a "missed call".
3329
3330 Realtime changes
3331 ----------------
3332   * Several (ODBC, Postgres, MySQL, SQLite) realtime drivers have been given
3333     adaptive capabilities.  What this means in practical terms is that if your
3334     realtime table lacks critical fields, Asterisk will now emit warnings to
3335     that effect.  Also, some of the realtime drivers have the ability (if
3336     configured) to automatically add those columns to the table with the
3337     correct type and length.
3338
3339 Miscellaneous
3340 -------------
3341   * The channel variable ATTENDED_TRANSFER_COMPLETE_SOUND can now be set using
3342     the 'setvar' option to cause a given audio file to be played upon completion
3343     of an attended transfer.  Currently it works for DAHDI, IAX2, SIP, and
3344     Skinny channels only.
3345   * You can now compile Asterisk against the Hoard Memory Allocator, see the
3346     Hoard page on the Asterisk wiki for more information:
3347     https://wiki.asterisk.org/wiki/x/pQBB
3348   * Config file variables may now be appended to, by using the '+=' append
3349     operator.  This is most helpful when working with long SQL queries in
3350     func_odbc.conf, as the queries no longer need to be specified on a single
3351     line.
3352   * CDR config file, cdr.conf, has an added option, "initiatedseconds",
3353     which will add a second to the billsec when the ending
3354     time is set, if the number in the microseconds field of the end time is
3355     greater than the number of microseconds in the answer time. This allows
3356     users to count the 'initiated' seconds in their billing records.
3357
3358 ------------------------------------------------------------------------------
3359 --- Functionality changes from Asterisk 1.4.X to Asterisk 1.6.0  -------------
3360 ------------------------------------------------------------------------------
3361
3362 AMI - The manager (TCP/TLS/HTTP)
3363 --------------------------------
3364   * Manager has undergone a lot of changes, all of them documented
3365     on the Asterisk wiki at https://wiki.asterisk.org/wiki/x/tQBB
3366   * Manager version has changed to 1.1
3367   * Added a new action 'CoreShowChannels' to list currently defined channels
3368      and some information about them.
3369   * Added a new action 'SIPshowregistry' to list SIP registrations.
3370   * Added TLS support for the manager interface and HTTP server
3371   * Added the URI redirect option for the built-in HTTP server
3372   * The output of CallerID in Manager events is now more consistent.
3373      CallerIDNum is used for number and CallerIDName for name.
3374   * Enable https support for builtin web server.
3375      See configs/http.conf.sample for details.
3376   * Added a new action, GetConfigJSON, which can return the contents of an
3377      Asterisk configuration file in JSON format.  This is intended to help
3378      improve the performance of AJAX applications using the manager interface
3379      over HTTP.
3380   * SIP and IAX manager events now use "ChannelType" in all cases where we
3381      indicate channel driver. Previously, we used a mixture of "Channel"
3382      and "ChannelDriver" headers.
3383   * Added a "Bridge" action which allows you to bridge any two channels that
3384      are currently active on the system.
3385   * Added a "ListAllVoicemailUsers" action that allows you to get a list of all
3386      the voicemail users setup.
3387   * Added 'DBDel' and 'DBDelTree' manager commands.
3388   * cdr_manager now reports events via the "cdr" level, separating it from
3389      the very verbose "call" level.
3390   * Manager users are now stored in memory. If you change the manager account
3391     list (delete or add accounts) you need to reload manager.
3392   * Added Masquerade manager event for when a masquerade happens between
3393      two channels.
3394   * Added "manager reload" command for the CLI
3395   * Lots of commands that only provided information are now allowed under the
3396      Reporting privilege, instead of only under Call or System.
3397   * The IAX* commands now require either System or Reporting privilege, to
3398      mirror the privileges of the SIP* commands.
3399   * Added ability to retrieve list of categories in a config file.
3400   * Added ability to retrieve the content of a particular category.
3401   * Added ability to empty a context.
3402   * Created new action to create a new file.
3403   * Updated delete action to allow deletion by line number with respect to category.
3404   * Added new action insert to add new variable to category at specified line.
3405   * Updated action newcat to allow new category to be inserted in file above another
3406     existing category.
3407   * Added new event "JitterBufStats" in the IAX2 channel
3408   * Originate now requires the Originate privilege and, if you want to call out
3409     to a subshell, it requires the System privilege, as well.  This was done to
3410     enhance manager security.
3411   * Originate now accepts codec settings with "Codecs: alaw, ulaw, h264"
3412   * New command: Atxfer. See https://wiki.asterisk.org/wiki/x/uABB for more details
3413     or manager show command Atxfer from the CLI
3414   * New command: IAXregistry. See https://wiki.asterisk.org/wiki/x/uABB for more
3415     details or manager show command IAXregistry from the CLI
3416
3417 Dialplan functions
3418 ------------------
3419   * Added the DEVICE_STATE() dialplan function which allows retrieving any device
3420      state in the dialplan, as well as creating custom device states that are
3421      controllable from the dialplan.
3422   * Extend CALLERID() function with "pres" and "ton" parameters to
3423      fetch string representation of calling number presentation indicator
3424      and numeric representation of type of calling number value.
3425   * MailboxExists converted to dialplan function
3426   * A new option to Dial() for telling IP phones not to count the call
3427      as "missed" when dial times out and cancels.
3428   * Added LOCK(), TRYLOCK(), and UNLOCK(), which provide a single level dialplan
3429      mutex.  No deadlocks are possible, as LOCK() only allows a single lock to be
3430      held for any given channel.  Also, locks are automatically freed when a
3431      channel is hung up.
3432   * Added HINT() dialplan function that allows retrieving hint information.
3433      Hints are mappings between extensions and devices for the sake of
3434      determining the state of an extension.  This function can retrieve the list
3435      of devices or the name associated with a hint.
3436   * Added EXTENSION_STATE() dialplan function which allows retrieving the state
3437     of any extension.
3438   * Added SYSINFO() dialplan function which allows retrieval of system information
3439   * Added a new dialplan function, DIALPLAN_EXISTS(), which allows you to check for
3440      the existence of a dialplan target.
3441   * Added two new dialplan functions, TOUPPER and TOLOWER, which convert a string to
3442      upper and lower case, respectively.
3443   * When bridging, Asterisk sets the BRIDGEPVTCALLID to the channel drivers unique
3444      ID for the call (not the Asterisk call ID or unique ID), provided that the
3445      channel driver supports this. For SIP, you get the SIP call-ID for the
3446      bridged channel which you can store in the CDR with a custom field.
3447
3448 CLI Changes
3449 -----------
3450   * Added CLI permissions, config file: cli_permissions.conf
3451      default is to allow all commands for every local user/group.
3452      Also this new feature added three new CLI commands:
3453       - cli check permissions {<username>|@<groupname>|<username>@<groupname>} [<command>]
3454       - cli reload permissions
3455       - cli show permissions
3456   * New CLI command "core show hint" (usage: core show hint <exten>)
3457   * New CLI command "core show settings"
3458   * Added 'core show channels count' CLI command.
3459   * Added the ability to set the core debug and verbose values on a per-file basis.
3460   * Added 'queue pause member' and 'queue unpause member' CLI commands
3461   * Ability to set process limits ("ulimit") without restarting Asterisk
3462   * Enhanced "agi debug" to print the channel name as a prefix to the debug
3463      output to make debugging on busy systems much easier.
3464   * New CLI commands "dialplan set extenpatternmatching true/false"
3465   * New CLI command: "core set chanvar" to set a channel variable from the CLI.
3466   * Added an easy way to execute Asterisk CLI commands at startup.  Any commands
3467     listed in the startup_commands section of cli.conf will get executed.
3468   * Added a CLI command, "devstate change", which allows you to set custom device
3469      states from the func_devstate module that provides the DEVICE_STATE() function
3470      and handling of the "Custom:" devices.
3471   * New CLI command: "sip show sched" which shows all ast_sched entries for sip,
3472     sorted into the different possible callbacks, with the number of entries
3473     currently scheduled for each. Gives you a feel for how busy the sip channel
3474     driver is.
3475   * Added 'skinny show lines verbose' CLI command. This will show the subs for every channel.
3476   * Cleanup another bunch of CLI commands. Now all modules follow the same schema.
3477     (Done by lmadsen, junky and mvanbaak during the devcon 2008)
3478
3479 SIP changes
3480 -----------
3481  * Added a new 'faxdetect=yes|no' configuration option to sip.conf.  When this
3482     option is enabled, Asterisk will watch for a CNG tone in the incoming audio
3483     for a received call.  If it is detected, the channel will jump to the
3484     'fax' extension in the dialplan.
3485   * The default SIP useragent= identifier now includes the Asterisk version
3486   * A new option, match_auth_username in sip.conf changes the matching of incoming requests.
3487      If set, and the incoming request carries authentication info,
3488      the username to match in the users list is taken from the Digest header
3489      rather than from the From: field. This feature is considered experimental.
3490   * The "musiconhold" and "musicclass" settings in sip.conf are now removed,
3491      since they where replaced by "mohsuggest" and "mohinterpret" in version 1.4
3492   * The "localmask" setting was removed in version 1.2 and the reminder about it
3493      being removed is now also removed.
3494   * A new option "busylevel" for setting a level of calls where asterisk reports
3495      a device as busy, to separate it from call-limit. This value is also added
3496      to the SIP_PEER dialplan function.
3497   * A new realtime family called "sipregs" is now supported to store SIP registration
3498      data. If this family is defined, "sippeers" will be used for configuration and
3499      "sipregs" for registrations. If it's not defined, "sippeers" will be used for
3500      registration data, as before.
3501   * The SIPPEER function have new options for port address, call and pickup groups
3502   * Added support for T.140 realtime text in SIP/RTP
3503   * The "checkmwi" option has been removed from sip.conf, as it is no longer
3504      required due to the restructuring of how MWI is handled.  See the descriptions
3505      in this file of the "pollmailboxes" and "pollfreq" options to voicemail.conf
3506      for more information.
3507   * Added rtpdest option to CHANNEL() dialplan function.
3508   * Added SIPREFERRINGCONTEXT and SIPREFERREDBYHDR variables which are set when a transfer takes place.
3509   * SIP now adds a header to the CANCEL if the call was answered by another phone
3510      in the same dial command, or if the new c option in dial() is used.
3511   * The new default is that 100 Trying is not sent on REGISTER attempts as the RFC specifically
3512      states it is not needed. For phones, however, that do require it the "registertrying" option
3513      has been added so it can be enabled.
3514   * A new option called "callcounter" (global/peer/user level) enables call counters needed
3515      for better status reports needed for queues and SIP subscriptions. (Call-Limit was previously
3516      used to enable this functionality).
3517   * New settings for timer T1 and timer B on a global level or per device. This makes it
3518      possible to force timeout faster on non-responsive SIP servers. These settings are
3519      considered advanced, so don't use them unless you have a problem.
3520   * Added a dial string option to be able to set the To: header in an INVITE to any
3521      SIP uri.
3522   * Added a new global and per-peer option, qualifyfreq, which allows you to configure
3523      the qualify frequency.
3524   * Added SIP Session Timers support (RFC 4028).  This prevents stuck SIP sessions that
3525      were not properly torn down due to network or endpoint failures during an established
3526      SIP session.
3527   * Added experimental TCP and TLS support for SIP.  See https://wiki.asterisk.org/wiki/x/ygBB
3528      and configs/sip.conf.sample for more information on how it is used.
3529   * Added a new configuration option "authfailureevents" that enables manager events when
3530     a peer can't authenticate properly.
3531   * Added DNS manager support to registrations for peers not referencing a peer entry.
3532
3533 IAX2 changes
3534 ------------
3535   * Added the trunkmaxsize configuration option to chan_iax2.
3536   * Added the srvlookup option to iax.conf
3537   * Added support for OSP.  The token is set and retrieved through the CHANNEL()
3538      dialplan function.
3539
3540 XMPP Google Talk/Jingle changes
3541 -------------------------------
3542   * Added the bindaddr option to gtalk.conf.
3543
3544 Skinny changes
3545 -------------
3546   * Added skinny show device, skinny show line, and skinny show settings CLI commands.
3547   * Proper codec support in chan_skinny.
3548   * Added settings for IP and Ethernet QoS requests
3549
3550 MGCP changes
3551 ------------
3552   * Added separate settings for media QoS in mgcp.conf
3553
3554 Console Channel Driver changes
3555 ------------------------------
3556   * Added experimental support for video send & receive to chan_oss.
3557     This requires SDL and ffmpeg/avcodec, plus Video4Linux or X11 to act as
3558     a video source.
3559
3560 Phone channel changes (chan_phone)
3561 ----------------------------------
3562   * Added G729 passthrough support to chan_phone for Sigma Designs boards.
3563
3564 H.323 channel Changes
3565 ---------------------
3566   * H323 remote hold notification support added (by NOTIFY message
3567      and/or H.450 supplementary service)
3568
3569 Local channel changes
3570 ---------------------
3571   * The device state functionality in the Local channel driver has been updated
3572      to indicate INUSE or NOT_INUSE when a Local channel is being used as opposed
3573      to just UNKNOWN if the extension exists.
3574   * Added jitterbuffer support for chan_local.  This allows you to use the
3575      generic jitterbuffer on incoming calls going to Asterisk applications.
3576      For example, this would allow you to use a jitterbuffer for an incoming
3577      SIP call to Voicemail by putting a Local channel in the middle.  This
3578      feature is enabled by using the 'j' option in the Dial string to the Local
3579      channel in conjunction with the existing 'n' option for local channels.
3580   * A 'b' option has been added which causes chan_local to return the actual channel
3581      that is behind it when queried. This is useful for transfer scenarios as the
3582      actual channel will be transferred, not the Local channel.
3583
3584 Agent channel changes
3585 ----------------------
3586   * The ackcall and endcall options are now supplemented with options acceptdtmf
3587     and enddtmf. These allow for the DTMF keypress to be configurable. The options
3588     default to their old hard-coded values ('#' and '*' respectively) so this should
3589     not break any existing agent installations.
3590
3591 DAHDI channel driver (chan_dahdi) Changes
3592 ----------------------------------------
3593   * SS7 support (via libss7 library)
3594   * In India, some carriers transmit CID via dtmf. Some code has been added
3595      that will handle some situations. The cidstart=polarity_IN choice has been added for
3596      those carriers that transmit CID via dtmf after a polarity change.
3597   * CID matching information is now shown when doing 'dialplan show'.
3598   * Added dahdi show version CLI command.
3599   * Added setvar support to chan_dahdi.conf channel entries.
3600   * Added two new options: mwimonitor and mwimonitornotify.  These options allow
3601      you to enable MWI monitoring on FXO lines.  When the MWI state changes,
3602      the script specified in the mwimonitornotify option is executed.  An internal
3603      event indicating the new state of the mailbox is also generated, so that
3604      the normal MWI facilities in Asterisk work as usual.
3605   * Added signalling type 'auto', which attempts to use the same signalling type
3606      for a channel as configured in DAHDI. This is primarily designed for analog
3607      ports, but will also work for digital ports that are configured for FXS or FXO
3608      signalling types. This mode is also the default now, so if your chan_dahdi.conf
3609      does not specify signalling for a channel (which is unlikely as the sample
3610      configuration file has always recommended specifying it for every channel) then
3611      the 'auto' mode will be used for that channel if possible.
3612   * Added a 'dahdi set dnd' command to allow CLI control of the Do-Not-Disturb
3613      state for a channel; also ensured that the DNDState Manager event is
3614      emitted no matter how the DND state is set or cleared.
3615
3616 New Channel Drivers
3617 -------------------
3618   * Added a new channel driver, chan_unistim.  See the Asterisk wiki at
3619      https://wiki.asterisk.org/wiki/x/vgsiAQ and configs/unistim.conf.sample
3620      for details.  This new channel driver allows you to use Nortel i2002,
3621      i2004, and i2050 phones with Asterisk.
3622   * Added a new channel driver, chan_console, which uses portaudio as a cross
3623      platform audio interface.  It was written as a channel driver that would
3624      work with Mac CoreAudio, but portaudio supports a number of other audio
3625      interfaces, as well. Note that this channel driver requires v19 or higher
3626      of portaudio; older versions have a different API.
3627
3628 DUNDi changes
3629 -------------
3630   * Added the ability to specify arguments to the Dial application when using
3631      the DUNDi switch in the dialplan.
3632   * Added the ability to set weights for responses dynamically.  This can be
3633      done using a global variable or a dialplan function.  Using the SHELL()
3634      function would allow you to have an external script set the weight for
3635      each response.
3636   * Added two new dialplan functions, DUNDIQUERY and DUNDIRESULT.  These
3637      functions will allow you to initiate a DUNDi query from the dialplan,
3638      find out how many results there are, and access each one.
3639   * Added the ability to specifiy a port for a dundi peer.
3640
3641 ENUM changes
3642 ------------
3643   * Added two new dialplan functions, ENUMQUERY and ENUMRESULT.  These
3644      functions will allow you to initiate an ENUM lookup from the dialplan,
3645      and Asterisk will cache the results.  ENUMRESULT can be used to access
3646      the results without doing multiple DNS queries.
3647
3648 Voicemail Changes
3649 -----------------
3650   * Added the ability to customize which sound files are used for some of the
3651      prompts within the Voicemail application by changing them in voicemail.conf
3652   * Added the ability for the "voicemail show users" CLI command to show users
3653      configured by the dynamic realtime configuration method.
3654   * MWI (Message Waiting Indication) handling has been significantly
3655      restructured internally to Asterisk.  It is now totally event based
3656      instead of polling based.  The voicemail application will notify other
3657      modules that have subscribed to MWI events when something in the mailbox
3658      changes.
3659     This also means that if any other entity outside of Asterisk is changing
3660      the contents of mailboxes, then the voicemail application still needs to
3661      poll for changes.  Examples of situations that would require this option
3662      are web interfaces to voicemail or an email client in the case of using
3663      IMAP storage.  So, two new options have been added to voicemail.conf
3664      to account for this: "pollmailboxes" and "pollfreq".  See the sample
3665      configuration file for details.
3666   * Added "tw" language support
3667   * Added support for storage of greetings using an IMAP server
3668   * Added ability to customize forward, reverse, stop, and pause keys for message playback
3669   * SMDI is now enabled in voicemail using the smdienable option.
3670   * A "lockmode" option has been added to asterisk.conf to configure the file
3671      locking method used for voicemail, and potentially other things in the
3672      future.  The default is the old behavior, lockfile.  However, there is a
3673      new method, "flock", that uses a different method for situations where the
3674      lockfile will not work, such as on SMB/CIFS mounts.
3675   * Added the ability to backup deleted messages, to ease recovery in the case
3676      that a user accidentally deletes a message, and discovers that they need it.
3677   * Reworked the SMDI interface in Asterisk.  The new way to access SMDI information
3678      is through the new functions, SMDI_MSG_RETRIEVE() and SMDI_MSG().  The file
3679      smdi.conf can now be configured with options to map SMDI station IDs to Asterisk
3680      voicemail boxes.  The SMDI interface can also poll for MWI changes when some
3681      outside entity is modifying the state of the mailbox (such as IMAP storage or
3682      a web interface of some kind).
3683   * Added the support for marking messages as "urgent." There are two methods to accomplish
3684      this. One is to pass the 'U' option to VoiceMail(). Another way to mark a message as urgent
3685      is to specify "review=yes" in voicemail.conf. Doing this will cause allow the user to mark
3686      the message as urgent after he has recorded a voicemail by following the voice instructions.
3687     When listening to voicemails using VoiceMailMain urgent messages will be presented before other
3688      messages
3689
3690 Queue changes
3691 -------------
3692   * Added the general option 'shared_lastcall' so that member's wrapuptime may be
3693      used across multiple queues.
3694   * Added QUEUE_VARIABLES function to set queue variables added setqueuevar and
3695      setqueueentryvar options for each queue, see queues.conf.sample for details.
3696   * Added keepstats option to queues.conf which will keep queue
3697      statistics during a reload.
3698   * setinterfacevar option in queues.conf also now sets a variable
3699      called MEMBERNAME which contains the member's name.
3700   * Added 'Strategy' field to manager event QueueParams which represents
3701      the queue strategy in use.
3702   * Added option to run macro when a queue member is connected to a caller,
3703      see queues.conf.sample for details.
3704   * app_queue now has a 'loose' option which is almost exactly like 'strict' except it
3705      does not count paused queue members as unavailable.
3706   * Added min-announce-frequency option to queues.conf which allows you to control the
3707      minimum amount of time between queue announcements for use when the caller's queue
3708      position changes frequently.
3709   * Added additional information to EXITWITHTIMEOUT and EXITWITHKEY events in the
3710      queue log.
3711   * Added ability for non-realtime queues to have realtime members
3712   * Added the "linear" strategy to queues.
3713   * Added the "wrandom" strategy to queues.
3714   * Added new channel variable QUEUE_MIN_PENALTY
3715   * QUEUE_MAX_PENALTY and QUEUE_MIN_PENALTY may be adjusted in mid-call by defining
3716      rules in queuerules.conf. See configs/queuerules.conf.sample for details
3717   * Added a new parameter for member definition, called state_interface. This may be
3718     used so that a member may be called via one interface but have a different interface's
3719     device state reported.
3720   * Added new CLI and Manager commands relating to reloading queues. From the CLI, see
3721     "queue reload", "queue reset stats". Also see "manager show command QueueReload" and
3722     "manager show command QueueReset."
3723   * New configuration option: randomperiodicannounce. If a list of periodic announcements is
3724     specified by the periodic-announce option, then one will be chosen randomly when it is time
3725     to play a periodic announcment
3726   * New configuration options: announce-position now takes two more values in addition to "yes" and
3727     "no." Two new options, "limit" and "more," are allowed. These are tied to another option,
3728     announce-position-limit. By setting announce-position to "limit" callers will only have their
3729     position announced if their position is less than what is specified by announce-position-limit.
3730     If announce-position is set to "more" then callers beyond the position specified by announce-position-limit
3731     will be told that their are more than announce-position-limit callers waiting.
3732   * Two new queue log events have been added. An ADDMEMBER event will be logged
3733     when a realtime queue member is added and a REMOVEMEMBER event will be logged
3734     when a realtime queue member is removed. Since there is no calling channel associated
3735     with these events, the string "REALTIME" is placed where the channel's unique id
3736     is typically placed.
3737   * The configuration method for the "joinempty" and "leavewhenempty" options has
3738     changed to a comma-separated list of methods of determining member availability
3739     instead of vague terms such as "yes," "loose," "no," and "strict." These old four
3740     values are still accepted for backwards-compatibility, though.
3741   * The average talktime is now calculated on queues. This information is reported via the
3742     CLI commands "queue show" and "queues show"; through the AMI events AgentComplete, QueueSummary,
3743     and QueueParams; and through the channelvariable QUEUETALKTIME if setinterfacevar=yes is set for
3744     the queue.
3745
3746 MeetMe Changes
3747 --------------
3748   * The 'o' option to provide an optimization has been removed and its functionality
3749      has been enabled by default.
3750   * When a conference is created, the UNIQUEID of the channel that caused it to be
3751      created is stored.  Then, every channel that joins the conference will have the
3752      MEETMEUNIQUEID channel variable set with this ID.  This can be used to relate
3753      callers that come and go from long standing conferences.
3754   * Added a new application, MeetMeChannelAdmin, which is similar to MeetMeAdmin,
3755      except it does operations on a channel by name, instead of number in a conference.
3756      This is a very useful feature in combination with the 'X' option to ChanSpy.
3757   * Added 'C' option to Meetme which causes a caller to continue in the dialplan
3758      when kicked out.
3759   * Added new RealTime functionality to provide support for scheduled conferencing.
3760      This includes optional messages to the caller if they attempt to join before
3761      the schedule start time, or to allow the caller to join the conference early.
3762      Also included is optional support for limiting the number of callers per
3763      RealTime conference.
3764   * Added the S() and L() options to the MeetMe application.  These are pretty
3765      much identical to the S() and L() options to Dial().  They let you set
3766      timeouts for the conference, as well as have warning sounds played to
3767      let the caller know how much time is left, and when it is running out.
3768   * Added the ability to do "meetme concise" with the "meetme" CLI command.
3769      This extends the concise capabilities of this CLI command to include
3770      listing all conferences, instead of an addition to the other sub commands
3771      for the "meetme" command.
3772   * Added the ability to specify the music on hold class used to play into the
3773      conference when there is only one member and the M option is used.
3774   * Added MEETME_INFO dialplan function which provides a way to query
3775      various properties of a Meetme conference.
3776   * Added new admin features: *81: Roll call, *82: eject all, *83: mute all,
3777      and *84: record in-conf
3778
3779 Other Dialplan Application Changes
3780 ----------------------------------
3781   * Argument support for Gosub application
3782   * From the to-do lists: straighten out the app timeout args:
3783      Wait() app now really does 0.3 seconds- was truncating arg to an int.
3784      WaitExten() same as Wait().
3785      Congestion() - Now takes floating pt. argument.
3786      Busy() - now takes floating pt. argument.
3787      Read() - timeout now can be floating pt.
3788      WaitForRing() now takes floating pt timeout arg.
3789      SpeechBackground() -- clarified in the docstrings that the timeout is an integer seconds.
3790   * Added 's' option to Page application.
3791   * Added an optional timeout argument to the Page application.
3792   * Added 'E', 'V', and 'P' commands to ExternalIVR.
3793   * Added 'o' and 'X' options to Chanspy.
3794   * Added a new dialplan application, Bridge, which allows you to bridge the
3795      calling channel to any other active channel on the system.
3796   * Added the ability to specify a music on hold class to play instead of ringing
3797      for the SLATrunk application.
3798   * The Read application no longer exits the dialplan on error.  Instead, it sets
3799      READSTATUS to ERROR, which you can catch and handle separately.
3800   * Added 'm' option to Directory, which lists out names, 8 at a time, instead
3801      of asking for verification of each name, one at a time.
3802   * Privacy() no longer uses privacy.conf, as all options are specifyable as
3803      direct options to the app.
3804   * AMD() has a new "maximum word length" option. "show application AMD" from the CLI
3805      for more details
3806   * GotoIfTime() now may branch based on a "false" condition, like other Goto-related applications
3807   * The ChannelRedirect application no longer exits the dialplan if the given channel
3808      does not exist. It will now set the CHANNELREDIRECT_STATUS variable to SUCCESS upon success
3809      or NOCHANNEL if the given channel was not found.
3810   * The silencethreshold setting that was previously configurable in multiple
3811      applications is now settable globally via dsp.conf.
3812
3813 Music On Hold Changes
3814 ---------------------
3815   * A new option, "digit", has been added for music on hold classes in
3816      musiconhold.conf.  If this is set for a music on hold class, a caller
3817      listening to music on hold can press this digit to switch to listening
3818      to this music on hold class.
3819   * Support for realtime music on hold has been added.
3820   * In conjunction with the realtime music on hold, a general section has
3821      been added to musiconhold.conf, its sole variable is cachertclasses. If this
3822      is set, then music on hold classes found in realtime will be cached in memory.
3823
3824 AEL Changes
3825 -----------
3826   * AEL upgraded to use the Gosub with Arguments instead
3827      of Macro application, to hopefully reduce the problems
3828      seen with the artificially low stack ceiling that
3829      Macro bumps into. Macros can only call other Macros
3830      to a depth of 7. Tests run using gosub, show depths
3831      limited only by virtual memory. A small test demonstrated
3832      recursive call depths of 100,000 without problems.
3833      -- in addition to this, all apps that allowed a macro
3834      to be called, as in Dial, queues, etc, are now allowing
3835      a gosub call in similar fashion.
3836   * AEL now generates LOCAL(argname) declarations when it
3837      Set()'s the each arg name to the value of ${ARG1}, ${ARG2),
3838      etc. That makes the arguments local in scope. The user
3839      can define their own local variables in macros, now,
3840      by saying "local myvar=someval;"  or using Set() in this
3841      fashion:  Set(LOCAL(myvar)=someval);  ("local" is now
3842      an AEL keyword).
3843   * utils/conf2ael introduced. Will convert an extensions.conf
3844      file into extensions.ael. Very crude and unfinished, but
3845      will be improved as time goes by. Should be useful for a
3846      first pass at conversion.
3847   * aelparse will now read extensions.conf to see if a referenced
3848      macro or context is there before issueing a warning.
3849   * AEL parser sets a local channel variable ~~EXTEN~~, to
3850     preserve the value of ${EXTEN} thru switch statements.
3851   * New operator in $[...] expressions: the ~~ operator serves
3852     as a concatenation operator. AT THE MOMENT, it is really only
3853     necessary and useful in AEL, especially in if() expressions.
3854     Operation: ${a} ~~ ${b|  with force both a and b to strings, strip
3855     any enclosing double-quotes, and evaluate to the value of a
3856     concatenated with the value of b.  For example if a is set to
3857     "xyz"  and b has the value "abc", then ${a} ~~ ${b| would
3858     evaluate to xyzabc .
3859
3860
3861 Call Features (res_features) Changes
3862 ------------------------------------
3863   * Added the parkedcalltransfers option to features.conf
3864   * Added parkedcallparking option to control one touch parking w/ parking
3865     pickup
3866   * Added parkedcallhangup option to control disconnect feature w/ parking
3867     pickup
3868   * Added parkedcallrecording option to control one-touch record w/ parking
3869     pickup
3870   * Added parkedcallparking, parkedcallhangup, parkedcallrecording, and
3871     parkedcalltransfers option support for multiple parking lots.
3872   * Added BRIDGE_FEATURES variable to set available features for a channel
3873   * The built-in method for doing attended transfers has been updated to
3874      include some new options that allow you to have the transferee sent
3875      back to the person that did the transfer if the transfer is not successful.
3876      See the options "atxferdropcall", "atxferloopdelay", and "atxfercallbackretries"
3877      in features.conf.sample.
3878   * Added support for configuring named groups of custom call features in
3879      features.conf.  This means that features can be written a single time, and
3880      then mapped into groups of features for different key mappings or easier
3881      access control.
3882   * Updated the ParkedCall application to allow you to not specify a parking
3883      extension.  If you don't specify a parking space to pick up, it will grab
3884      the first one available.
3885   * Added cli command 'features reload' to reload call features from features.conf
3886   * Moved into core asterisk binary.
3887   * Changed the default setting for featuredigittimeout to 2000 ms from 500 ms.
3888   * Added the ability for custom parking lots to be configured with their own
3889     parking extension with the parkext option.
3890
3891 Language Support Changes
3892 ------------------------
3893   * Brazilian Portuguese (pt-BR) in VM, and say.c was added
3894   * Added support for the Hungarian language for saying numbers, dates, and times.
3895
3896 AGI Changes
3897 -----------
3898   * Added SPEECH commands for speech recognition. A complete listing can be found
3899     using agi show.
3900   * If app_stack is loaded, GOSUB is a native AGI command that may be used to
3901     invoke subroutines in the dialplan.  Note that calling EXEC with Gosub
3902     does not behave as expected; the native command needs to be used, instead.
3903   * Added the ability to perform SRV lookups on fast AGI calls. To use this
3904     feature, simply use hagi: instead of agi: as the protocol portion
3905     of the URI parameter to the AGI function call in your dial plan. Also note
3906     that specifying a port number in the AGI URI will disable SRV lookups,
3907     even if you use the hagi: protocol.
3908   * No longer support MSG_OOB flag on HANGUP.
3909
3910 Logger changes
3911 --------------
3912   * Added rotatestrategy option to logger.conf, along with two new options:
3913      "timestamp" which will use the time to name the logger files instead of
3914      sequence number; and "rotate", which rotates the names of the log files,
3915      similar to the way syslog rotates files.
3916   * Added exec_after_rotate option to logger.conf, which allows a system
3917      command to be run after rotation.  This is primarily useful with
3918      rotatestrategy=rotate, to allow a limit on the number of log files kept
3919      and to ensure that the oldest log file gets deleted.
3920   * Added realtime support for the queue log
3921
3922 Call Detail Records
3923 -------------------
3924   * The cdr_manager module has a [mappings] feature, like cdr_custom,
3925     to add fields to the manager event from the CDR variables.
3926   * Added cdr_adaptive_odbc, a new module that adapts to the structure of your
3927      backend database CDR table.  Specifically, additional, non-standard
3928      columns are supported, merely by setting the corresponding CDR variable in
3929      your dialplan.  In addition, you may alias any column to another name (for
3930      example, if you want the 'src' CDR variable to be column 'ANI' in the DB,
3931      simply "alias src => ANI" in the configuration file).  Records may be
3932      posted to more than one backend, simply by specifying multiple categories
3933      in the configuration file.  And finally, you may filter which CDRs get
3934      posted to each backend, by specifying a filter (which the record must
3935      match) for the particular category.  Filters are additive (meaning all
3936      rules must match to post that CDR).
3937   * The Postgres CDR module now supports some features of the cdr_adaptive_odbc
3938      module.  Specifically, you may add additional columns into the table and
3939      they will be set, if you set the corresponding CDR variable name.  Also,
3940      if you omit columns in your database table, they will be silently skipped
3941      (but a record will still be inserted, based on what columns remain).  Note
3942      that the other two features from cdr_adaptive_odbc (alias and filter) are
3943      not currently supported.
3944   * The ResetCDR application now has an 'e' option that re-enables a CDR if it
3945      has been disabled using the NoCDR application.
3946
3947 Miscellaneous New Modules
3948 -------------------------
3949   * Added a new CDR module, cdr_sqlite3_custom.
3950   * Added a new realtime configuration module, res_config_sqlite
3951   * Added a new codec translation module, codec_resample, which re-samples
3952      signed linear audio between 8 kHz and 16 kHz to help support wideband
3953      codecs.
3954   * Added a new module, res_phoneprov, which allows auto-provisioning of phones
3955      based on configuration templates that use Asterisk dialplan function and
3956      variable substitution.  It should be possible to create phone profiles and
3957      templates that work for the majority of phones provisioned over http. It
3958      is currently only intended to provision a single user account per phone.
3959      An example profile and set of templates for Polycom phones is provided.
3960      NOTE: Polycom firmware is not included, but should be placed in
3961      AST_DATA_DIR/phoneprov/configs to match up with the included templates.
3962   * Added a new module, app_jack, which provides interfaces to JACK, the Jack
3963      Audio Connection Kit (http://www.jackaudio.org/).  Two interfaces are
3964      provided; there is a JACK() application, and a JACK_HOOK() function.  Both
3965      interfaces create an input and output JACK port.  The application makes
3966      these ports the endpoint of the call.  The audio coming from the channel
3967      goes out the output port and whatever comes back in on the input port is
3968      what gets sent to the channel.  The JACK_HOOK() function turns on a JACK
3969      audiohook on the channel.  This lets you run the audio coming from a
3970      channel through JACK, and whatever comes back in is what gets forwarded
3971      on as the channel's audio.  This is very useful for building custom
3972      vocoders or doing recording or analysis of the channel's audio in another
3973      application.
3974   * Added a new module, res_config_curl, which permits using a HTTP POST url
3975      to retrieve, create, update, and delete realtime information from a remote
3976      web server.  Note that this module requires func_curl.so to be loaded for
3977      backend functionality.
3978   * Added a new module, res_config_ldap, which permits the use of an LDAP
3979      server for realtime data access.
3980   * Added support for writing and running your dialplan in lua using the pbx_lua
3981      module.  See configs/extensions.lua.sample for examples of how to do this.
3982
3983 Miscellaneous
3984 -------------
3985   * Ability to use libcap to set high ToS bits when non-root
3986      on Linux. If configure is unable to find libcap then you
3987      can use --with-cap to specify the path.
3988   * Added maxfiles option to options section of asterisk.conf which allows you to specify
3989      what Asterisk should set as the maximum number of open files when it loads.
3990   * Added the jittertargetextra configuration option.
3991   * Added support for setting the CoS for VLAN traffic (802.1p).  See the sample
3992      configuration files for the IP channel drivers.  The new option is "cos".
3993      This information is also documented on the Asterisk wiki at
3994      https://wiki.asterisk.org/wiki/x/EYBG
3995   * When originating a call using AMI or pbx_spool that fails the reason for failure
3996      will now be available in the failed extension using the REASON dialplan variable.
3997   * Added support for reading the TOUCH_MONITOR_PREFIX channel variable.
3998      It allows you to configure a prefix for auto-monitor recordings.
3999   * A new extension pattern matching algorithm, based on a trie, is introduced
4000      here, that could noticeably speed up mid-sized to large dialplans.
4001      It&n