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