cdr_radius,cel_radius: Fix old memleak in unload
[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 14 to Asterisk 15 --------------------
13 ------------------------------------------------------------------------------
14
15 Build System
16 ------------------
17  * LOW_MEMORY no longer has an effect on Asterisk ABI.  Symbols that were
18    previously suppressed by LOW_MEMORY are now replaced by stub functions.
19    Asterisk built with LOW_MEMORY can now successfully load binary modules
20    built without LOW_MEMORY and vice versa.
21
22 chan_sip
23 ------------------
24  * If an offer is received with optional SRTP (a media stream with RTP/AVP but
25    which contains a crypto line) chan_sip will now accept it and enable SRTP.
26    If you would like to do optional SRTP on outbound you will need to create
27    a dialplan that dials with it enabled initially and if it fails fall back to
28    without.
29
30 res_pjsip
31 ------------------
32  * Added endpoint configuration parameter "preferred_codec_only".
33    This allow asterisk response to a SIP invite with the single most
34    preferred codec rather than advertising all joint codec capabilities.
35    This limits the other side's codec choice to exactly what we prefer.
36
37 cdr_radius
38 ------------------
39  * To fix a memory leak the syslog channel is now empty if it has not been set
40    and used by a syslog channel in the logger.
41
42 cel_radius
43 ------------------
44  * To fix a memory leak the syslog channel is now empty if it has not been set
45    and used by a syslog channel in the logger.
46
47 ------------------------------------------------------------------------------
48 --- Functionality changes from Asterisk 14.1.0 to Asterisk 14.2.0 ----------
49 ------------------------------------------------------------------------------
50
51 res_pjsip
52 ------------------
53  * Automatic dual stack support is now implemented. Depending on DNS resolution
54    and the transport used for sending a message the SIP signaling and SDP will
55    be updated with the correct IP address and protocol version. This means that
56    the rtp_ipv6 and t38_udptl_ipv6 options no longer have any effect. The
57    res_pjsip_multihomed module has also been moved into core res_pjsip to ensure
58    that messages are updated with the correct address information in all cases.
59
60 ------------------------------------------------------------------------------
61 --- Functionality changes from Asterisk 14.0.0 to Asterisk 14.1.0 ----------
62 ------------------------------------------------------------------------------
63
64 Build System
65 ------------------
66  * The res_digium_phone, codec_g729a, codec_silk, codec_siren7 and
67    codec_siren14 binary modules hosted at downloads.digium.com can now be
68    automatically downloaded and installed during the Asterisk install
69    process.  If selected in menuselect, when 'make install' is run, the
70    script will check the downloads site for a new version and download
71    and install it if needed.  The '--with-externals-cache' option to
72    ./configure can be used to specify a location to cache the latest
73    tarballs so they don't have to be re-downloaded for every install.
74
75 app_voicemail
76 ------------------
77  * Added "tps_queue_high" and "tps_queue_low" options.
78    The options can modify the taskprocessor alert levels for this module.
79    Additional information can be found in the sample configuration file at
80    config/samples/voicemail.conf.sample.
81
82 res_pjsip_mwi
83 ------------------
84  * Added "mwi_tps_queue_high" and "mwi_tps_queue_low" global configuration
85    options to tune taskprocessor alert levels.
86
87  * Added "mwi_disable_initial_unsolicited" global configuration option
88    to disable sending unsolicited MWI to all endpoints on startup.
89    Additional information can be found in the sample configuration file at
90    config/samples/pjsip.conf.sample.
91
92 chan_pjsip
93 ------------------
94  * A new dialplan function, PJSIP_SEND_SESSION_REFRESH, has been added. When
95    invoked, a re-INVITE or UPDATE request will be sent immediately to the
96    endpoint underlying the channel. When used in combination with the existing
97    dialplan function PJSIP_MEDIA_OFFER, this allows the formats on a PJSIP
98    channel to be re-negotiated and updated after session set up.
99
100 res_pjsip
101 ------------------
102  * A new endpoint configuration parameter 'contact_user' has been added which
103    when set will override the default user set on Contact headers in outgoing
104    requests.
105
106  * If you are using a sorcery realtime backend to store global res_pjsip
107    options (ps_globals table) then you now have to do a res_pjsip reload for
108    changes to these options to take effect.  If you are using pjsip.conf to
109    configure these options then you already had to do a reload after making
110    changes.
111
112  * Added "ignore_uri_user_options" global configuration option for
113    compatibility with an ITSP that sends URI user field options.  When enabled
114    the user field is truncated at the first semicolon.
115    Example:
116    URI: "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
117    The user field is "1235557890;phone-context=national"
118    Which is truncated to this: "1235557890"
119
120    Note: The caller-id and redirecting number strings obtained from incoming
121    SIP URI user fields are now always truncated at the first semicolon.
122
123 res_rtp_asterisk
124 ------------------
125   * An option, ice_blacklist, has been added which allows certain subnets to be
126     excluded from local ICE candidates.
127
128 app_confbridge
129 ------------------
130   * Some sounds played into the bridge are played asynchronously. This, for
131     instance, allows a channel to immediately exit the ConfBridge without having
132     to wait for a leave announcement to play.
133
134 app_dial
135 ------------------
136  * Added the "Q" option which sets the Q.850/Q.931 cause on unanswered channels
137    when another channel answers the call.  The default of ANSWERED_ELSEWHERE
138    is unchanged.
139
140 res_ari
141 ------------------
142  * ARI events will all now include a new field in the root of the JSON message,
143    'asterisk_id'.  This will be the unique ID for the Asterisk system
144    transmitting the event.  The value can be overridden using the 'entityid'
145    setting in asterisk.conf.
146
147 ------------------------------------------------------------------------------
148 --- Functionality changes from Asterisk 13 to Asterisk 14 --------------------
149 ------------------------------------------------------------------------------
150
151 AMI
152 -----------------
153  * A new event, "DialState" has been added. This is similar to "DialBegin" and
154  "DialEnd" in that it tracks the state of a dialed call. The difference is that
155  this indicates some intermediate state change in the dial attempt, such as
156  "RINGING", "PROGRESS", or "PROCEEDING".
157
158 ARI
159 -----------------
160  * A new ARI method has been added to the channels resource. "create" allows for
161    you to create a new channel and place that channel into a Stasis application.
162    This is similar to origination except that the specified channel is not
163    dialed. This allows for an application writer to create a channel, perform
164    manipulations on it, and then delay dialing the channel until later.
165
166  * To complement the "create" method, a "dial" method has been added to the
167    channels resource in order to place a call to a created channel.
168
169  * All operations that initiate playback of media on a resource now support
170    a list of media URIs. The list of URIs are played in the order they are
171    presented to the resource. A new event, "PlaybackContinuing", is raised when
172    a media URI finishes but before the next media URI starts. When a list is
173    played, the "Playback" model will contain the optional attribute
174    "next_media_uri", which specifies the next media URI in the list to be played
175    back to the resource. The "PlaybackFinished" event is raised when all media
176    URIs are done.
177
178  * Stored recordings now allow for the media associated with a stored recording
179    to be retrieved. The new route, GET /recordings/stored/{name}/file, will
180    transmit the raw media file to the requester as binary.
181
182
183  * "Dial" events have been modified to not only be sent when dialing begins and ends.
184  They now are also sent for intermediate states, such as "RINGING", "PROGRESS", and
185  "PROCEEDING".
186
187 Applications
188 ------------------
189
190 BridgeAdd
191 ------------------
192  * A new application in Asterisk, this will join the calling channel
193    to an existing bridge containing the named channel prefix.
194
195 ChanSpy
196 ------------------
197  * Added the 'l' option, which forces ChanSpy's audiohook to use a long queue
198    to store the audio frames. This option is useful if audio loss is
199    experienced when using ChanSpy, but may introduce some delay in the audio
200    feed on the listening channel.
201
202 Codecs
203 ------------------
204  * Added format attribute negotiation for the iLBC audio codec. Format attribute
205    negotiation is provided by the res_format_attr_ilbc module. iLBC 20 is the
206    default now. Falls back to iLBC 30, when the remote party requests this.
207
208 ConfBridge
209 ------------------
210  * Added the ability to pass options to MixMonitor when recording is used with
211    ConfBridge. This includes the addition of the following configuration
212    parameters for the 'bridge' object:
213    - record_file_timestamp: whether or not to append the start time to the
214      recorded file name
215    - record_options: the options to pass to the MixMonitor application
216    - record_command: a command to execute when recording is finished
217    Note that these options may also be with the CONFBRIDGE function.
218
219 ControlPlayback
220 ------------------
221  * Remote files can now be retrieved and played back. See the Playback
222    dialplan application for more details.
223
224 FollowMe
225 ------------------
226  * It is now possible to disable the prompt from a callee by setting
227    'enable_callee_prompt = no' in followme.conf.
228
229 Playback
230 ------------------
231  * Remote files can now be retrieved and played back via the Playback and other
232    media playback dialplan applications. This is done by directly providing
233    the URL to play to the dialplan application:
234      same => n,Playback(http://1.1.1.1/howler-monkeys-fl.wav)
235    Note that unlike 'normal' media files, the entire URI to the file must be
236    provided, including the file extension. Currently, on HTTP and HTTPS URI
237    schemes are supported.
238
239 Queue
240 -------------------
241  * Added field ReasonPause on QueueMemberStatus if set when paused, the reason
242    the queue member was paused.
243
244  * Added field LastPause on QueueMemberStatus for time when started the last
245    pause for a queue member.
246
247  * Show the time when started the last pause for queue member on CLI for command
248    'queue show'.
249
250 SMS
251 ------------------
252  * Added the 'n' option, which prevents the SMS from being written to the log
253    file. This is needed for those countries with privacy laws that require
254    providers to not log SMS content.
255
256
257 Channel Drivers
258 ------------------
259
260 chan_dahdi
261 ------------------
262  * The CALLERID(ani2) value for incoming calls is now populated in featdmf
263    signaling mode.  The information was previously discarded.
264
265  * Added the force_restart_unavailable_chans compatibility option.  When
266    enabled it causes Asterisk to restart the ISDN B channel if an outgoing
267    call receives cause 44 (Requested channel not available).
268
269 chan_iax2
270 ------------------
271  * The iax.conf forcejitterbuffer option has been removed.  It is now always
272    forced if you set iax.conf jitterbuffer=yes.  If you put a jitter buffer
273    on a channel it will be on the channel.
274
275  * A new configuration parameters, 'calltokenexpiration', has been added that
276    controls the duration before a call token expires. Default duration is 10
277    seconds. Setting this to a higher value may help in lagged networks or those
278    experiencing high packet loss.
279
280  * Plaintext auth mode is deprecated and removed from possible default modes.
281
282 chan_rtp (was chan_multicast_rtp)
283 ------------------
284  * Added unicast RTP support and renamed chan_multicast_rtp to chan_rtp.
285
286  * The format for dialing a unicast RTP channel is:
287    UnicastRTP/<destination-addr>[/[<options>]]
288    Where <destination-addr> is something like '127.0.0.1:5060'.
289    Where <options> are in standard Asterisk flag options format:
290    c(<codec>) - Specify which codec/format to use such as 'ulaw'.
291    e(<engine>) - Specify which RTP engine to use such as 'asterisk'.
292
293  * New options were added for a multicast RTP channel.  The format for
294    dialing a multicast RTP channel is:
295    MulticastRTP/<type>/<destination-addr>[/[<control-addr>][/[<options>]]]
296    Where <type> can be either 'basic' or 'linksys'.
297    Where <destination-addr> is something like '224.0.0.3:5060'.
298    Where <control-addr> is something like '127.0.0.1:5060'.
299    Where <options> are in standard Asterisk flag options format:
300    c(<codec>) - Specify which codec/format to use such as 'ulaw'.
301    i(<address>) - Specify the interface address from which multicast RTP
302      is sent.
303    l(<enable>) - Set whether packets are looped back to the sender.  The
304      enable value can be 0 to set looping to off and non-zero to set
305      looping on.
306    t(<ttl>) - Set the time-to-live (TTL) value for multicast packets.
307
308 chan_sip
309 ------------------
310  * New 'rtpbindaddr' global setting. This allows a user to define which
311    ipaddress to bind the rtpengine to. For example, chan_sip might bind
312    to eth0 (10.0.0.2) but rtpengine to eth1 (192.168.1.10).
313
314  * DTLS related configuration options can now be set at a general level.
315    Enabling DTLS support, though, requires enabling it at the user
316    or peer level.
317
318  * Added the possibility to set the From: header through the the SIP dial
319    string (populating the fromuser/fromdomain fields), complementing the
320    [!dnid] option for the To: header that has existed since 1.6.0 (1d6b192).
321    NOTE: This is again separated by an exclamation mark, so the To: header may
322    not contain one of those.
323
324  * Session-Timers (RFC 4028) work for TCP (and TLS) transports as well now.
325    Previously Asterisk dropped calls only with UDP transports. However with
326    longer international calls via TCP, the SIP channel might break, because
327    all hops on the Internet route must stay online (have not a single power
328    outage, for example). Therefore with Session-Timers enabled (which are
329    enabled at default), you might see additional dropped calls. Consequently
330    please, consider to go for session-timers=refuse in your sip.conf.
331
332 chan_pjsip
333 ------------------
334  * New 'user_eq_phone' endpoint setting. This adds a 'user=phone' parameter
335    to the request URI and From URI if the user is determined to be a phone
336    number.
337
338  * New 'moh_passthrough' endpoint setting. This will pass hold and unhold
339    requests through using SIP re-invites with sendonly and sendrecv accordingly.
340
341  * Added the pjsip.conf system type disable_tcp_switch option.  The option
342    allows the user to disable switching from UDP to TCP transports described
343    by RFC 3261 section 18.1.1.
344
345  * New 'line' and 'endpoint' options added on outbound registrations. This
346    allows some identifying information to be added to the Contact of the
347    outbound registration. If this information is present on messages received
348    from the remote server the message will automatically be associated with the
349    configured endpoint on the outbound registration.
350
351
352 Core
353 ------------------
354  * The core of Asterisk uses a message bus called "Stasis" to distribute
355    information to internal components. For performance reasons, the message
356    distribution was modified to make use of a thread pool instead of a
357    dedicated thread per consumer in certain cases. The initial settings for
358    the thread pool can now be configured in 'stasis.conf'.
359
360  * A new core DNS API has been implemented which provides a common interface
361    for DNS functionality. Modules that use this functionality will require that
362    a DNS resolver module is loaded and available.
363
364  * Modified processing of command-line options to first parse only what
365    is necessary to read asterisk.conf. Once asterisk.conf is fully loaded,
366    the remaining options are processed.  The -X option now applies to
367    asterisk.conf only.  To enable #exec for other config files you must
368    set execincludes=yes in asterisk.conf.  Any other option set on the
369    command-line will now override the equivalent setting from asterisk.conf.
370
371  * The TLS core in Asterisk now supports X.509 certificate subject alternative
372    names. This way one X.509 certificate can be used for hosts that can be
373    reached under multiple DNS names or for multiple hosts.
374
375  * The Asterisk logging system now supports JSON structured logging. Log
376    channels specified in logger.conf or added dynamically via CLI commands now
377    support an optional specifier prior to their levels that determines their
378    formatting. To set a log channel to format its entries as JSON, a formatter
379    of '[json]' can be set, e.g.,
380       full => [json]debug,verbose,notice,warning,error
381
382  * The core now supports a 'media cache', which stores temporary media files
383    retrieved from external sources. CLI commands have been added to manipulate
384    and display the cached files, including:
385    - 'media cache show <all>' - show all cached media files, or details about
386      one particular cached media file
387    - 'media cache refresh <item>' - force a refresh of a particular media file
388      in the cache
389    - 'media cache delete <item>' - remove an item from the cache
390    - 'media cache create <uri>' - retrieve a URI and store it in the cache
391
392  * The ability for device state hints to be automatically created as a result of
393    device state changes now exists in the PBX. This functionality is referred to
394    as "autohints" and is configurable in extensions.conf by placing "autohints=yes"
395    in the context. If enabled a device state hint will be automatically created
396    with the name of the device.
397
398 * If Asterisk is built with systemd support, and run under systemd, it will
399   notify systemd of its state using sd_notify. Use 'Type=notify' in
400   asterisk.service.
401
402 Functions
403 ------------------
404  * The func_odbc global option "single_db_connection" default value has been
405    changed to 'no'.
406
407
408 Formats
409 ------------------
410  * New module format_ogg_speex added which supports Speex codec inside
411    Ogg containers (filename extension .spx).
412
413
414 CHANNEL
415 ------------------
416  * Added CHANNEL(onhold) item that returns 1 (onhold) and 0 (not-onhold) for
417    the hold status of a channel.
418
419 CURL
420 ------------------
421  * The CURL function now supports a write option, which will save the retrieved
422    file to a location on disk. As an example:
423      same => n,Set(CURL(https://1.1.1.1/foo.wav)=/tmp/foo.wav)
424    will save 'foo.wav' to /tmp.
425
426 DTMF Features
427 ------------------
428  * The transferdialattempts default value has been changed from 1 to 3. The
429    transferinvalidsound has been changed from "pbx-invalid" to
430    "privacy-incorrect". These were changed to make DTMF transfers be more
431    user-friendly by default.
432
433
434 Resources
435 ------------------
436
437 res_http_media_cache
438 ------------------
439  * A backend for the core media cache, this module retrieves media files from
440    a remote HTTP(S) server and stores them in the core media cache for later
441    playback.
442
443 res_musiconhold
444 ------------------
445  * Added sort=randstart to the sort options. It sorts the files by name and
446    then chooses the first file to play at random.
447  * Added preferchannelclass=no option to prefer the application-passed class
448    over the channel-set musicclass. This allows separate hold-music from
449    application (e.g. Queue or Dial) specified music.
450
451 res_resolver_unbound
452 ------------------
453  * Added a res_resolver_unbound module which uses the libunbound resolver library
454    to perform DNS resolution. This module requires the libunbound library to be
455    installed in order to be used.
456
457 res_pjsip
458 ------------------
459  * A new SIP resolver using the core DNS API has been implemented. This relies on
460    external SIP resolver support in PJSIP which is only available as of PJSIP
461    2.4. If this support is unavailable the existing built-in PJSIP SIP resolver
462    will be used instead. The new SIP resolver provides NAPTR support, improved
463    SRV support, and AAAA record support.
464
465 res_pjsip_info_empty
466 --------------------
467  * A new module that can respond to empty Content-Type INFO packets during call.
468    Some SBCs will terminate a call if their empty INFO packets are not responded
469    to within a predefined time.
470
471 res_pjsip_outbound_registration
472 -------------------------------
473 * A new 'fatal_retry_interval' option has been added to outbound registration.
474   When set (default is zero), and upon receiving a failure response to an
475   outbound registration, registration is retried at the given interval up to
476   'max_retries'.
477
478 res_pjsip_outbound_publish
479 ------------------
480  * Added a new multi_user option that when set to 'yes' allows a given configuration
481    to be used for multiple users.
482
483
484 CEL Backends
485 ------------------
486
487 cel_pgsql
488 ------------------
489  * Added a new option, 'usegmtime', which causes timestamps in CEL events
490    to be logged in GMT.
491
492  * Added support to set schema where located the table cel. This settings is
493    configurable for cel_pgsql via the 'schema' in configuration file
494    cel_pgsql.conf.
495
496
497 CDR Backends
498 ------------------
499
500 cdr_adaptive_odbc
501 ------------------
502  * Added the ability to set the character to quote identifiers. This
503    allows adding the character at the start and end of table and column
504    names. This setting is configurable for cdr_adaptive_odbc via the
505    quoted_identifiers in configuration file cdr_adaptive_odbc.conf.
506
507 cdr_odbc
508 ------------------
509  * Added a new configuration option, "newcdrcolumns", which enables use of the
510    post-1.8 CDR columns 'peeraccount', 'linkedid', and 'sequence'.
511
512 cdr_csv
513 ------------------
514  * Added a new configuration option, "newcdrcolumns", which enables use of the
515    post-1.8 CDR columns 'peeraccount', 'linkedid', and 'sequence'.
516
517 ------------------------------------------------------------------------------
518 --- Functionality changes from Asterisk 13.10.0 to Asterisk 13.11.0 ----------
519 ------------------------------------------------------------------------------
520
521 chan_dahdi
522 ------------------
523  * Added "faxdetect_timeout" option.
524    The option determines how many seconds into a call before faxdetect
525    is disabled for the call.  Setting the value to zero disables the timeout.
526
527 res_pjsip
528 ------------------
529  * Added "fax_detect_timeout" to endpoint.
530    The option determines how many seconds into a call before fax_detect
531    is disabled for the call.  Setting the value to zero disables the timeout.
532
533  * Added "subscribe_context" to endpoint.
534    If specified, incoming SUBSCRIBE requests will be searched for the matching
535    extension in the indicated context. If no "subscribe_context" is specified,
536    then the "context" setting is used.
537
538 res_rtp_asterisk
539 ------------------
540  * The DTLS part in Asterisk now supports Perfect Forward Secrecy (PFS).
541    Enabling PFS is attempted by default, and is dependent on the configuration
542    of the module using TLS.
543    - Ephemeral ECDH (ECDHE) is enabled by default. To disable it, do not
544      specify a ECDHE cipher suite in sip.conf, for example:
545        dtlscipher=AES128-SHA
546    - Ephemeral DH (DHE) is disabled by default. To enable it, add DH parameters
547      into the private key file, e.g., sip.conf dtlsprivatekey. For example:
548        openssl dhparam -out ./dh.pem 2048
549    - Because clients expect the server to prefer PFS, and because OpenSSL sorts
550      its cipher suites by bit strength, see "openssl ciphers -v DEFAULT".
551      Consider re-ordering your cipher suites in the respective configuration
552      file. For example:
553        dtlscipher=ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256
554      which forces PFS and requires at least DTLS 1.2.
555
556 ------------------------------------------------------------------------------
557 --- Functionality changes from Asterisk 13.9.0 to Asterisk 13.10.0 -----------
558 ------------------------------------------------------------------------------
559
560 Core
561 ------------------
562  * A channel variable FORWARDERNAME is now set which indicates which channel
563    was responsible for a forwarding requests received on dial attempt.
564
565 func_odbc
566 ------------------
567  * Added new global option "single_db_connection".
568    Enabling this option func_odbc will use a single database connection per DSN.
569    This option is enabled by default.
570
571 res_fax
572 ------------------
573  * Added FAXMODE variable to let dialplan know what fax transport was used.
574    FAXMODE variable is set to either "audio" or "T38".
575
576 res_pjsip
577 ------------------
578  * Added "via_addr", "via_port", "call_id" to contacts.
579    As res_pjsip_nat rewrites contact's address, only the last Via header
580    can contain the source address of registered endpoint.
581    Also Call-Id header may contain the source address of registered endpoint.
582    Added new fields ViaAddress,CallID to AMI event ContactStatus
583
584  * Endpoint IP Access Controls
585    Added new configuration Endpoint options:
586     "acl" - list of IP ACL section names in acl.conf
587     "deny" - List of IP addresses to deny access from
588     "permit" - List of IP addresses to permit access from
589     "contact_acl" - List of Contact ACL section names in acl.conf
590     "contact_deny" - List of Contact header addresses to deny
591     "contact_permit" - List of Contact header addresses to permit
592
593  * Added "reg_server" to contacts.
594    If the Asterisk system name is set in asterisk.conf, it will be stored
595    into the "reg_server" field in the ps_contacts table to facilitate
596    multi-server setups.
597
598  * When starting Asterisk, received traffic will now be ignored until Asterisk
599    has loaded all modules and is fully booted.
600
601 res_hep
602 ------------------
603  * Added a new option, 'uuid_type', that sets the preferred source of the Homer
604    correlation UUID. The valid options are:
605    - call-id: Use the PJSIP SIP Call-ID header value
606    - channel: Use the Asterisk channel name
607    The default value is 'call-id'. In the event that a HEP module cannot find a
608    valid value using the specified 'uuid_type', the module may fallback to a
609    more readily available source for the correlation UUID.
610
611 res_odbc
612 ------------------
613  * A new option has been added, 'max_connections', which sets the maximum number
614    of concurrent connections to the database. This option defaults to 1 which
615    returns the behavior to that of Asterisk 13.7 and prior.
616
617 app_confbridge
618 ------------------
619  * Added a bridge profile option called regcontext that allows you to
620    dynamically register the conference bridge name as an extension into
621    the specified context.  This allows tracking down conferences on multi-
622    server installations via alternate means (DUNDI for example). By default
623    this feature is not used.
624
625 Codecs
626 ------------------
627  * Added the associated format name to 'core show codecs'.
628
629 res_ari_channels
630 ------------------
631  * Added 'formats' to channel create/originate to allow setting the allowed
632    formats for a channel when no originator channel is available.  Especially
633    useful for Local channel creation where no other format information is
634    available.  'core show codecs' can now be used to look up suitable format
635    names.
636
637 ------------------------------------------------------------------------------
638 --- Functionality changes from Asterisk 13.8.0 to Asterisk 13.9.0 ------------
639 ------------------------------------------------------------------------------
640
641 res_parking:
642  - The dynamic parking lot creation channel variables PARKINGDYNAMIC,
643    PARKINGDYNCONTEXT, PARKINGDYNEXTEN, and PARKINGDYNPOS are now looked
644    for in the parker's channel instead of the parked channel.  This is only
645    of significance if the parker uses blind transfer or the DTMF one-step
646    parking feature.  You need to use the double underscore '__' inheritance
647    for these variables.  The indefinite inheritance is also recommended
648    for the PARKINGEXTEN variable.
649
650 res_pjsip
651 ------------------
652  * Added new global option (disable_multi_domain) to pjsip.
653    Disabling Multi Domain can improve realtime performace by reducing
654    number of database requsts.
655
656 chan_pjsip
657 ------------------
658  * Added 'pjsip show channelstats' CLI command.
659
660 res_pjsip_outbound_publish
661 ------------------
662  * Added support for setting the transport used on outbound publish
663    using the transport configuration option.
664
665 ------------------------------------------------------------------------------
666 --- Functionality changes from Asterisk 13.7.0 to Asterisk 13.8.0 ------------
667 ------------------------------------------------------------------------------
668
669 res_pjsip_caller_id
670 ------------------
671  * Per RFC3325, the 'From' header is now anonymized on outgoing calls when
672    caller id presentation is prohibited.
673
674 res_pjsip_config_wizard
675 ------------------
676  * A new command (pjsip export config_wizard primitives) has been added that
677    will export all the pjsip objects it created to the console or a file
678    suitable for reuse in a pjsip.conf file.
679
680 Build System
681 ------------------
682  * To help insure that Asterisk is compiled and run with the same known
683    version of pjproject, a new option (--with-pjproject-bundled) has been
684    added to ./configure.  When specified, the version of pjproject specified
685    in third-party/versions.mak will be downloaded and configured.  When you
686    make Asterisk, the build process will also automatically build pjproject
687    and Asterisk will be statically linked to it.  Once a particular version
688    of pjproject is configured and built, it won't be configured or built
689    again unless you run a 'make distclean'.
690
691    To facilitate testing, when 'make install' is run, the pjsua and pjsystest
692    utilities and the pjproject python bindings will be installed in
693    ASTDATADIR/third-party/pjproject.
694
695    The default behavior remains building with the shared pjproject
696    installation, if any.
697
698 app_confbridge
699 ------------------
700  * Added CONFBRIDGE_INFO(muted,) for querying the muted conference state.
701
702  * Added Muted header to AMI ConfbridgeListRooms action response list events
703    to indicate the muted conference state.
704
705  * Added Muted column to CLI "confbridge list" output to indicate the muted
706    conference state and made the locked column a yes/no value instead of a
707    locked/unlocked value.
708
709 REDIRECTING(reason)
710 ------------------
711  * The REDIRECTING(reason) value is now treated consistently between
712    chan_sip and chan_pjsip.
713
714    Both channel drivers match incoming reason values with values documented
715    by REDIRECTING(reason) and values documented by RFC5806 regardless of
716    whether they are quoted or not.  RFC5806 values are mapped to the
717    equivalent REDIRECTING(reason) documented value and is set in
718    REDIRECTING(reason).  e.g., an incoming RFC5806 'unconditional' value or a
719    quoted string version ('"unconditional"') is converted to
720    REDIRECTING(reason)'s 'cfu' value.  The user's dialplan only needs to deal
721    with 'cfu' instead of any of the aliases.
722
723    The incoming 480 response reason text supported by chan_sip checks for
724    known reason values and if not matched then puts quotes around the reason
725    string and assigns that to REDIRECTING(reason).
726
727    Both channel drivers send outgoing known REDIRECTING(reason) values as the
728    unquoted RFC5806 equivalent.  User custom values are either sent as is or
729    with added quotes if SIP doesn't allow a character within the value as
730    part of a RFC3261 Section 25.1 token.  Note that there are still
731    limitations on what characters can be put in a custom user value.  e.g.,
732    embedding quotes in the middle of the reason string is just going to cause
733    you grief.
734
735  * Setting a REDIRECTING(reason) value now recognizes RFC5806 aliases.
736    e.g., Setting REDIRECTING(reason) to 'unconditional' is converted to the
737    'cfu' value.
738
739 res_pjproject
740 ------------------
741  * This module is the successor of res_pjsip_log_forwarder.  As well as
742    handling the log forwarding (which now displays as 'pjproject:0' instead
743    of 'pjsip:0'), it also adds a 'pjproject show buildopts' command to the CLI.
744    This displays the compiled-in options of the pjproject installation
745    Asterisk is currently running against.
746
747  * Another feature of this module is the ability to map pjproject log levels
748    to Asterisk log levels, or to suppress the pjproject log messages
749    altogether.  Many of the messages emitted by pjproject itself are the result
750    of errors which Asterisk will ultimately handle so the messages can be
751    misleading or just noise.  A new config file (pjproject.conf) has been added
752    to configure the mapping and a new CLI command (pjproject show log mappings)
753    has been added to display the mappings currently in use.
754
755 res_pjsip
756 ------------------
757  * Transports are now reloadable.  In testing, no in-progress calls were
758    disrupted if the ip address or port weren't changed, but the possibility
759    still exists.  To make sure there are no unintentional drops, a new option
760    'allow_reload', which defaults to 'no' has been added to transport.  If
761    left at the default, changes to the particular transport will be ignored.
762    If set to 'yes', changes (if any) will be applied.
763
764  * Added new global option (regcontext) to pjsip. When set, Asterisk will
765    dynamically create and destroy a NoOp priority 1 extension
766    for a given endpoint who registers or unregisters with us.
767
768  * Endpoints and aors can now be identified by the username and realm in an
769    incoming Authorization header.  To use this feature, add "auth_username"
770    to your endpoint's "identify_by" list.  You can combine "auth_username"
771    and the original "username" to test both the From/To and Authorization
772    headers.  For endpoints, the order is controlled by the global
773    "endpoint_identifier_order" setting.  For matching aors to an endpoint
774    for inbound registration, the order is controlled by this option.
775
776  * In conjunction with the "auth_username" change, 3 new options have been
777    added to the global configuration object that control how many unidentified
778    requests over a certain period from the same IP address can be received
779    before a security altert is generated.  A new CLI command
780    "pjsip show unidentified_requests" will list the current candidates.
781
782 res_pjsip_history
783 ------------------
784  * A new module, res_pjsip_history, has been added that provides SIP history
785    viewing/filtering from the CLI. The module is intended to be used on systems
786    with busy SIP traffic, where existing forms of viewing SIP messages - such
787    as the res_pjsip_logger - may be inadequate. The module provides two new
788    CLI commands:
789    - 'pjsip set history {on|off|clear}' - this enables/disables SIP history
790      capturing, as well as clears an existing history capture. Note that SIP
791      packets captured are stored in memory until cleared. As a result, the
792      history capture should only be used for debugging/viewing purposes, and
793      should *NOT* be left permanently enabled on a system.
794    - 'pjsip show history' - displays the captured SIP history. When invoked
795      with no options, the entire captured history is displayed. Two options
796      are available:
797      -- 'entry <num>' - display a detailed view of a single SIP message in
798         the history
799      -- 'where ...' - filter the history based on some expression. For more
800         information on filtering, view the current CLI help for the
801         'pjsip show history' command.
802
803 Voicemail
804 ------------------
805  * app_voicemail and res_mwi_external can now be built together.  The default
806    remains to build app_voicemail and not res_mwi_external but if they are
807    both built, the load order will cause res_mwi_external to load first and
808    app_voicemail will be skipped.  Use 'preload=app_voicemail.so' in
809    modules.conf to force app_voicemail to be the voicemail provider.
810
811 res_pjsip_sdp_rtp
812 ------------------
813  * A new option (bind_rtp_to_media_address) has been added to endpoint which
814    will cause res_pjsip_sdp_rtp to actually bind the RTP instance to the
815    media_address as well as using it in the SDP.  If set, RTP packets will now
816    originate from the media address instead of the operating system's "primary"
817    ip address.
818
819 res_rtp_asterisk
820 ------------------
821  * A new configuration section - ice_host_candidates - has been added to
822    rtp.conf, allowing automatically discovered ICE host candidates to be
823    overriden. This allows an Asterisk server behind a 1:1 NAT to send its
824    external IP as a host candidate rather than relying on STUN to discover it.
825
826 ------------------------------------------------------------------------------
827 --- Functionality changes from Asterisk 13.6.0 to Asterisk 13.7.0 ------------
828 ------------------------------------------------------------------------------
829
830 Codecs
831 ------------------
832  * Added format attribute negotiation for the VP8 video codec. Format attribute
833    negotiation is provided by the res_format_attr_vp8 module.
834
835 ConfBridge
836 ------------------
837  * A new "timeout" user profile option has been added. This configures the number
838    of seconds that a participant may stay in the ConfBridge after joining. When
839    the time expires, the user is ejected from the conference and CONFBRIDGE_RESULT
840    is set to "TIMEOUT" on the channel.
841
842 chan_sip
843 ------------------
844  * The websockets_enabled option has been added to the general section of
845    sip.conf.  The option is enabled by default to match the previous behavior.
846    The option should be disabled when using res_pjsip_transport_websockets to
847    ensure chan_sip will not conflict with PJSIP websockets.
848
849 Dialplan Functions
850 ------------------
851  * The HOLD_INTERCEPT dialplan function now actually exists in the source tree.
852    While support for the events was added in Asterisk 13.4.0, the function
853    accidentally never made it in. That function is now present, and will cause
854    the 'hold' raised by a channel to be intercepted and converted into an
855    event instead.
856
857 res_pjsip_outbound_registration
858 -------------------------------
859  * If res_statsd is loaded and a StatsD server is configured, basic statistics
860    regarding the state of outbound registrations will now be emitted. This
861    includes:
862    - A GAUGE statistic for the overall number of outbound registrations, i.e.:
863        PJSIP.registrations.count
864    - A GAUGE statistic for the overall number of outbound registrations in a
865      particular state, e.g.:
866        PJSIP.registrations.state.Registered
867
868 res_pjsip
869 ------------------
870  * The ability to use "like" has been added to the pjsip list and show
871    CLI commands.  For instance: CLI> pjsip list endpoints like abc
872
873  * If res_statsd is loaded and a StatsD server is configured, basic statistics
874    regarding the state of PJSIP contacts will now be emitted. This includes:
875    - A GAUGE statistic for the overall number of contacts in a particular
876      state, e.g.:
877        PJSIP.contacts.states.Reachable
878    - A TIMER statistic for the RTT time for each qualified contact, e.g.:
879        PJSIP.contacts.alice@@127.0.0.1:5061.rtt
880
881 res_sorcery_memory_cache
882 ------------------------
883  * A new caching strategy, full_backend_cache, has been added which caches
884    all stored objects in the backend. When enabled all objects will be
885    expired or go stale according to the configuration. As well when enabled
886    all retrieval operations will be performed against the cache instead of
887    the backend.
888
889 func_callerid
890 -------------------
891  * CALLERID(pres) is now documented as a valid alternative to setting both
892    CALLERID(name-pres) and CALLERID(num-pres) at once.  Some channel drivers,
893    like chan_sip, don't make a distinction between the two: they take the
894    least public value from name-pres and num-pres.  By using CALLERID(pres)
895    for reading and writing, you touch the same combined value in the dialplan.
896    The same applies to CONNECTEDLINE(pres), REDIRECTING(orig-pres),
897    REDIRECTING(to-pres) and REDIRECTING(from-pres).
898
899 res_endpoint_stats
900 -------------------
901  * A new module that emits StatsD statistics regarding Asterisk endpoints.
902    This includes a total count of the number of endpoints, the count of the
903    number of endpoints in the technology agnostic state of the endpoint -
904    online or offline - as well as the number of channels associated with each
905    endpoint. These are recorded as three different GAUGE statistics:
906     - endpoints.count
907     - endpoints.state.{unknown|offline|online}
908     - endpoints.{tech}.{resource}.channels
909
910
911 ------------------------------------------------------------------------------
912 --- Functionality changes from Asterisk 13.5.0 to Asterisk 13.6.0 ------------
913 ------------------------------------------------------------------------------
914
915 Dialplan Functions
916 ------------------
917  * The CHANNEL function, when used on a PJSIP channel, now exposes a 'call-id'
918    extraction option when using with the 'pjsip' signalling option. It will
919    return the SIP Call-ID associated with the INVITE request that established
920    the PJSIP channel.
921
922 ARI
923 ------------------
924  * Two new endpoint related events are now available: PeerStatusChange and
925    ContactStatusChange. In particular, these events are useful when subscribing
926    to all event sources, as they provide additional endpoint related
927    information beyond the addition/removal of channels from an endpoint.
928
929  * Added the ability to subscribe to all ARI events in Asterisk, regardless
930    of whether the application 'controls' the resource. This is useful for
931    scenarios where an ARI application merely wants to observe the system,
932    as opposed to control it. There are two ways to accomplish this:
933    (1) Via the WebSocket connection URI. A new query paramter, 'subscribeAll',
934        has been added that, when present and True, will subscribe all
935        specified applications to all ARI event sources in Asterisk.
936    (2) Via the applications resource. An ARI client can, at any time, subscribe
937        to all resources in an event source merely by not providing an explicit
938        resource. For example, subscribing to an event source of 'channels:'
939        as opposed to 'channels:12345' will subscribe the application to all
940        channels.
941
942 ------------------------------------------------------------------------------
943 --- Functionality changes from Asterisk 13.4.0 to Asterisk 13.5.0 ------------
944 ------------------------------------------------------------------------------
945
946 AMI
947 ------------------
948  * A new ContactStatus event has been added that reflects res_pjsip contact
949    lifecycle changes:  Created, Removed, Reachable, Unreachable, Unknown.
950
951  * Added the Linkedid header to the common channel headers listed for each
952    channel in AMI events.
953
954 ARI
955 ------------------
956  * A new feature has been added that enables the retrieval of modules and
957    module information through an HTTP request. Information on a single module
958    can be also be retrieved. Individual modules can be loaded to Asterisk, as
959    well as unloaded and reloaded.
960
961 * A new resource has been added to the 'asterisk' resource, 'config/dynamic'.
962    This resource allows for push configuration of sorcery derived objects
963    within Asterisk. The resource supports creation, retrieval, updating, and
964    deletion. Sorcery derived objects that are manipulated by this resource
965    must have a sorcery wizard that supports the desired operations.
966
967  * A new feature has been added that allows for the rotation of log channels
968    through HTTP requests.
969
970
971 res_pjsip
972 ------------------
973 * A new 'g726_non_standard' endpoint option has been added that, when set to
974   'yes' and g.726 audio is negotiated, forces the codec to be treated as if it
975   is AAL2 packed on the channel.
976
977 * A new 'rtp_keepalive' endpoint option has been added. This option specifies
978   an interval, in seconds, at which we will send RTP comfort noise packets to
979   the endpoint. This functions identically to chan_sip's "rtpkeepalive" option.
980
981 * New 'rtp_timeout' and 'rtp_timeout_hold' endpoint options have been added.
982   These options specify the amount of time, in seconds, that Asterisk will wait
983   before terminating the call due to lack of received RTP. These are identical
984   to chan_sip's rtptimeout and rtpholdtimeout options.
985
986 ------------------------------------------------------------------------------
987 --- Functionality changes from Asterisk 13.3.0 to Asterisk 13.4.0 ------------
988 ------------------------------------------------------------------------------
989
990 chan_pjsip
991 ------------------
992  * New 'rpid_immediate' option to control if connected line update information
993    goes to the caller immediately or waits for another reason to send the
994    connected line information update.  See the online option documentation for
995    more information.  Defaults to 'no' as setting it to 'yes' can result in
996    many unnecessary messages being sent to the caller.
997
998  * The configuration setting 'progressinband' now defaults to 'no', which
999    matches the actual behavior of previous versions.
1000
1001 res_pjsip
1002 ------------------
1003  * A new CLI command has been added: "pjsip show settings", which shows
1004    both the global and system configuration settings.
1005
1006  * A new aor option has been added: "qualify_timeout", which sets the timeout
1007    in seconds for a qualify.  The default is 3 seconds.  This overrides the
1008    hard coded 32 seconds in pjproject.
1009
1010  * Endpoint status will now change to "Unreachable" when all contacts are
1011    unavailable.  When any contact becomes available, the endpoint will status
1012    will change back to "Reachable".
1013
1014  * A new global option has been added: "max_initial_qualify_time", which
1015    sets the maximum amount of time from startup that qualifies should be
1016    attempted on all contacts.
1017
1018 res_ari_channels
1019 ------------------
1020  * Two new events, 'ChannelHold' and 'ChannelUnhold', have been added to the
1021    events data model. These events are raised when a channel indicates a hold
1022    or unhold, respectively.
1023
1024 func_holdintercept
1025 ------------------
1026  * A new dialplan function, HOLD_INTERCEPT, has been added. This function, when
1027    placed on a channel, intercepts hold/unhold indications signalled by the
1028    channel and prevents them from moving on to other channels in a bridge with
1029    the hold initiator. Instead, AMI or ARI events are raised indicating that
1030    the channel wanted to place someone on hold. This allows external
1031    applications to implement their own custom hold/unhold logic.
1032
1033 ------------------------------------------------------------------------------
1034 --- Functionality changes from Asterisk 13.2.0 to Asterisk 13.3.0 ------------
1035 ------------------------------------------------------------------------------
1036
1037 chan_pjsip/app_transfer
1038 ------------------
1039  * The Transfer application, when used with chan_pjsip, now supports using
1040    a PJSIP endpoint as the transfer destination. This is in addition to
1041    explicitly specifying a SIP URI to transfer to.
1042
1043 res_ari_channels
1044 ------------------
1045  * The ARI /channels resource now supports a new operation, 'redirect'. The
1046    redirect operation will perform a technology and state specific redirection
1047    on the channel to a specified endpoint or destination. In the case of SIP
1048    technologies, this is either a 302 Redirect response to an on-going INVITE
1049    dialog or a SIP REFER request.
1050
1051 res_pjsip
1052 ------------------
1053  * A new 'endpoint_identifier_order' option has been added that allows one to
1054    set the order by which endpoint identifiers are processed and checked. This
1055    option is specified under the 'global' type configuration section.
1056
1057 ------------------------------------------------------------------------------
1058 --- Functionality changes from Asterisk 13.1.0 to Asterisk 13.2.0 ------------
1059 ------------------------------------------------------------------------------
1060
1061  * New 'PJSIP_AOR' and 'PJSIP_CONTACT' dialplan functions have been added which
1062    allow examining PJSIP AORs or contacts from the dialplan.
1063
1064 res_pjsip_outbound_registration
1065 ------------------
1066  * The 'pjsip send unregister' command now stops further registrations.
1067
1068  * A new command 'pjsip send register' has been added which allows you to
1069    start or restart periodic registration.  It can be used after a
1070    'send unregister' or after a 401 permanent error.
1071
1072 res_pjsip_config_wizard
1073 ------------------
1074  * This is a new module that adds streamlined configuration capability for
1075    chan_pjsip.  It's targeted at users who have lots of basic configuration
1076    scenarios like 'phone' or 'agent' or 'trunk'.  Additional information
1077    can be found in the sample configuration file at
1078    config/samples/pjsip_wizard.conf.sample.
1079
1080 res_fax
1081 -----------
1082  * The T.38 negotiation timeout was previously hard coded at 5000 milliseconds
1083    and is now configurable via the 't38timeout' configuration option in
1084    res_fax.conf and via the fax options dialplan function 'FAXOPT(t38timeout)'.
1085    The default remains at 5000 milliseconds.
1086
1087 PJSIP Transports
1088 ----------
1089  * The ca_list_path transport parameter has been added for TLS transports. This
1090    option behaves similarly to the old sip.conf option "tlscapath". In order to
1091    use this, you must be using PJProject version 2.4 or higher.
1092
1093 ARI
1094 ------------------
1095  * The Originate operation now takes in an originator channel. The linked ID of
1096    this originator channel is applied to the newly originated outgoing channel.
1097    If using CEL this allows an association to be established between the two so
1098    it can be recognized that the originator is dialing the originated channel.
1099
1100  * "language" (the default spoken language for the channel) is now included in
1101    the standard channel state output for suitable events.
1102
1103  * The POST channels/{id} operation and the POST channels/{id}/continue operation
1104    now have a new "label" parameter. This allows for origination or continuation
1105    to a labeled priority in the dialplan instead of requiring a specific priority
1106    number. The ARI version has been bumped to 1.7.0 as a result.
1107
1108 AMI
1109 ------------------
1110  * "Language" (the default spoken language for the channel) is now included in
1111    the standard channel state output for suitable events.
1112
1113  * AMI actions that return a list of events have been made to return consistent
1114    headers for the action response event starting the list and the list complete
1115    event.  The AMI version has been bumped to 2.7.0 as a result.
1116
1117 ------------------------------------------------------------------------------
1118 --- Functionality changes from Asterisk 13.0.0 to Asterisk 13.1.0 ------------
1119 ------------------------------------------------------------------------------
1120
1121 AMI
1122 ------------------
1123  * Event NewConnectedLine is emitted when the connected line information on
1124    a channel changes.
1125
1126 ARI
1127 ------------------
1128  * Event ChannelConnectedLine is emitted when the connected line information
1129    on a channel changes.
1130
1131 Core Transfers
1132 -----------------
1133
1134 The features.conf general section has three new configurable options:
1135     * transferdialattempts
1136     * transferretrysound
1137     * transferinvalidsound
1138 For more information on what these options do, see the Asterisk wiki:
1139  https://wiki.asterisk.org/wiki/x/W4fAAQ
1140
1141 Channel Drivers
1142 ------------------
1143
1144 chan_pjsip
1145 ------------------
1146  * New 'media_encryption_optimistic' endpoint setting. This will use SRTP
1147    when possible but does not consider lack of it a failure.
1148
1149 res_pjsip_endpoint_identifer_ip
1150 ------------------
1151  * New CLI commands have been added: "pjsip show identif(y|ies)", which lists
1152    all configured PJSIP identify objects
1153    
1154 ------------------------------------------------------------------------------
1155 --- Functionality changes from Asterisk 12 to Asterisk 13 --------------------
1156 ------------------------------------------------------------------------------
1157
1158 Overview
1159 ------------------
1160
1161 Asterisk 13 is the next Long Term Support (LTS) release of Asterisk. As such,
1162 the focus of development for this release of Asterisk was on improving the
1163 usability and features developed in the previous Standard release, Asterisk 12.
1164 Beyond a general refinement of end user features, development focussed heavily
1165 on the Asterisk APIs - the Asterisk Manager Interface (AMI) and the Asterisk
1166 REST Interface (ARI) - and the PJSIP stack in Asterisk. Some highlights of the
1167 new features include:
1168
1169 * Asterisk security events are now provided via AMI, allowing end users to
1170   monitor their Asterisk system in real time for security related issues.
1171 * External control of Message Waiting Indicators (MWI) through both AMI and ARI.
1172 * Reception/transmission of out of call text messages using any supported
1173   channel driver/protocol stack through ARI.
1174 * Resource List Server support in the PJSIP stack, providing subscriptions to
1175   lists of resources and batched delivery of NOTIFY requests.
1176 * Inter-Asterisk distributed device state and mailbox state using the PJSIP
1177   stack.
1178
1179 It is important to note that Asterisk 13 is built on the architecture developed
1180 during the previous Standard release, Asterisk 12. Users upgrading to
1181 Asterisk 13 should read about the new features in Asterisk 12 later in this file
1182 (see Functionality changes from Asterisk 11 to Asterisk 12), as well as the
1183 UPGRADE-12.txt delivered with this release. In particular, users upgrading to
1184 Asterisk 13 from a release prior to Asterisk 12 should read the specifications
1185 on AMI, CDRs, and CEL on the Asterisk wiki:
1186  * AMI - https://wiki.asterisk.org/wiki/x/dAFRAQ
1187  * CEL - https://wiki.asterisk.org/wiki/x/4ICLAQ
1188  * CDRs - https://wiki.asterisk.org/wiki/x/pwpRAQ
1189
1190 Many new featuers in Asterisk 13 were introduced in point releases of
1191 Asterisk 12. Following this section - which documents the changes from all
1192 versions of Asterisk 12 to Asterisk 13 - users should examine the new features
1193 that were introduced in the point releases of Asterisk 12, as they are also
1194 included in Asterisk 13.
1195
1196 Finally, all users upgrading to Asterisk 13 should read the UPGRADE.txt file
1197 delivered with this release.
1198
1199
1200 Build System
1201 ------------------
1202  * Sample config files have been moved from configs/ to a sub-folder of that
1203    directory, samples.
1204
1205  * The menuselect utility has been pulled into the Asterisk repository. As a
1206    result, the libxml2 development library is now a required dependency for
1207    Asterisk.
1208
1209  * A new Compiler Flag, REF_DEBUG, has been added. When enabled, reference
1210    counted objects will emit additional debug information to the refs log file
1211    located in the standard Asterisk log file directory. This log file is useful
1212    in tracking down object leaks and other reference counting issues. Prior to
1213    this version, this option was only available by modifying the source code
1214    directly. This change also includes a new script, refcounter.py, in the
1215    contrib folder that will process the refs log file. Note that this replaces
1216    the refcounter utility that could be built from the utils directory.
1217
1218
1219 Applications
1220 ------------------
1221
1222 DahdiBarge
1223 ------------------
1224  * This module was deprecated and has been removed. Users of app_dahdibarge
1225    should use ChanSpy instead.
1226
1227 MixMonitor
1228 ------------------
1229  * New options to play a beep when starting a recording and stopping a recording
1230    have been added.  The option "p" will play a beep to the channel that starts
1231    the recording.  The option "P" will play a beep to the channel that stops the
1232    recording.
1233
1234 Queue
1235 ------------------
1236  * Queue rules can now be stored in a database table, queue_rules. Unlike other
1237    RealTime tables, the queue_rules table is only examined on module load or
1238    module reload. A new general setting has been added to queuerules.conf,
1239    'realtime_rules', which, when set to 'yes', will cause app_queue to look in
1240    RealTime for additional queue rules to parse. Note that both the file and
1241    the database can be used as a provide of queue rules when 'realtime_rules'
1242    is set to 'yes'.
1243
1244    When app_queue is reloaded, all rules are re-parsed and loaded into memory.
1245    There is no caching of RealTime queue rules.
1246
1247 ReadFile
1248 ------------------
1249  * This module was deprecated and has been removed. Users of app_readfile
1250    should use func_env's FILE function instead.
1251
1252 Say
1253 ------------------
1254  * The 'say' family of dialplan applications now support the Japanese
1255    language. The 'language' parameter in say.conf now recognizes a setting of
1256    'ja', which will enable Japanese language specific mechanisms for playing
1257    back numbers, dates, and other items.
1258  * Counting, enumeration and dates now supports Icelandic grammar with the
1259    'language' parameter set to 'is'.
1260
1261 SayCountPL
1262 ------------------
1263  * This module was deprecated and has been removed. Users of app_saycountpl
1264    should use the Say family of applications.
1265
1266 SetMusicOnHold
1267 ------------------
1268  * The SetMusicOnHold dialplan application was deprecated and has been removed.
1269    Users of the application should use the CHANNEL function's musicclass
1270    setting instead.
1271
1272 WaitMusicOnHold
1273 ------------------
1274  * The WaitMusicOnHold dialplan application was deprecated and has been
1275    removed. Users of the application should use MusicOnHold with a duration
1276    parameter instead.
1277
1278 VoiceMail
1279 ------------------
1280  * VoiceMail and VoiceMailMain now support the Japanese language. The
1281    'language' parameter in voicemail.conf now recognizes a setting of 'ja',
1282    which will enable prompts to be played back using a Japanese grammatical
1283    structure. Additional prompts are necessary for this functionality,
1284    including:
1285    - jb-arimasu: there is
1286    - jb-arimasen: there is not
1287    - jb-oshitekudasai: please press
1288    - jb-ni: article ni
1289    - jb-ga: article ga
1290    - jb-wa: article wa
1291    - jb-wo: article wo
1292
1293  * Add the ability to specify multiple email addresses in configuration,
1294    separated by a |.
1295
1296
1297 CDR Backends
1298 ------------------
1299
1300 cdr_sqlite
1301 -----------------
1302  * This module was deprecated and has been removed. Users of cdr_sqlite
1303    should use cdr_sqlite3_custom.
1304
1305 cdr_pgsql
1306 ------------------
1307  * Added the ability to support PostgreSQL application_name on connections.
1308    This allows PostgreSQL to display the configured name in the
1309    pg_stat_activity view and CSV log entries. This setting is configurable
1310    for cdr_pgsql via the appname configuration setting in cdr_pgsql.conf.
1311
1312
1313 CEL Backends
1314 ------------------
1315
1316 cel_pgsql
1317 ------------------
1318  * Added the ability to support PostgreSQL application_name on connections.
1319    This allows PostgreSQL to display the configured name in the
1320    pg_stat_activity view and CSV log entries. This setting is configurable
1321    for cel_pgsql via the appname configuration setting in cel_pgsql.conf.
1322
1323
1324 Channel Drivers
1325 ------------------
1326
1327 chan_dahdi
1328 ------------------
1329  * SS7 support now requires libss7 v2.0 or later.
1330
1331  * Added SS7 support for connected line and redirecting.
1332
1333  * Most SS7 CLI commands are reworked as well as new SS7 commands added.
1334    See online CLI help.
1335
1336  * Added several SS7 config option parameters described in
1337    chan_dahdi.conf.sample.
1338
1339 chan_gtalk
1340 ------------------
1341  * This module was deprecated and has been removed. Users of chan_gtalk
1342    should use chan_motif.
1343
1344 chan_h323
1345 ------------------
1346  * This module was deprecated and has been removed. Users of chan_h323
1347    should use chan_ooh323.
1348
1349 chan_jingle
1350 ------------------
1351  * This module was deprecated and has been removed. Users of chan_jingle
1352    should use chan_motif.
1353
1354 chan_pjsip
1355 ------------------
1356  * Added the CLI command 'pjsip list ciphers' so a user can know what
1357    OpenSSL names are available on their system for the pjsip.conf cipher
1358    option.
1359
1360 chan_sip
1361 ------------------
1362  * The SIPPEER dialplan function no longer supports using a colon as a
1363    delimiter for parameters. The parameters for the function should be
1364    delimited using a comma.
1365
1366  * The SIPCHANINFO dialplan function was deprecated and has been removed. Users
1367    of the function should use the CHANNEL function instead.
1368
1369
1370 Core
1371 ------------------
1372
1373 Account Codes
1374 ------------------
1375  * Added functional peeraccount support.  Except for Queue, the
1376    accountcode propagation is now consistently propagated to outgoing
1377    channels before dialing.  The channel accountcode can change from its
1378    original non-empty value on channel creation for the following specific
1379    reasons.  One, dialplan sets it using CHANNEL(accountcode).  Two, an
1380    originate method that can specify an accountcode value.  Three, the
1381    calling channel propagates its peeraccount or accountcode to the
1382    outgoing channel's accountcode before dialing.  The change has two
1383    visible effects.  One, local channels now cross accountcode and
1384    peeraccount across the special bridge between the ;1 and ;2 channels
1385    just like channels between normal bridges.  Two, the
1386    CHANNEL(peeraccount) value can now be set before Dial and FollowMe to
1387    set the accountcode on the outgoing channel(s).
1388
1389    For Queue, an outgoing channel's non-empty accountcode will not change
1390    unless explicitly set by CHANNEL(accountcode).  The change has three
1391    visible effects.  One, local channels now cross accountcode and
1392    peeraccount across the special bridge between the ;1 and ;2 channels
1393    just like channels between normal bridges.  Two, the queue member will
1394    get an accountcode if it doesn't have one and one is available from the
1395    calling channel's peeraccount.  Three, accountcode propagation includes
1396    local channel members where the accountcodes are propagated early
1397    enough to be available on the ;2 channel.
1398
1399 AMI
1400 ------------------
1401  * New DeviceStateChanged and PresenceStateChanged AMI events have been added.
1402    These events are emitted whenever a device state or presence state change
1403    occurs. The events are controlled by res_manager_device_state.so and
1404    res_manager_presence_state.so. If the high frequency of these events is
1405    problematic for you, do not load these modules.
1406
1407  * Added DialplanExtensionAdd and DialplanExtensionRemove AMI commands. They
1408    work in basically the same way as the 'dialplan add extension' and
1409    'dialplan remove extension' CLI commands respectively.
1410
1411  * New AMI action LoggerRotate reloads and rotates logger in the same manner
1412    as CLI command 'logger rotate'
1413
1414  * New AMI Actions FAXSessions, FAXSession, and FAXStats replicate the
1415    functionality of CLI commands 'fax show sessions', 'fax show session',
1416    and fax show stats' respectively.
1417
1418  * New AMI actions PRIDebugSet, PRIDebugFileSet, and PRIDebugFileUnset
1419    enable manager control over PRI debugging levels and file output.
1420
1421  * AMI action PJSIPNotify may now send to a URI instead of only to a PJSIP
1422    endpoint as long as a default outbound endpoint is set. This also applies
1423    to the equivalent CLI command (pjsip send notify)
1424
1425  * The AMI action PJSIPShowEndpoint now includes ContactStatusDetail sections
1426    that give information on Asterisk's attempts to qualify the endpoint.
1427
1428  * The DialEnd event will now contain a Forward header if the dial is ending
1429    due to the call being forwarded. The contents of the Forward header is the
1430    extension in the number to which the call is being forwarded.
1431
1432 CEL
1433 ------------------
1434  * The "bridge_technology" extra field key has been added to BRIDGE_ENTER
1435    and BRIDGE_EXIT events.
1436
1437 Features
1438 ------------------
1439  * Channel variables are now substituted in arguments passed to applications
1440    run by using dynamic features.
1441
1442 TLS
1443 ------------------
1444  * The TLS core in Asterisk now supports Perfect Forward Secrecy (PFS).
1445    Enabling PFS is attempted by default, and is dependent on the configuration
1446    of the module using TLS.
1447    - Ephemeral ECDH (ECDHE) is enabled by default. To disable it, do not
1448      specify a ECDHE cipher suite in sip.conf, for example:
1449        tlscipher=AES128-SHA:DES-CBC3-SHA
1450    - Ephemeral DH (DHE) is disabled by default. To enable it, add DH parameters
1451      into the private key file, e.g., sip.conf tlsprivatekey. For example, the
1452      default dh2048.pem - see
1453      http://www.opensource.apple.com/source/OpenSSL098/OpenSSL098-35.1/src/apps/dh2048.pem?txt
1454    - Because clients expect the server to prefer PFS, and because OpenSSL sorts
1455      its cipher suites by bit strength, see "openssl ciphers -v DEFAULT".
1456      Consider re-ordering your cipher suites in the respective configuration
1457      file. For example:
1458        tlscipher=AES128+kEECDH:AES128+kEDH:3DES+kEDH:AES128-SHA:DES-CBC3-SHA:-ADH:-AECDH
1459      will use PFS when offered by the client. Clients which do not offer PFS
1460      fall-back to AES-128 (or even 3DES, as recommended by RFC 3261).
1461
1462
1463 Functions
1464 ------------------
1465
1466 JACK_HOOK
1467 ------------------
1468  * The JACK_HOOK function now supports audio with a sample rate higher than
1469    8kHz.
1470
1471
1472 Resources
1473 ------------------
1474
1475 res_config_pgsql
1476 ------------------
1477  * Added the ability to support PostgreSQL application_name on connections.
1478    This allows PostgreSQL to display the configured name in the
1479    pg_stat_activity view and CSV log entries. This setting is configurable
1480    for res_config_pgsql via the dbappname configuration setting in
1481    res_pgsql.conf.
1482
1483 res_pjsip_outbound_publish
1484 ------------------
1485  * A new module, res_pjsip_outbound_publish provides the mechanisms for sending
1486    PUBLISH requests for specific event packages to another SIP User Agent.
1487
1488 res_pjsip_pubsub
1489 ------------------
1490  * The publish/subscribe core module has been updated to support RFC 4662
1491    Resource Lists, allowing Asterisk to act as a Resource List Server (RLS).
1492    Resource lists are configured in pjsip.conf under a new object type,
1493    resource_list. Resource lists can contain either message-summary or presence
1494    events, and can be composed of specific resources that provide the event or
1495    other resource lists.
1496
1497  * Inbound publication support is provided by a new object, inbound-publication.
1498    This configures res_pjsip_pubsub to accept PUBLISH requests from a particular
1499    resource. Which events are accepted is constructed dynamically; see
1500    res_pjsip_publish_asterisk for more information.
1501
1502 res_pjsip_publish_asterisk
1503 ------------------
1504  * A new module, res_pjsip_publish_asterisk adds support for PUBLISH requests of
1505    Asterisk information to other Asterisk servers. This module is intended only
1506    for Asterisk to Asterisk exchanges of information. Currently, this includes
1507    both mailbox state and device state information.
1508
1509 ------------------------------------------------------------------------------
1510 --- Functionality changes from Asterisk 12.4.0 to Asterisk 12.5.0 ------------
1511 ------------------------------------------------------------------------------
1512
1513 ARI
1514 ------------------
1515  * Stored recordings now support a new operation, copy. This will take an
1516    existing stored recording and copy it to a new location in the recordings
1517    directory.
1518
1519  * LiveRecording objects now have three additional fields that can be reported
1520    in a RecordingFinished ARI event:
1521    - total_duration: the duration of the recording
1522    - talking_duration: optional. The duration of talking detected in the
1523      recording. This is only available if max_silence_seconds was specified
1524      when the recording was started.
1525    - silence_duration: optional. The duration of silence detected in the
1526      recording. This is only available if max_silence_seconds was specified
1527      when the recording was started.
1528    Note that all duration values are reported in seconds.
1529
1530  * Users of ARI can now send and receive out of call text messages. Messages
1531    can be sent directly to a particular endpoint, or can be sent to the
1532    endpoints resource directly and inferred from the URI scheme. Text
1533    messages are passed to ARI clients as TextMessageReceived events. ARI
1534    clients can choose to receive text messages by subscribing to the particular
1535    endpoint technology or endpoints that they are interested in.
1536
1537  * The applications resource now supports subscriptions to all endpoints of
1538    a particular channel technology. For example, subscribing to an eventSource
1539    of 'endpoint:PJSIP' will subscribe to all PJSIP endpoints.
1540
1541 res_pjsip
1542 ------------------
1543  * The endpoint configuration object now supports 'accountcode'. Any channel
1544    created for an endpoint with this setting will have its accountcode set
1545    to the specified value.
1546
1547 res_hep_rtcp
1548 ------------------
1549  * A new module, res_hep_rtcp, has been added that will forward RTCP call
1550    statistics to a HEP capture server. See res_hep for more information.
1551
1552 Functions
1553 ------------------
1554  * Function AUDIOHOOK_INHERIT has been deprecated. Audiohooks are now
1555    unconditionally inhereted through masquerades. As a side benefit, more
1556    than one audiohook of a given type may persist through a masquerade now.
1557
1558 ------------------------------------------------------------------------------
1559 --- Functionality changes from Asterisk 12.3.0 to Asterisk 12.4.0 ------------
1560 ------------------------------------------------------------------------------
1561
1562 AgentRequest
1563 ------------------
1564  * Returns new AGENT_STATUS value "NOT_CONNECTED" if the agent fails to
1565    connect with an incoming caller after being alerted to the presence
1566    of the incoming caller.  The most likely reason this would happen is
1567    the agent did not acknowledge the call in time.
1568
1569 AMI
1570 ------------------
1571  * New events have been added for the TALK_DETECT function. When the function
1572    is used on a channel, ChannelTalkingStart/ChannelTalkingStop events will be
1573    emitted to connected AMI clients indicating the start/stop of talking on
1574    the channel.
1575
1576 ARI
1577 ------------------
1578  * New event models have been aded for the TALK_DETECT function. When the
1579    function is used on a channel, ChannelTalkingStarted/ChannelTalkingFinished
1580    events will be emitted to connected WebSockets subscribed to the channel,
1581    indicating the start/stop of talking on the channel.
1582
1583 Functions
1584 ------------------
1585  * A new function, TALK_DETECT, has been added. When set on a channel, this
1586    fucntion causes events indicating the starting/stoping of talking on said
1587    channel to be emitted to both AMI and ARI clients.
1588
1589 ------------------------------------------------------------------------------
1590 --- Functionality changes from Asterisk 12.2.0 to Asterisk 12.3.0 ------------
1591 ------------------------------------------------------------------------------
1592
1593 ARI
1594 ------------------
1595  * A new Playback URI 'tone' has been added. Tones are specified either as
1596    an indication name (e.g. 'tone:busy') from indications.conf or as a tone
1597    pattern (e.g. 'tone:240/250,0/250'). Tones differ from normal playback
1598    URIs in that they must be stopped manually and will continue to occupy
1599    a channel's ARI control queue until they are stopped. They also can not
1600    be rewound or fastforwarded.
1601
1602  * User events can now be generated from ARI.  Events can be signalled with
1603    arbitrary json variables, and include one or more of channel, bridge, or
1604    endpoint snapshots.  An application must be specified which will receive
1605    the event message (other applications can subscribe to it).  The message
1606    will also be delivered via AMI provided a channel is attached.  Dialplan
1607    generated user event messages are still transmitted via the channel, and
1608    will only be received by a stasis application they are attached to or if
1609    the channel is subscribed to.
1610
1611 chan_sip
1612 -----------
1613  * SIP peers can now specify 'trust_id_outbound' which affects RPID/PAI
1614    fields for prohibited callingpres information. Values are legacy, no, and
1615    yes. By default, legacy is used.
1616    trust_id_outbound=legacy - behavior remains the same as 1.8.26.1. When
1617      dealing with prohibited callingpres and sendrpid=pai/rpid, RPID/PAI
1618      headers are appended to outbound SIP messages just as they are with
1619      allowed callingpres values, but data about the remote party's identity is
1620      anonymized.
1621      When sendrpid=rpid, only the remote party's domain is anonymized.
1622    trust_id_outbound=no - when dealing with prohibited callingpres, RPID/PAI
1623      headers are not sent.
1624    trust_id_outbound=yes - RPID/PAI headers are applied with the full remote
1625      party information in tact even for prohibited callingpres information.
1626      In the case of PAI, a Privacy: id header will be appended for prohibited
1627      calling information to communicate that the private information should
1628      not be relayed to untrusted parties.
1629
1630 res_parking
1631 ------------------
1632  * Manager action 'Park' now takes an additional argument 'AnnounceChannel'
1633    which can be used to announce the parked call's location to an arbitrary
1634    channel in a bridge. If 'Channel' and 'TimeoutChannel' are now the two
1635    parties in a one to one bridge, 'TimeoutChannel' is treated as having
1636    parked 'Channel' like with the Park Call DTMF feature and will receive
1637    announcements prior to being hung up.
1638
1639 ------------------------------------------------------------------------------
1640 --- Functionality changes from Asterisk 12.1.0 to Asterisk 12.2.0 ------------
1641 ------------------------------------------------------------------------------
1642
1643 Record
1644 ------------------
1645  * Record application now has an option 'o' which allows 0 to act as an exit
1646    key setting the RECORD_STATUS variable to 'OPERATOR' instead of 'DTMF'
1647
1648 ChanSpy
1649 --------------------------
1650  * ChanSpy now accepts a channel uniqueid or a fully specified channel name
1651    as the chanprefix parameter if the 'u' option is specified.
1652
1653 ConfBridge
1654 --------------------------
1655  * CONFBRIDGE dialplan function is now capable of creating/modifying dynamic
1656    conference user menus.
1657
1658  * CONFBRIDGE dialplan function is now capable of removing dynamic conference
1659    menus, bridge settings, and user settings that have been applied by the
1660    CONFBRIDGE dialplan function.
1661
1662  * The ConfBridge dialplan application now sets a channel variable,
1663    CONFBRIGE_RESULT, upon exiting. This variable can be used to determine
1664    how a channel exited the conference.
1665
1666  * Added conference user option 'announce_join_leave_review'. This option
1667    implies 'announce_join_leave' with the added effect that the user will
1668    be asked if they want to confirm or re-record the recording of their
1669    name when entering the conference
1670
1671 Directory
1672 --------------------------
1673  * At exit, the Directory application now sets a channel variable
1674    DIRECTORY_RESULT to one of the following based on the reason for exiting:
1675      OPERATOR    user requested operator by pressing '0' for operator
1676      ASSISTANT   user requested assistant by pressing '*' for assistant
1677      TIMEOUT     user pressed nothing and Directory stopped waiting
1678      HANGUP      user's channel hung up
1679      SELECTED    user selected a user from the directory and is routed
1680      USEREXIT    user pressed '#' from the selection prompt to exit
1681      FAILED      directory failed in a way that wasn't accounted for. Dang.
1682
1683 Monitor
1684 ------------------
1685  * Monitor() - A new option, B(), has been added that will turn on a periodic
1686    beep while the call is being recorded.
1687
1688 MusicOnHold
1689 --------------------------
1690  * MusicOnHold streams (all modes other than "files") now support wide band
1691    audio too.
1692
1693 Page
1694 --------------------------
1695  * Added options 'b' and 'B' to apply predial handlers for outgoing calls
1696    and for the channel executing Page respectively.
1697
1698 PickupChan
1699 --------------------------
1700  * PickupChan now accepts channel uniqueids of channels to pickup.
1701
1702 Say
1703 --------------------------
1704  * If a channel variable SAY_DTMF_INTERRUPT is present on a channel and set
1705    to 'true' (case insensitive), then any Say application (SayNumber,
1706    SayDigits, SayAlpha, SayAlphaCase, SayUnixTime, and SayCounted) will
1707    anticipate DTMF. If DTMF is received, these applications will behave like
1708    the background application and jump to the received extension once a match
1709    is established or after a short period of inactivity.
1710
1711 MixMonitor
1712 -------------------------
1713  * A new function, MIXMONITOR, has been added to allow access to individual
1714    instances of MixMonitor on a channel.
1715
1716  * A new option, B(), has been added that will turn on a periodic beep while the
1717    call is being recorded.
1718
1719
1720 Channel Drivers
1721 -------------------------
1722
1723 chan_sip
1724 -------------------------
1725  * TEL URI support for inbound INVITE requests has been added. chan_sip will
1726    now handle TEL schemes in the Request and From URIs. The phone-context in
1727    the Request URI will be stored in the SIPURIPHONECONTEXT channel variable on
1728    the inbound channel.
1729
1730 Core
1731 ------------------
1732  * Exposed sorcery-based configuration files like pjsip.conf to dialplans via
1733    the new AST_SORCERY diaplan function.
1734
1735  * Core Show Locks output now includes Thread/LWP ID if the platform
1736    supports this feature.
1737
1738  * New "logger add channel" and "logger remove channel" CLI commands have
1739    been added to allow creation and deletion of dynamic logger channels
1740    without configuration changes. These dynamic logger channels will only
1741    exist until the next restart of asterisk.
1742
1743 ARI
1744 ------------------
1745  * The live recording object on recording events now contains a target_uri
1746    field which contains the URI of what is being recorded.
1747
1748  * The bridge type used when creating a bridge is now a comma separated list of
1749    bridge properties. Valid options are: mixing, holding, dtmf_events, and
1750    proxy_media.
1751
1752  * A channelId can now be provided when creating a channel, either in the
1753    uri (POST channels/my-channel-id) or as query parameter.  A local channel
1754    will suffix the second channel id with ';2' unless provided as query
1755    parameter otherChannelId.
1756
1757  * A bridgeId can now be provided when creating a bridge, either in the uri
1758    (POST bridges/my-bridge-id) or as a query parameter.
1759
1760  * A playbackId can be provided when starting a playback, either in the uri
1761    (POST channels/my-channel-id/play/my-playback-id /
1762     POST bridges/my-bridge-id/play/my-playback-id)  or as a query parameter.
1763
1764  * A snoop channel can be started with a snoopId, in the uri or query.
1765
1766 AMI
1767 ------------------
1768  * Originate now takes optional parameters ChannelId and OtherChannelId,
1769    used to set the UniqueId on creation.  The other id is assigned to the
1770    second channel when dialing LOCAL, or defaults to appending ;2 if only
1771    the single Id is given.
1772
1773  * The Mixmonitor action now has a "Command" header that can be used to
1774    indicate a post-process command to run once recording finishes.
1775
1776 RealTime
1777 ------------------
1778  * A new set of Alembic scripts has been added for CDR tables. This will create
1779    a 'cdr' table with the default schema that Asterisk expects.
1780
1781
1782 Functions
1783 ------------------
1784  * A new function was added: PERIODIC_HOOK.  This allows running a periodic
1785    dialplan hook on a channel.  Any audio generated by this hook will be
1786    injected into the call.
1787
1788
1789 Resources
1790 ------------------
1791
1792 res_hep
1793 ------------------
1794  * A new module, res_hep, has been added, that acts as a generic packet
1795    capture agent for the Homer Encapsulation Protocol (HEP) version 3.
1796    It can be configured via hep.conf. Other modules can use res_hep to send
1797    message traffic to a HEP capture server.
1798
1799 res_hep_pjsip
1800 ------------------
1801  * A new module, res_hep_pjsip, has been added that will forward PJSIP
1802    message traffic to a HEP capture server. See res_hep for more
1803    information.
1804
1805 res_pjsip
1806 ------------------
1807  * transport and endpoint ToS options (tos, tos_audio, and tos_video) may now
1808    be set as the named set of ToS values (cs0-cs7, af11-af43, ef).
1809
1810  * Added the following new CLI commands:
1811    - "pjsip show contacts" - list all current PJSIP contacts.
1812    - "pjsip show contact" - show specific information about a current PJSIP
1813      contact.
1814    - "pjsip show channel" - show detailed information about a PJSIP channel.
1815
1816 res_pjsip_multihomed
1817 ------------------
1818  * A new module, res_pjsip_multihomed handles situations where the system
1819    Asterisk is running out has multiple interfaces. res_pjsip_multihomed
1820    determines which interface should be used during message sending.
1821
1822 res_pjsip_pidf_digium_body_supplement
1823 ------------------
1824  * A new module, res_pjsip_pidf_digium_body_supplement provides NOTIFY
1825    request body formatting for presence support in Digium phones.
1826
1827 res_pjsip_send_to_voicemail
1828 ------------------
1829  * A new module, res_pjsip_send_to_voicemail allows for REFER requests with
1830    particular headers to transfer a PJSIP channel directly to a particular
1831    extension that has VoiceMail. This is intended to be used with Digium
1832    phones that support this feature.
1833
1834 res_pjsip_outbound_registration
1835 ------------------
1836  * A new CLI command has been added: "pjsip show registrations", which lists
1837    all configured PJSIP registrations
1838
1839
1840 ------------------------------------------------------------------------------
1841 --- Functionality changes from Asterisk 12.0.0 to Asterisk 12.1.0 ------------
1842 ------------------------------------------------------------------------------
1843
1844 AMI
1845 ------------------
1846  * Added a new module that provides AMI control over MWI within Asterisk,
1847    res_mwi_external_ami. Note that this module depends on res_mwi_external;
1848    for more information on enabling this module, see res_mwi_external.
1849    This module provides the MWIGet/MWIUpdate/MWIDelete actions, as well as
1850    the MWIGet/MWIGetComplete events.
1851
1852  * The DialStatus field in the DialEnd event can now contain additional
1853    statuses that convey how the dial operation terminated. This includes
1854    ABORT, CONTINUE, and GOTO.
1855
1856  * AMI will now emit security events. A new class authorization has been
1857    added in manager.conf for the security events, 'security'. The new events
1858    are:
1859     - FailedACL - raised when a request violates an ACL check
1860     - InvalidAccountID - raised when a request fails an authentication
1861       check due to an invalid account ID
1862     - SessionLimit - raised when a request fails due to exceeding the
1863       number of allowed concurrent sessions for a service
1864     - MemoryLimit - raised when a request fails due to an internal memory
1865       allocation failure
1866     - LoadAverageLimit - raised when a request fails because a configured
1867       load average limit has been reached
1868     - RequestNotAllowed - raised when a request is not allowed by
1869       the service
1870     - AuthMethodNotAllowed - raised when a request used an authentication
1871       method not allowed by the service
1872     - RequestBadFormat - raised when a request is received with bad formatting
1873     - SuccessfulAuth - raised when a request successfully authenticates
1874     - UnexpectedAddress - raised when a request has a different source address
1875       then what is expected for a session already in progress with a service
1876     - ChallengeResponseFailed - raised when a request's attempt to authenticate
1877       has been challenged, and the request failed the authentication challenge
1878     - InvalidPassword - raised when a request provides an invalid password
1879       during an authentication attempt
1880     - ChallengeSent - raised when an Asterisk service send an authentication
1881       challenge to a request
1882     - InvalidTransport - raised when a request attempts to use a transport not
1883       allowed by the Asterisk service
1884
1885  * Bridge related events now have two additional fields: BridgeName and
1886    BridgeCreator. BridgeName is a descriptive name for the bridge;
1887    BridgeCreator is the name of the entity that created the bridge. This
1888    affects the following events: ConfbridgeStart, ConfbridgeEnd,
1889    ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
1890    ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
1891    AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
1892
1893 ARI
1894 ------------------
1895  * The Bridge data model now contains the additional fields 'name' and
1896    'creator'. The 'name' field conveys a descriptive name for the bridge;
1897    the 'creator' field conveys the name of the entity that created the bridge.
1898    This affects all responses to HTTP requests that return a Bridge data model
1899    as well as all event derived data models that contain a Bridge data model.
1900    The POST /bridges operation may now optionally specify a name to give to
1901    the bridge being created.
1902
1903  * Added a new ARI resource 'mailboxes' which allows the creation and
1904    modification of mailboxes managed by external MWI. Modules res_mwi_external
1905    and res_stasis_mailbox must be enabled to use this resource. For more
1906    information on external MWI control, see res_mwi_external.
1907
1908  * Added new events for externally initiated transfers. The event
1909    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
1910    of a bridge in the ARI controlled application to the dialplan; the
1911    BridgeAttendedTransfer event is raised when a channel initiates an
1912    attended transfer of a bridge in the ARI controlled application to the
1913    dialplan.
1914
1915  * Channel variables may now be specified as a body parameter to the
1916    POST /channels operation. The 'variables' key in the JSON is interpreted
1917    as a sequence of key/value pairs that will be added to the created channel
1918    as channel variables. Other parameters in the JSON body are treated as
1919    query parameters of the same name.
1920
1921 HTTP
1922 ------------------
1923  * Asterisk's HTTP server now supports chunked Transfer-Encoding. This will be
1924    automatically handled by the HTTP server if a request is received with a
1925    Transfer-Encoding type of "chunked".
1926
1927 res_pjsip
1928 ------------------
1929  * Path support has been added with the 'support_path' option in registration
1930    and aor sections.
1931
1932  * A 'debug' option has been added to the globals section that will allow
1933    sip messages to be logged.
1934
1935  * A 'set_var' option has been added to endpoints that will automatically
1936    set the desired variable(s) on a channel created for that endpoint.
1937
1938  * Several new tables and columns have been added to the realtime schema for
1939    the res_pjsip related modules. See the UPGRADE.txt notes for updating
1940    the database schema.
1941
1942 res_mwi_external
1943 ------------------
1944  * A new module, res_mwi_external, has been added to Asterisk. This module
1945    acts as a base framework that other modules can build on top of to allow
1946    an external system to control MWI within Asterisk. For implementations
1947    that make use of res_mwi_external, see res_mwi_external_ami and
1948    res_ari_mailboxes. Note that res_mwi_external canflicts with other modules
1949    that may produce MWI themselves, such as app_voicemail. res_mwi_external
1950    and other modules that depend on it cannot be built or loaded with
1951    app_voicemail present.
1952
1953 res_pjsip
1954 ------------------
1955  * DNS functionality will now automatically be enabled if the system configured
1956    nameservers can be retrieved. If the system configured nameservers can not be
1957    retrieved the functionality will resort to using system resolution. Functionalty
1958    such as SRV records and failover will not be available if system resolution
1959    is in use.
1960
1961 ------------------------------------------------------------------------------
1962 --- Functionality changes from Asterisk 11 to Asterisk 12 --------------------
1963 ------------------------------------------------------------------------------
1964
1965 Overview
1966 ------------------
1967
1968 Asterisk 12 is a standard release of the Asterisk project. As such, the
1969 focus of development for this release was on core architectural changes and
1970 major new features. This includes:
1971  * A more flexible bridging core based on the Bridging API
1972  * A new internal message bus, Stasis
1973  * Major standardization and consistency improvements to AMI
1974  * Addition of the Asterisk RESTful Interface (ARI)
1975  * A new SIP channel driver, chan_pjsip
1976 In addition, as the vast majority of bridging in Asterisk was migrated to the
1977 Bridging API used by ConfBridge, major changes were made to most of the
1978 interfaces in Asterisk. This includes not only AMI, but also CDRs and CEL.
1979
1980 Specifications have been written for the affected interfaces. These
1981 specifications are available on the Asterisk wiki:
1982  * AMI - https://wiki.asterisk.org/wiki/x/dAFRAQ
1983  * CEL - https://wiki.asterisk.org/wiki/x/4ICLAQ
1984  * CDRs - https://wiki.asterisk.org/wiki/x/pwpRAQ
1985
1986 It is *highly* recommended that anyone migrating to Asterisk 12 read the
1987 information regarding its release both in this file and in the accompanying
1988 UPGRADE.txt file. More detailed information on the major changes can be found
1989 on the Asterisk wiki at https://wiki.asterisk.org/wiki/x/0YCLAQ.
1990
1991
1992 Build System
1993 ------------------
1994  * Added build option DISABLE_INLINE. This option can be used to work around a
1995    bug in gcc. For more information, see
1996    http://gcc.gnu.org/bugzilla/show_bug.cgi?id=47816
1997
1998  * Removed the CHANNEL_TRACE development mode build option. Certain aspects of
1999    the CHANNEL_TRACE build option were incompatible with the new bridging
2000    architecture.
2001
2002  * Asterisk now optionally uses libxslt to improve XML documentation generation
2003    and maintainability. If libxslt is not available on the system, some XML
2004    documentation will be incomplete.
2005
2006  * Asterisk now depends on libjansson. If a package of libjansson is not
2007    available on your distro, please see http://www.digip.org/jansson/.
2008
2009  * Asterisk now depends on libuuid and, optionally, uriparser. It is
2010    recommended that you install uriparser, even if it is optional.
2011
2012  * The new SIP stack and channel driver uses a particular version of PJSIP.
2013    Please see https://wiki.asterisk.org/wiki/x/J4GLAQ for more information on
2014    configuring and installing PJSIP for usage with Asterisk.
2015
2016  * Optional API was re-implemented to be more portable, and no longer requires
2017    weak reference support from the compiler. The build option OPTIONAL_API may
2018    be disabled to disable Optional API support.
2019
2020 Applications
2021 ------------------
2022
2023 AgentLogin
2024 ------------------
2025  * Along with AgentRequest, this application has been modified to be a
2026    replacement for chan_agent. The act of a channel calling the AgentLogin
2027    application places the channel into a pool of agents that can be
2028    requested by the AgentRequest application. Note that this application, as
2029    well as all other agent related functionality, is now provided by the
2030    app_agent_pool module. See chan_agent and AgentRequest for more information.
2031
2032  * This application no longer performs agent authentication. If authentication
2033    is desired, the dialplan needs to perform this function using the
2034    Authenticate or VMAuthenticate application or through an AGI script before
2035    running AgentLogin.
2036
2037  * If this application is called and the agent is already logged in, the
2038    dialplan will continue exection with the AGENT_STATUS channel variable set
2039    to ALREADY_LOGGED_IN.
2040
2041  * The agents.conf schema has changed. Rather than specifying agents on a
2042    single line in comma delineated fashion, each agent is defined in a separate
2043    context. This allows agents to use the power of context templates in their
2044    definition.
2045
2046  * A number of parameters from agents.conf have been removed. This includes
2047    maxloginretries, autologoffunavail, updatecdr, goodbye, group, recordformat,
2048    urlprefix, and savecallsin. These options were obsoleted by the move from
2049    a channel driver model to the bridging/application model provided by
2050    app_agent_pool.
2051
2052 AgentRequest
2053 ------------------
2054  * A new application, this will request a logged in agent from the pool and
2055    bridge the requested channel with the channel calling this application.
2056    Logged in agents are those channels that called the AgentLogin application.
2057    If an agent cannot be requested from the pool, the AGENT_STATUS dialplan
2058    application will be set with an appropriate error value.
2059
2060 AgentMonitorOutgoing
2061 ------------------
2062  * This application has been removed. It was a holdover from when
2063    AgentCallbackLogin was removed.
2064
2065 AlarmReceiver
2066 ------------------
2067  * Added support for additional Ademco DTMF signalling formats, including
2068    Express 4+1, Express 4+2, High Speed and Super Fast.
2069
2070  * Added channel variable ALARMRECEIVER_CALL_LIMIT. This sets the maximum
2071    call time, in milliseconds, to run the application.
2072
2073  * Added channel variable ALARMRECEIVER_RETRIES_LIMIT. This sets the
2074    maximum number of times to retry the call.
2075
2076  * Added a new configuration option answait. If set, the AlarmReceiver
2077    application will wait the number of milliseconds specified by answait
2078    after the channel has answered. Valid values range between 500
2079    milliseconds and 10000 milliseconds.
2080
2081  * Added configuration option no_group_meta. If enabled, grouping of metadata
2082    information in the AlarmReceiver log file will be skipped.
2083
2084 Answer
2085 ------------------
2086  * It is now no longer possible to bypass updating the CDR on the channel
2087    when answering. CDRs reflect the state of the channel and will always
2088    reflect the time they were Answered.
2089
2090 BridgeWait
2091 ------------------
2092  * A new application in Asterisk, this will place the calling channel
2093    into a holding bridge, optionally entertaining them with some form of
2094    media. Channels participating in a holding bridge do not interact with
2095    other channels in the same holding bridge. Optionally, however, a channel
2096    may join as an announcer. Any media passed from an announcer channel is
2097    played to all channels in the holding bridge. Channels leave a holding
2098    bridge either when an optional timer expires, or via the ChannelRedirect
2099    application or AMI Redirect action.
2100
2101 ConfBridge
2102 ------------------
2103  * All participants in a bridge can now be kicked out of a conference room
2104    by specifying the channel parameter as 'all' in the ConfBridge kick CLI
2105    command, i.e., 'confbridge kick <conference> all'
2106
2107  * CLI output for the 'confbridge list' command has been improved. When
2108    displaying information about a particular bridge, flags will now be shown
2109    for the participating users indicating properties of that user.
2110
2111  * The ConfbridgeList event now contains the following fields: WaitMarked,
2112    EndMarked, and Waiting. This displays additional properties about the
2113    user's profile, as well as whether or not the user is waiting for a
2114    Marked user to enter the conference.
2115
2116  * Added a new option for conference recording, record_file_append. If enabled,
2117    when the recording is stopped and then re-started, the existing recording
2118    will be used and appended to.
2119
2120  * ConfBridge now has the ability to set the language of announcements to the
2121    conference.  The language can be set on a bridge profile in confbridge.conf
2122    or by the dialplan function CONFBRIDGE(bridge,language)=en.
2123
2124 ControlPlayback
2125 ------------------
2126  * The channel variable CPLAYBACKSTATUS may now return the value
2127    'REMOTESTOPPED'. This occurs when playback is stopped by a remote interface,
2128    such as AMI. See the AMI action ControlPlayback for more information.
2129
2130 Directory
2131 ------------------
2132  * Added the 'a' option, which allows the caller to enter in an additional
2133    alias for the user in the directory. This option must be used in conjunction
2134    with the 'f', 'l', or 'b' options. Note that the alias for a user can be
2135    specified in voicemail.conf.
2136
2137 DumpChan
2138 ------------------
2139  * The output of DumpChan no longer includes the DirectBridge or IndirectBridge
2140    fields. Instead, if a channel is in a bridge, it includes a BridgeID field
2141    containing the unique ID of the bridge that the channel happens to be in.
2142
2143 ForkCDR
2144 ------------------
2145  * ForkCDR no longer automatically resets the forked CDR. See the 'r' option
2146    for more information.
2147
2148  * Variables are no longer purged from the original CDR. See the 'v' option for
2149    more information.
2150
2151  * The 'A' option has been removed. The Answer time on a CDR is never updated
2152    once set.
2153
2154  * The 'd' option has been removed. The disposition on a CDR is a function of
2155    the state of the channel and cannot be altered.
2156
2157  * The 'D' option has been removed. Who the Party B is on a CDR is a function
2158    of the state of the respective channels involved in the CDR and cannot be
2159    altered.
2160
2161  * The 'r' option has been changed. Previously, ForkCDR always reset the CDR
2162    such that the start time and, if applicable, the answer time was updated.
2163    Now, by default, ForkCDR simply forks the CDR, maintaining any times. The
2164    'r' option now triggers the Reset, setting the start time (and answer time
2165    if applicable) to the current time. Note that the 'a' option still sets
2166    the answer time to the current time if the channel was already answered.
2167
2168  * The 's' option has been removed. A variable can be set on the original CDR
2169    if desired using the CDR function, and removed from a forked CDR using the
2170    same function.
2171
2172  * The 'T' option has been removed. The concept of DONT_TOUCH and LOCKED no
2173    longer applies in the CDR engine.
2174
2175  * The 'v' option now prevents the copy of the variables from the original CDR
2176    to the forked CDR. Previously the variables were always copied but were
2177    removed from the original. This was changed as removing variables from a CDR
2178    can have unintended side effects - this option allows the user to prevent
2179    propagation of variables from the original to the forked without modifying
2180    the original.
2181
2182 MeetMe
2183 -------------------
2184  * Added the 'n' option to MeetMe to prevent application of the DENOISE
2185    function to a channel joining a conference. Some channel drivers that vary
2186    the number of audio samples in a voice frame will experience significant
2187    quality problems if a denoiser is attached to the channel; this option gives
2188    them the ability to remove the denoiser without having to unload func_speex.
2189
2190 MixMonitor
2191 ------------------
2192  * The 'b' option now includes conferences as well as sounds played to the
2193    participants.
2194
2195  * The AUDIOHOOK_INHERIT function is no longer needed to keep a MixMonitor
2196    running during a transfer. If a MixMonitor is started on a channel,
2197    the MixMonitor will continue to record the audio passing through the
2198    channel even in the presence of transfers.
2199
2200 NoCDR
2201 ------------------
2202  * The NoCDR application is deprecated. Please use the CDR_PROP function to
2203    disable CDRs.
2204
2205  * While the NoCDR application will prevent CDRs for a channel from being
2206    propagated to registered CDR backends, it will not prevent that data from
2207    being collected. Hence, a subsequent call to ResetCDR or the CDR_PROP
2208    function that enables CDRs on a channel will restore those records that have
2209    not yet been finalized.
2210
2211 ParkAndAnnounce
2212 -------------------
2213  * The app_parkandannounce module has been removed. The application
2214    ParkAndAnnounce is now provided by the res_parking module. See the
2215    res_parking changes for more information.
2216
2217 Queue
2218 -------------------
2219  * Added queue available hint. The hint can be added to the dialplan using the
2220    following syntax: exten,hint,Queue:{queue_name}_avail
2221    For example, if the name of the queue is 'markq':
2222         exten => 8501,hint,Queue:markq_avail
2223    This will report 'InUse' if there are no logged in agents or no free agents.
2224    It will report 'Idle' when an agent is free.
2225
2226  * Queues now support a hint for member paused state. The hint uses the form
2227    'Queue:{queue_name}_pause_{member_name}', where {queue_name} and {member_name}
2228    are the name of the queue and the name of the member to subscribe to,
2229    respectively. For example: exten => 8501,hint,Queue:sales_pause_mark.
2230    Members will show as In Use when paused.
2231
2232  * The configuration options eventwhencalled and eventmemberstatus have been
2233    removed.  As a result, the AMI events QueueMemberStatus, AgentCalled,
2234    AgentConnect, AgentComplete, AgentDump, and AgentRingNoAnswer will always be
2235    sent.  The "Variable" fields will also no longer exist on the Agent* events.
2236    These events can be filtered out from a connected AMI client using the
2237    eventfilter setting in manager.conf.
2238
2239  * The queue log now differentiates between blind and attended transfers. A
2240    blind transfer will result in a BLINDTRANSFER message with the destination
2241    context and extension. An attended transfer will result in an
2242    ATTENDEDTRANSFER message. This message will indicate the method by which
2243    the attended transfer was completed: "BRIDGE" for a bridge merge, "APP"
2244    for running an application on a bridge or channel, or "LINK" for linking
2245    two bridges together with local channels. The queue log will also now detect
2246    externally initiated blind and attended transfers and record the transfer
2247    status accordingly.
2248
2249  * When performing queue pause/unpause on an interface without specifying an
2250    individual queue, the PAUSEALL/UNPAUSEALL event will only be logged if at
2251    least one member of any queue exists for that interface.
2252
2253  * Added the 'queue_log_realtime_use_gmt' option to have timestamps in GMT
2254    for realtime queue log entries.
2255
2256 ResetCDR
2257 ------------------
2258  * The 'e' option has been deprecated. Use the CDR_PROP function to re-enable
2259    CDRs when they were previously disabled on a channel.
2260
2261  * The 'w' and 'a' options have been removed. Dispatching CDRs to registered
2262    backends occurs on an as-needed basis in order to preserve linkedid
2263    propagation and other needed behavior.
2264
2265 SayAlphaCase
2266 ------------------
2267  * A new application, this is similar to SayAlpha except that it supports
2268    case sensitive playback of the specified characters. For example,
2269    SayAlphaCase(u,aBc) will result in 'a uppercase b c'.
2270
2271 SetAMAFlags
2272 ------------------
2273  * This application is deprecated in favor of CHANNEL(amaflags).
2274
2275 SendDTMF
2276 ------------------
2277  * The SendDTMF application will now accept 'W' as valid input. This will cause
2278    the application to delay one second while streaming DTMF.
2279
2280 Stasis
2281 ------------------
2282  * A new application in Asterisk 12, this hands control of the channel calling
2283    the application over to an external system. Currently, external systems
2284    manipulate channels in Stasis through the Asterisk RESTful Interface (ARI).
2285
2286 UserEvent
2287 ------------------
2288  * UserEvent will now handle duplicate keys by overwriting the previous value
2289    assigned to the key.
2290
2291  * In addition to AMI, UserEvent invocations will now be distributed to any
2292    interested Stasis applications.
2293
2294 VoiceMail
2295 ------------------
2296  * Mailboxes defined by app_voicemail MUST be referenced by the rest of the
2297    system as mailbox@context.  The rest of the system cannot add @default
2298    to mailbox identifiers for app_voicemail that do not specify a context
2299    any longer.  It is a mailbox identifier format that should only be
2300    interpreted by app_voicemail.
2301
2302  * The voicemail.conf configuration file now has an 'alias' configuration
2303    parameter for use with the Directory application. The voicemail realtime
2304    database table schema has also been updated with an 'alias' column.
2305
2306
2307 Codecs
2308 ------------------
2309  * Pass through support has been added for both VP8 and Opus.
2310
2311  * Added format attribute negotiation for the Opus codec. Format attribute
2312    negotiation is provided by the res_format_attr_opus module.
2313
2314
2315 Core
2316 ------------------
2317  * Masquerades as an operation inside Asterisk have been effectively hidden
2318    by the migration to the Bridging API. As such, many 'quirks' of Asterisk
2319    no longer occur. This includes renaming of channels, "<ZOMBIE>" channels,
2320    dropping of frame/audio hooks, and other internal implementation details
2321    that users had to deal with. This fundamental change has large implications
2322    throughout the changes documented for this version. For more information
2323    about the new core architecture of Asterisk, please see the Asterisk wiki.
2324
2325  * Multiple parties in a bridge may now be transferred. If a participant in a
2326    multi-party bridge initiates a blind transfer, a Local channel will be used
2327    to execute the dialplan location that the transferer sent the parties to. If
2328    a participant in a multi-party bridge initiates an attended transfer,
2329    several options are possible. If the attended transfer results in a transfer
2330    to an application, a Local channel is used. If the attended transfer results
2331    in a transfer to another channel, the resulting channels will be merged into
2332    a single bridge.
2333
2334  * The channel variable ATTENDED_TRANSFER_COMPLETE_SOUND is no longer channel
2335    driver specific.  If the channel variable is set on the transferrer channel,
2336    the sound will be played to the target of an attended transfer.
2337
2338  * The channel variable BRIDGEPEER becomes a comma separated list of peers in
2339    a multi-party bridge.  The BRIDGEPEER value can have a maximum of 10 peers
2340    listed.  Any more peers in the bridge will not be included in the list.
2341    BRIDGEPEER is not valid in holding bridges like parking since those channels
2342    do not talk to each other even though they are in a bridge.
2343
2344  * The channel variable BRIDGEPVTCALLID is only valid for two party bridges
2345    and will contain a value if the BRIDGEPEER's channel driver supports it.
2346
2347  * A channel variable ATTENDEDTRANSFER is now set which indicates which channel
2348    was responsible for an attended transfer in a similar fashion to
2349    BLINDTRANSFER.
2350
2351  * Modules using the Configuration Framework or Sorcery must have XML
2352    configuration documentation. This configuration documentation is included
2353    with the rest of Asterisk's XML documentation, and is accessible via CLI
2354    commands. See the CLI changes for more information.
2355
2356 AMI (Asterisk Manager Interface)
2357 ------------------
2358  * Major changes were made to both the syntax as well as the semantics of the
2359    AMI protocol. In particular, AMI events have been substantially improved
2360    in this version of Asterisk. For more information, please see the AMI
2361    specification at https://wiki.asterisk.org/wiki/x/dAFRAQ
2362
2363  * AMI events that reference a particular channel or bridge will now always
2364    contain a standard set of fields. When multiple channels or bridges are
2365    referenced in an event, fields for at least some subset of the channels
2366    and bridges in the event will be prefixed with a descriptive name to avoid
2367    name collisions. See the AMI event documentation on the Asterisk wiki for
2368    more information.
2369
2370  * The CLI command 'manager show commands' no longer truncates command names
2371    longer than 15 characters and no longer shows authorization requirement
2372    for commands. 'manager show command' now displays the privileges needed
2373    for using a given manager command instead.
2374
2375  * The SIPshowpeer action will now include a 'SubscribeContext' field for a
2376    peer in its response if the peer has a subscribe context set.
2377
2378  * The SIPqualifypeer action now acknowledges the request once it has
2379    established that the request is against a known peer. It also issues a new
2380    event, 'SIPQualifyPeerDone', once the qualify action has been completed.
2381
2382  * The PlayDTMF action now supports an optional 'Duration' parameter.  This
2383    specifies the duration of the digit to be played, in milliseconds.
2384
2385  * Added VoicemailRefresh action to allow an external entity to trigger mailbox
2386    updates when changes occur instead of requiring the use of pollmailboxes.
2387
2388  * Added a new action 'ControlPlayback'. The ControlPlayback action allows an
2389    AMI client to manipulate audio currently being played back on a channel. The
2390    supported operations depend on the application being used to send audio to
2391    the channel. When the audio playback was initiated using the ControlPlayback
2392    application or CONTROL STREAM FILE AGI command, the audio can be paused,
2393    stopped, restarted, reversed, or skipped forward. When initiated by other
2394    mechanisms (such as the Playback application), the audio can be stopped,
2395    reversed, or skipped forward.
2396
2397  * Channel related events now contain a snapshot of channel state, adding new
2398    fields to many of these events.
2399
2400  * The AMI event 'Newexten' field 'Extension' is deprecated, and may be removed
2401    in a future release. Please use the common 'Exten' field instead.
2402
2403  * The AMI event 'UserEvent' from app_userevent now contains the channel state
2404    fields. The channel state fields will come before the body fields.
2405
2406  * The AMI events 'ParkedCall', 'ParkedCallTimeOut', 'ParkedCallGiveUp', and
2407    'UnParkedCall' have changed significantly in the new res_parking module.
2408
2409    The 'Channel' and 'From' headers are gone. For the channel that was parked
2410    or is coming out of parking, a 'Parkee' channel snapshot is issued and it
2411    has a number of fields associated with it. The old 'Channel' header relayed
2412    the same data as the new 'ParkeeChannel' header.
2413
2414    The 'From' field was ambiguous and changed meaning depending on the event.
2415    for most of these, it was the name of the channel that parked the call
2416    (the 'Parker'). There is no longer a header that provides this channel name,
2417    however the 'ParkerDialString' will contain a dialstring to redial the
2418    device that parked the call.
2419
2420    On UnParkedCall events, the 'From' header would instead represent the
2421    channel responsible for retrieving the parkee. It receives a channel
2422    snapshot labeled 'Retriever'. The 'from' field is is replaced with
2423    'RetrieverChannel'.
2424
2425    Lastly, the 'Exten' field has been replaced with 'ParkingSpace'.
2426
2427  * The AMI event 'Parkinglot' (response to 'Parkinglots' command) in a similar
2428    fashion has changed the field names 'StartExten' and 'StopExten' to
2429    'StartSpace' and 'StopSpace' respectively.
2430
2431  * The deprecated use of | (pipe) as a separator in the channelvars setting in
2432    manager.conf has been removed.
2433
2434  * Channel Variables conveyed with a channel no longer contain the name of the
2435    channel as part of the key field, i.e., ChanVariable(SIP/foo): bar=baz is now
2436    ChanVariable: bar=baz. When multiple channels are present in a single AMI
2437    event, the various ChanVariable fields will contain a suffix that specifies
2438    which channel they correspond to.
2439
2440  * The NewPeerAccount AMI event is no longer raised. The NewAccountCode AMI
2441    event always conveys the AMI event for a particular channel.
2442
2443  * All 'Reload' events have been consolidated into a single event type. This
2444    event will always contain a Module field specifying the name of the module
2445    and a Status field denoting the result of the reload. All modules now issue
2446    this event when being reloaded.
2447
2448  * The 'ModuleLoadReport' event has been removed. Most AMI connections would
2449    fail to receive this event due to being connected after modules have loaded.
2450    AMI connections that want to know when Asterisk is ready should listen for
2451    the 'FullyBooted' event.
2452
2453  * app_fax now sends the same send fax/receive fax events as res_fax. The
2454    'FaxSent' event is now the 'SendFAX' event, and the 'FaxReceived' event is
2455    now the 'ReceiveFAX' event.
2456
2457  * The 'MusicOnHold' event is now two events: 'MusicOnHoldStart' and
2458    'MusicOnHoldStop'. The sub type field has been removed.
2459
2460  * The 'JabberEvent' event has been removed. It is not AMI's purpose to be a
2461    carrier for another protocol.
2462
2463  * The Bridge Manager action's 'Playtone' header now accepts more fine-grained
2464    options. 'Channel1' and 'Channel2' may be specified in order to play a tone
2465    to the specific channel. 'Both' may be specified to play a tone to both
2466    channels. The old 'yes' option is still accepted as a way of playing the
2467    tone to Channel2 only.
2468
2469  * The AMI 'Status' response event to the AMI Status action replaces the
2470    'BridgedChannel' and 'BridgedUniqueid' headers with the 'BridgeID' header to
2471    indicate what bridge the channel is currently in.
2472
2473  * The AMI 'Hold' event has been moved out of individual channel drivers, into
2474    core, and is now two events: 'Hold' and 'Unhold'.  The status field has been
2475    removed.
2476
2477  * The AMI events in app_queue have been made more consistent with each other.
2478    Events that reference channels (QueueCaller* and Agent*) will show
2479    information about each channel.  The (infamous) 'Join' and 'Leave' AMI
2480    events have been changed to 'QueueCallerJoin' and 'QueueCallerLeave'.
2481
2482  * The 'MCID' AMI event now publishes a channel snapshot when available and
2483    its non-channel-snapshot parameters now use either the "MCallerID" or
2484    'MConnectedID' prefixes with Subaddr*, Name*, and Num* suffixes instead
2485    of 'CallerID' and 'ConnectedID' to avoid confusion with similarly named
2486    parameters in the channel snapshot.
2487
2488  * The AMI events 'Agentlogin' and 'Agentlogoff' have been renamed
2489    'AgentLogin' and 'AgentLogoff' respectively.
2490
2491  * The 'Channel' key used in the 'AlarmClear', 'Alarm', and 'DNDState' has been
2492    renamed "DAHDIChannel" since it does not convey an Asterisk channel name.
2493
2494  * 'ChannelUpdate' events have been removed.
2495
2496  * All AMI events now contain a 'SystemName' field, if available.
2497
2498  * Local channel optimization is now conveyed in two events:
2499    'LocalOptimizationBegin' and 'LocalOptimizationEnd'. The Begin event is sent
2500    when the Local channel driver begins attempting to optimize itself out of
2501    the media path; the End event is sent after the channel halves have
2502    successfully optimized themselves out of the media path.
2503
2504  * Local channel information in events is now prefixed with 'LocalOne' and
2505    'LocalTwo'. This replaces the suffix of '1' and '2' for the two halves of
2506    the Local channel. This affects the 'LocalBridge', 'LocalOptimizationBegin',
2507    and 'LocalOptimizationEnd' events.
2508
2509  * The option 'allowmultiplelogin' can now be set or overriden in a particular
2510    account. When set in the general context, it will act as the default
2511    setting for defined accounts.
2512
2513  * The 'BridgeAction' event was removed. It technically added no value, as the
2514    Bridge Action already receives confirmation of the bridge through a
2515    successful completion Event.
2516
2517  * The 'BridgeExec' events were removed. These events duplicated the events that
2518    occur in the Briding API, and are conveyed now through BridgeCreate,
2519    BridgeEnter, and BridgeLeave events.
2520
2521  * The 'RTCPSent'/'RTCPReceived' events have been significantly modified from
2522    previous versions. They now report all SR/RR packets sent/received, and
2523    have been restructured to better reflect the data sent in a SR/RR. In
2524    particular, the event structure now supports multiple report blocks.
2525
2526  * Added 'BlindTransfer' and 'AttendedTransfer' events. These events are
2527    raised when a blind transfer/attended transfer completes successfully.
2528    They contain information about the transfer that just completed, including
2529    the location of the transfered channel.
2530
2531  * Added a 'security' class to AMI which outputs the required fields for
2532    security messages similar to the log messages from res_security_log
2533
2534  * The AMI event 'ExtensionStatus' now contains a 'StatusText' field
2535    that describes the status value in a human readable string.
2536
2537 CDR (Call Detail Records)
2538 ------------------
2539  * Significant changes have been made to the behavior of CDRs. The CDR engine
2540    was effectively rewritten and built on the Stasis message bus. For a full
2541    definition of CDR behavior in Asterisk 12, please read the specification
2542    on the Asterisk wiki (wiki.asterisk.org).
2543
2544  * CDRs will now be created between all participants in a bridge. For each
2545    pair of channels in a bridge, a CDR is created to represent the path of
2546    communication between those two endpoints. This lets an end user choose who
2547    to bill for what during bridge operations with multiple parties.
2548
2549  * The duration, billsec, start, answer, and end times now reflect the times
2550    associated with the current CDR for the channel, as opposed to a cumulative
2551    measurement of all CDRs for that channel.
2552
2553  * When a CDR is dispatched, user defined CDR variables from both parties are
2554    included in the resulting CDR. If both parties have the same variable, only
2555    the Party A value is provided.
2556
2557  * Added a new option to cdr.conf, 'debug'. When enabled, significantly more
2558    information regarding the CDR engine is logged as verbose messages. This
2559    option should only be used if the behavior of the CDR engine needs to be
2560    debugged.
2561
2562  * Added CLI command 'cdr set debug {on|off}'. This toggles the 'debug' setting
2563    normally configured in cdr.conf.
2564
2565  * Added CLI command 'cdr show active {channel}'. When {channel} is not
2566    specified, this command provides a summary of the channels with CDR
2567    information and their statistics. When {channel} is specified, it shows
2568    detailed information about all records associated with {channel}.
2569
2570 CEL (Channel Event Logging)
2571 ------------------
2572  * CEL has undergone significant rework in Asterisk 12, and is now built on the
2573    Stasis message bus. Please see the specification for CEL on the Asterisk
2574    wiki at https://wiki.asterisk.org/wiki/x/4ICLAQ for more detailed
2575    information.
2576
2577  * The 'extra' field of all CEL events that use it now consists of a JSON blob
2578    with key/value pairs which are defined in the Asterisk 12 CEL documentation.
2579
2580  * BLINDTRANSFER events now report the transferee bridge unique
2581    identifier, extension, and context in a JSON blob as the extra string
2582    instead of the transferee channel name as the peer.
2583
2584  * ATTENDEDTRANSFER events now report the peer as NULL and additional
2585    information in the 'extra' string as a JSON blob. For transfers that occur
2586    between two bridged channels, the 'extra' JSON blob contains the primary
2587    bridge unique identifier, the secondary channel name, and the secondary
2588    bridge unique identifier. For transfers that occur between a bridged channel
2589    and a channel running an app, the 'extra' JSON blob contains the primary
2590    bridge unique identifier, the secondary channel name, and the app name.
2591
2592  * LOCAL_OPTIMIZE events have been added to convey local channel
2593    optimizations with the record occurring for the semi-one channel and
2594    the semi-two channel name in the peer field.
2595
2596  * BRIDGE_START, BRIDGE_END, BRIDGE_UPDATE, 3WAY_START, 3WAY_END, CONF_ENTER,
2597    CONF_EXIT, CONF_START, and CONF_END events have all been removed. These
2598    events have been replaced by BRIDGE_ENTER/BRIDGE_EXIT. The BRIDGE_ENTER
2599    and BRIDGE_EXIT events are raised when a channel enters/exits any bridge,
2600    regardless of whether or not that bridge happens to contain multiple
2601    parties.
2602
2603 CLI
2604 -------------------
2605  * When compiled with '--enable-dev-mode', the astobj2 library will now add
2606    several CLI commands that allow for inspection of ao2 containers that
2607    register themselves with astobj2. The CLI commands are 'astobj2 container
2608    dump', 'astobj2 container stats', and 'astobj2 container check'.
2609
2610  * Added specific CLI commands for bridge inspection. This includes 'bridge
2611    show all', which lists all bridges in the system, and 'bridge show {id}',
2612    which provides specific information about a bridge.
2613
2614  * Added CLI command 'bridge destroy'. This will destroy the specified bridge,
2615    ejecting the channels currently in the bridge. If the channels cannot
2616    continue in the dialplan or application that put them in the bridge, they
2617    will be hung up.
2618
2619  * Added command 'bridge kick'. This will eject a single channel from a bridge.
2620
2621  * Added commands to inspect and manipulate the registered bridge technologies.
2622    This include 'bridge technology show', which lists the registered bridge
2623    technologies, as well as 'bridge technology {suspend|unsuspend} {tech}',
2624    which controls whether or not a registered bridge technology can be used
2625    during smart bridge operations. If a technology is suspended, it will not
2626    be used when a bridge technology is picked for channels; when unsuspended,
2627    it can be used again.
2628
2629  * The command 'config show help {module} {type} {option}' will show
2630    configuration documentation for modules with XML configuration
2631    documentation. When {module}, {type}, and {option} are omitted, a listing
2632    of all modules with registered documentation is displayed. When {module}
2633    is specified, a listing of all configuration types for that module is
2634    displayed, along with their synopsis. When {module} and {type} are
2635    specified, a listing of all configuration options for that type are
2636    displayed along with their synopsis. When {module}, {type}, and {option}
2637    are specified, detailed information for that configuration option is
2638    displayed.
2639
2640  * Added 'core show sounds' and 'core show sound' CLI commands. These display
2641    a listing of all installed media sounds available on the system and
2642    detailed information about a sound, respectively.
2643
2644  * 'xmldoc dump' has been added. This CLI command will dump the XML
2645    documentation DOM as a string to the specified file. The Asterisk core
2646    will populate certain XML elements pulled from the source files with
2647    additional run-time information; this command lets a user produce the
2648    XML documentation with all information.
2649
2650 Features
2651 -------------------
2652  * Parking has been pulled from core and placed into a separate module called
2653    res_parking. See Parking changes below for more details. Configuration for
2654    parking should now be performed in res_parking.conf. Configuration for
2655    parking in features.conf is now unsupported.
2656
2657  * Core attended transfers now have several new options. While performing an
2658    attended transfer, the transferer now has the following options:
2659    - *1 - cancel the attended transfer (configurable via atxferabort)
2660    - *2 - complete the attended transfer, dropping out of the call
2661           (configurable via atxfercomplete)
2662    - *3 - complete the attended transfer, but stay in the call. This will turn
2663           the call into a multi-party bridge (configurable via atxferthreeway)
2664    - *4 - swap to the other party. Once an attended transfer has begun, this
2665           options may be used multiple times (configurable via atxferswap)
2666
2667  * For DTMF blind and attended transfers, the channel variable TRANSFER_CONTEXT
2668    must be on the channel initiating the transfer to have any effect.
2669
2670  * The BRIDGE_FEATURES channel variable would previously only set features for
2671    the calling party and would set this feature regardless of whether the
2672    feature was in caps or in lowercase. Use of a caps feature for a letter
2673    will now apply the feature to the calling party while use of a lowercase
2674    letter will apply that feature to the called party.
2675
2676  * Add support for automixmon to the BRIDGE_FEATURES channel variable.
2677
2678  * The channel variable DYNAMIC_PEERNAME is redundant with BRIDGEPEER and is
2679    removed.  The more useful DYNAMIC_WHO_ACTIVATED gives the channel name that
2680    activated the dynamic feature.
2681
2682  * The channel variables DYNAMIC_FEATURENAME and DYNAMIC_WHO_ACTIVATED are set
2683    only on the channel executing the dynamic feature.  Executing a dynamic
2684    feature on the bridge peer in a multi-party bridge will execute it on all
2685    peers of the activating channel.
2686
2687  * You can now have the settings for a channel updated using the FEATURE()
2688    and FEATUREMAP() functions inherited to child channels by setting
2689    FEATURE(inherit)=yes.
2690
2691  * automixmon now supports additional channel variables from automon including:
2692    TOUCH_MIXMONITOR_PREFIX, TOUCH_MIXMONITOR_MESSAGE_START,
2693    and TOUCH_MIXMONITOR_MESSAGE_STOP
2694
2695  * A new general features.conf option 'recordingfailsound' has been added which
2696    allowssetting a failure sound for a user tries to invoke a recording feature
2697    such as automon or automixmon and it fails.
2698
2699  * It is no longer necessary (or possible) to define the ATXFER_NULL_TECH in
2700    features.c for atxferdropcall=no to work properly. This option now just
2701    works.
2702
2703 Logging
2704 -------------------
2705  * Added log rotation strategy 'none'. If set, no log rotation strategy will
2706    be used. Given that this can cause the Asterisk log files to grow quickly,
2707    this option should only be used if an external mechanism for log management
2708    is preferred.
2709
2710 Realtime
2711 ------------------
2712  * Dynamic realtime tables for SIP Users can now include a 'path' field. This
2713    will store the path information for that peer when it registers. Realtime
2714    tables can also use the 'supportpath' field to enable Path header support.
2715
2716  * LDAP realtime configurations for SIP Users now have the AstAccountPathSupport
2717    objectIdentifier. This maps to the supportpath option in sip.conf.
2718
2719 Sorcery
2720 ------------------
2721  * Sorcery is a new data abstraction and object persistence API in Asterisk. It
2722    provides modules a useful abstraction on top of the many storage mechanisms
2723    in Asterisk, including the Asterisk Database, static configuration files,
2724    static Realtime, and dynamic Realtime. It also provides a caching service.
2725    Users can configure a hierarchy of data storage layers for specific modules
2726    in sorcery.conf.
2727
2728  * All future modules which utilize Sorcery for object persistence must have a
2729    column named "id" within their schema when using the Sorcery realtime module.
2730    This column must be able to contain a string of up to 128 characters in length.
2731
2732 Security Events Framework
2733 ------------------
2734  * Security Event timestamps now use ISO 8601 formatted date/time instead of
2735    the "seconds-microseconds" format that it was using previously.
2736
2737 Stasis Message Bus
2738 ------------------
2739  * The Stasis message bus is a publish/subscribe message bus internal to
2740    Asterisk. Many services in Asterisk are built on the Stasis message bus,
2741    including AMI, ARI, CDRs, and CEL. Parameters controlling the operation of
2742    Stasis can be configured in stasis.conf. Note that these parameters operate
2743    at a very low level in Asterisk, and generally will not require changes.
2744
2745 Channel Drivers
2746 ------------------
2747  * When a channel driver is configured to enable jiterbuffers, they are now
2748    applied unconditionally when a channel joins a bridge. If a jitterbuffer
2749    is already set for that channel when it enters, such as by the JITTERBUFFER
2750    function, then the existing jitterbuffer will be used and the one set by
2751    the channel driver will not be applied.
2752
2753 chan_agent
2754 ------------------
2755  * chan_agent has been removed and replaced with AgentLogin and AgentRequest
2756    dialplan applications provided by the app_agent_pool module. Agents are
2757    connected with callers using the new AgentRequest dialplan application.
2758    The Agents:<agent-id> device state is available to monitor the status of an
2759    agent. See agents.conf.sample for valid configuration options.
2760
2761  * The updatecdr option has been removed. Altering the names of channels on a
2762    CDR is not supported - the name of the channel is the name of the channel,
2763    and pretending otherwise helps no one. The AGENTUPDATECDR channel variable
2764    has also been removed, for the same reason.
2765
2766  * The endcall and enddtmf configuration options are removed.  Use the
2767    dialplan function CHANNEL(dtmf-features) to set DTMF features on the agent
2768    channel before calling AgentLogin.
2769
2770 chan_bridge
2771 ------------------
2772  * chan_bridge has been removed. Its functionality has been incorporated
2773    directly into the ConfBridge application itself.
2774
2775 chan_dahdi
2776 ------------------
2777  * Added the CLI command 'pri destroy span'. This will destroy the D-channel
2778    of the specified span and its B-channels. Note that this command should
2779    only be used if you understand the risks it entails.
2780
2781  * The CLI command 'dahdi destroy channel' is now 'dahdi destroy channels'.
2782    A range of channels can be specified to be destroyed. Note that this command
2783    should only be used if you understand the risks it entails.
2784
2785  * Added the CLI command 'dahdi create channels'. A range of channels can be
2786    specified to be created, or the keyword 'new' can be used to add channels
2787    not yet created.
2788
2789  * The script specified by the chan_dahdi.conf mwimonitornotify option now gets
2790    the exact configured mailbox name.  For app_voicemail mailboxes this is
2791    mailbox@context.
2792
2793  * Added mwi_vm_boxes that also must be configured for ISDN MWI to be enabled.
2794
2795 chan_iax2
2796 ------------------
2797  * IPv6 support has been added.  We are now able to bind to and
2798    communicate using IPv6 addresses.
2799
2800 chan_local
2801 ------------------
2802  * The /b option has been removed.
2803
2804  * chan_local moved into the system core and is no longer a loadable module.
2805
2806 chan_mobile
2807 ------------------
2808  * Added general support for busy detection.
2809
2810  * Added ECAM command support for Sony Ericsson phones.
2811
2812 chan_pjsip
2813 ------------------
2814  * A new SIP channel driver for Asterisk, chan_pjsip is built on the PJSIP
2815    SIP stack. A collection of resource modules provides the bulk of the SIP
2816    functionality. For more information on the new SIP channel driver, see
2817    https://wiki.asterisk.org/wiki/x/JYGLAQ
2818
2819 chan_sip
2820 ------------------
2821  * Added support for RFC 3327 "Path" headers. This can be enabled in sip.conf
2822    using the 'supportpath' setting, either on a global basis or on a peer basis.
2823    This setting enables Asterisk to route outgoing out-of-dialog requests via a
2824    set of proxies by using a pre-loaded route-set defined by the Path headers in
2825    the REGISTER request. See Realtime updates for more configuration information.
2826
2827  * The SIP_CODEC family of variables may now specify more than one codec. Each
2828    codec must be separated by a comma. The first codec specified is the
2829    preferred codec for the offer. This allows a dialplan writer to specify both
2830    audio and video codecs, e.g., Set(SIP_CODEC=ulaw,h264)
2831
2832  * The 'callevents' parameter has been removed. Hold AMI events are now raised
2833    in the core, and can be filtered out using the 'eventfilter' parameter
2834    in manager.conf.
2835
2836  * Added 'ignore_requested_pref'. When enabled, this will use the preferred
2837    codecs configured for a peer instead of the requested codec.
2838
2839  * The option "register_retry_403" has been added to chan_sip to work around
2840    servers that are known to erroneously send 403 in response to valid
2841    REGISTER requests and allows Asterisk to continue attepmting to connect.
2842
2843 chan_skinny
2844 ------------------
2845  * Added the 'immeddialkey' parameter. If set, when the user presses the
2846    configured key the already entered number will be immediately dialed. This
2847    is useful when the dialplan allows for variable length pattern matching.
2848    Valid options are '*' and '#'.
2849
2850  * Added the 'callfwdtimeout' parameter. This configures the amount of time (in
2851    milliseconds) before a call forward is considered to not be answered.
2852
2853  * The 'serviceurl' parameter allows Service URLs to be attached to line
2854    buttons.
2855
2856
2857 Functions
2858 ------------------
2859
2860 AGENT
2861 ------------------
2862  * The password option has been disabled, as the AgentLogin application no
2863    longer provides authentication.
2864
2865 AUDIOHOOK_INHERIT
2866 ------------------
2867  * Due to changes in the Asterisk core, this function is no longer needed to
2868    preserve a MixMonitor on a channel during transfer operations and dialplan
2869    execution. It is effectively obsolete.
2870
2871 CDR (function)
2872 ------------------
2873  * The 'amaflags' and 'accountcode' attributes for the CDR function are
2874    deprecated. Use the CHANNEL function instead to access these attributes.
2875
2876  * The 'l' option has been removed. When reading a CDR attribute, the most
2877    recent record is always used. When writing a CDR attribute, all non-finalized
2878    CDRs are updated.
2879
2880  * The 'r' option has been removed, for the same reason as the 'l' option.
2881
2882  * The 's' option has been removed, as LOCKED semantics no longer exist in the
2883    CDR engine.
2884
2885 CDR_PROP
2886 ------------------
2887  * A new function CDR_PROP has been added. This function lets you set properties
2888    on a channel's active CDRs. This function is write-only. Properties accept
2889    boolean values to set/clear them on the channel's CDRs. Valid properties
2890    include:
2891    - 'party_a' - make this channel the preferred Party A in any CDR between two
2892      channels. If two channels have this property set, the creation time of the
2893      channel is used to determine who is Party A. Note that dialed channels are
2894      never Party A in a CDR.
2895    - 'disable' - disable CDRs on this channel. This is analogous to the NoCDR
2896      application when set to True, and analogous to the 'e' option in ResetCDR
2897      when set to False.
2898
2899 CHANNEL
2900 ------------------
2901  * Added the argument 'dtmf_features'. This sets the DTMF features that will be
2902    enabled on a channel when it enters a bridge. Allowed values are 'T', 'K',
2903    'H', 'W', and 'X', and are analogous to the parameters passed to the Dial
2904    application.
2905
2906  * Added the argument 'after_bridge_goto'. This can be set to a parseable Goto
2907    string, i.e., [[context],extension],priority. If set on a channel, if a
2908    channel leaves a bridge but is not hung up it will resume dialplan execution
2909    at that location.
2910
2911 JITTERBUFFER
2912 ------------------
2913  * JITTERBUFFER now accepts an argument of 'disabled' which can be used
2914    to remove jitterbuffers previously set on a channel with JITTERBUFFER.
2915    The value of this setting is ignored when disabled is used for the argument.
2916
2917 PJSIP_DIAL_CONTACTS
2918 ------------------
2919  * A new function provided by chan_pjsip, this function can be used in
2920    conjunction with the Dial application to construct a dial string that will
2921    dial all contacts on an Address of Record associated with a chan_pjsip
2922    endpoint.
2923
2924 PJSIP_MEDIA_OFFER
2925 ------------------
2926  * Provided by chan_pjsip, this function sets the codecs to be offerred on the
2927    outbound channel prior to dialing.
2928
2929 REDIRECTING
2930 ------------------
2931  * Redirecting reasons can now be set to arbitrary strings. This means
2932    that the REDIRECTING dialplan function can be used to set the redirecting
2933    reason to any string. It also allows for custom strings to be read as the
2934    redirecting reason from SIP Diversion headers.
2935
2936 SPEECH_ENGINE
2937 ------------------
2938  * The SPEECH_ENGINE function now supports read operations. When read from, it
2939    will return the current value of the requested attribute.
2940
2941 VMCOUNT:
2942 ------------------
2943  * Mailboxes defined by app_voicemail MUST be referenced by the rest of the
2944    system as mailbox@context.  The rest of the system cannot add @default
2945    to mailbox identifiers for app_voicemail that do not specify a context
2946    any longer.  It is a mailbox identifier format that should only be
2947    interpreted by app_voicemail.
2948
2949
2950 Resources
2951 ------------------
2952
2953 res_agi (Asterisk Gateway Interface)
2954 ------------------
2955  * The manager event AGIExec has been split into AGIExecStart and AGIExecEnd.
2956
2957  * The manager event AsyncAGI has been split into AsyncAGIStart, AsyncAGIExec,
2958    and AsyncAGIEnd.
2959
2960  * The CONTROL STREAM FILE command now accepts an offsetms parameter. This
2961    will start the playback of the audio at the position specified. It will
2962    also return the final position of the file in 'endpos'.
2963
2964  * The CONTROL STREAM FILE command will now populate the CPLAYBACKSTATUS
2965    channel variable if the user stopped the file playback or if a remote
2966    entity stopped the playback. If neither stopped the playback, it will
2967    indicate the overall success/failure of the playback. If stopped early,
2968    the final offset of the file will be set in the CPLAYBACKOFFSET channel
2969    variable.
2970
2971  * The SAY ALPHA command now accepts an additional parameter to control
2972    whether it specifies the case of uppercase, lowercase, or all letters to
2973    provide functionality similar to SayAlphaCase.
2974
2975 res_ari (Asterisk RESTful Interface) (and others)
2976 ------------------
2977  * The Asterisk RESTful Interface (ARI) provides a mechanism to expose and
2978    control telephony primitives in Asterisk by remote client. This includes
2979    channels, bridges, endpoints, media, and other fundamental concepts. Users
2980    of ARI can develop their own communications applications, controlling
2981    multiple channels using an HTTP RESTful interface and receiving JSON events
2982    about the objects via a WebSocket connection. ARI can be configured in
2983    Asterisk via ari.conf. For more information on ARI, see
2984    https://wiki.asterisk.org/wiki/x/0YCLAQ
2985
2986 res_parking
2987 -------------------
2988  * Parking has been extracted from the Asterisk core as a loadable module,
2989    res_parking. Configuration for parking is now provided by res_parking.conf.
2990    Configuration through features.conf is no longer supported.
2991
2992  * res_parking uses the configuration framework. If an invalid configuration is
2993    supplied, res_parking will fail to load or fail to reload. Previously,
2994    invalid configurations would generally be accepted, with certain errors
2995    resulting in individually disabled parking lots.
2996
2997  * Parked calls are now placed in bridges. While this is largely an
2998    architectural change, it does have implications on how channels in a parking
2999    lot are viewed. For example, commands that display channels in bridges will
3000    now also display the channels in a parking lot.
3001
3002  * The order of arguments for the new parking applications have been modified.
3003    Timeout and return context/exten/priority are now implemented as options,
3004    while the name of the parking lot is now the first parameter. See the
3005    application documentation for Park, ParkedCall, and ParkAndAnnounce for more
3006    in-depth information as well as syntax.
3007
3008  * Extensions are by default no longer automatically created in the dialplan to
3009    park calls or pickup parked calls. Generation of dialplan extensions can be
3010    enabled using the 'parkext' configuration option.
3011
3012  * ADSI functionality for parking is no longer supported. The 'adsipark'
3013    configuration option has been removed as a result.
3014
3015  * The PARKINGSLOT channel variable has been deprecated in favor of
3016    PARKING_SPACE to match the naming scheme of the new system.
3017
3018  * PARKING_SPACE and PARKEDLOT channel variables will now be set for a parked
3019    channel even when the configuration option 'comebactoorigin' is enabled.
3020
3021  * A new CLI command 'parking show' has been added. This allows a user to
3022    inspect the parking lots that are currently in use.
3023    'parking show <parkinglot>' will also show the parked calls in a specific
3024    parking lot.
3025
3026  * The CLI command 'parkedcalls' is now deprecated in favor of
3027    'parking show <parkinglot>'.
3028
3029  * The AMI command 'ParkedCalls' will now accept a 'ParkingLot' argument which
3030    can be used to get a list of parked calls for a specific parking lot.
3031
3032  * The AMI command 'Park' field 'Channel2' has been deprecated and replaced
3033    with 'TimeoutChannel'. If both 'Channel2' and 'TimeoutChannel' are
3034    specified, 'TimeoutChannel' will be used. The field 'TimeoutChannel' is no
3035    longer a required argument.
3036
3037  * The ParkAndAnnounce application is now provided through res_parking instead
3038    of through the separate app_parkandannounce module.
3039
3040  * ParkAndAnnounce will no longer go to the next position in dialplan on timeout
3041    by default. Instead, it will follow the timeout rules of the parking lot. The
3042    old behavior can be reproduced by using the 'c' option.
3043
3044  * Dynamic parking lots will now fail to be created under the following
3045    conditions:
3046    - if the parking lot specified by PARKINGDYNAMIC does not exist
3047    - if they require exclusive park and parkedcall extensions which overlap
3048      with existing parking lots.
3049
3050  * Dynamic parking lots will be cleared on reload for dynamic parking lots that
3051    currently contain no calls. Dynamic parking lots containing parked calls
3052    will persist through the reloads without alteration.
3053
3054  * If 'parkext_exclusive' is set for a parking lot and that extension is
3055    already in use when that parking lot tries to register it, this is now
3056    considered a parking system configuration error. Configurations which do
3057    this will be rejected.
3058
3059  * Added channel variable PARKER_FLAT. This contains the name of the extension
3060    that would be used if 'comebacktoorigin' is enabled. This can be useful when
3061    comebacktoorigin is disabled, but the dialplan or an external control
3062    mechanism wants to use the extension in the park-dial context that was
3063    generated to re-dial the parker on timeout.
3064
3065 res_pjsip (and many others)
3066 ------------------
3067  * A large number of resource modules make up the SIP stack based on pjsip.
3068    The chan_pjsip channel driver users these resource modules to provide
3069    various SIP functionality in Asterisk. The majority of configuration for
3070    these modules is performed in pjsip.conf. Other modules may use their
3071    own configuration files.
3072
3073  * Added 'set_var' option for an endpoint. For each variable specified that
3074    variable gets set upon creation of a channel involving the endpoint.
3075
3076 res_rtp_asterisk
3077 ------------------
3078  * ICE/STUN/TURN support in res_rtp_asterisk has been made optional.  To enable
3079    them, an Asterisk-specific version of PJSIP needs to be installed.
3080    Tarballs are available from https://github.com/asterisk/pjproject/tags/.
3081
3082 res_statsd/res_chan_stats
3083 ------------------
3084  * A new resource module, res_statsd, has been added, which acts as a statsd
3085    client. This module allows Asterisk to publish statistics to a statsd
3086    server. In conjunction with res_chan_stats, it will publish statistics about
3087    channels to the statsd server. It can be configured via res_statsd.conf.
3088
3089 res_xmpp
3090 ------------------
3091  * Device state for XMPP buddies is now available using the following format:
3092    XMPP/<client name>/<buddy address>
3093    If any resource is available the device state is considered to be not in use.
3094    If no resources exist or all are unavailable the device state is considered
3095    to be unavailable.
3096
3097
3098 Scripts
3099 ------------------
3100
3101 Realtime/Database Scripts
3102 ------------------
3103  * Asterisk previously included example db schemas in the contrib/realtime/
3104    directory of the source tree.  This has been replaced by a set of database
3105    migrations using the Alembic framework.  This allows you to use alembic to
3106    initialize the database for you.  It will also serve as a database migration
3107    tool when upgrading Asterisk in the future.
3108
3109    See contrib/ast-db-manage/README.md for more details.
3110
3111 sip_to_res_pjsip.py
3112 -------------------
3113  * A new script has been added in the contrib/scripts/sip_to_res_pjsip folder.
3114    This python script will convert an existing sip.conf file to a
3115    pjsip.conf file, for use with the chan_pjsip channel driver. This script
3116    is meant to be an aid in converting an existing chan_sip configuration to
3117    a chan_pjsip configuration, but it is expected that configuration beyond
3118    what the script provides will be needed.
3119
3120 ------------------------------------------------------------------------------
3121 --- Functionality changes from Asterisk 10 to Asterisk 11 --------------------
3122 ------------------------------------------------------------------------------
3123
3124 Build System
3125 -------------------
3126  * The Asterisk build system will now build and install a shared library
3127    (libasteriskssl.so) used to wrap various initialization and shutdown functions
3128    from the libssl and libcrypto libraries provided by OpenSSL. This is done so
3129    that Asterisk can ensure that these functions do *not* get called by any
3130    modules that are loaded into Asterisk, since they should only be called once
3131    in any single process. If desired, this feature can be disabled by supplying
3132    the "--disable-asteriskssl" option to the configure script.
3133
3134  * A new make target, 'full', has been added to the Makefile.  This performs
3135    the same compilation actions as make all, but will also scan the entirety of
3136    each source file for documentation.  This option is needed to generate AMI
3137    event documentation.  Note that your system must have Python in order for
3138    this make target to succeed.
3139
3140  * The optimization portion of the build system has been reworked to avoid
3141    broken builds on certain architectures.  All architecture-specific
3142    optimization has been removed in favor of using -march=native to allow gcc
3143    to detect the environment in which it is running when possible.  This can
3144    be toggled as BUILD_NATIVE under "Compiler Flags" in menuselect.
3145
3146  * BUILD_CFLAGS and BUILD_LDFLAGS can now be passed to menuselect, e.g.,
3147    make BUILD_CFLAGS="whatever" BUILD_LDFLAGS="whatever"
3148
3149  * Remove "asterisk/version.h" in favor of "asterisk/ast_version.h".  If you
3150    previously parsed the header file to obtain the version of Asterisk, you
3151    will now have to go through Asterisk to get the version information.
3152
3153
3154 Applications
3155 -------------------
3156
3157 Bridge
3158 -------------------
3159  * Added 'F()' option. Similar to the dial option, this can be supplied with
3160    arguments indicating where the callee should go after the caller is hung up,
3161    or without options specified, the priority after the Queue will be used.
3162
3163
3164 ConfBridge
3165 -------------------
3166  * Added menu action admin_toggle_mute_participants.  This will mute / unmute
3167    all non-admin participants on a conference.  The confbridge configuration
3168    file also allows for the default sounds played to all conference users when
3169    this occurs to be overriden using sound_participants_unmuted and
3170    sound_participants_muted.
3171
3172  * Added menu action participant_count.  This will playback the number of
3173    current participants in a conference.
3174
3175  * Added announcement configuration option to user profile. If set the sound
3176    file will be played to the user, and only the user, upon joining the
3177    conference bridge.
3178
3179  * Added record_file_append option that defaults to "yes", but if set to no
3180    will create a new file between each start/stop recording.
3181
3182
3183 Dial
3184 -------------------
3185  * Added 'b' and 'B' options to Dial that execute a Gosub on callee and caller
3186    channels respectively before the callee channels are called.
3187
3188
3189 ExternalIVR
3190 -------------------
3191  * Added support for IPv6.
3192
3193  * Add interrupt ('I') command to ExternalIVR.  Sending this command from an
3194    external process will cause the current playlist to be cleared, including
3195    stopping any audio file that is currently playing.  This is useful when you
3196    want to interrupt audio playback only when specific DTMF is entered by the
3197    caller.
3198
3199
3200 FollowMe
3201 -------------------
3202  * A new option, 'I' has been added to app_followme. By setting this option,
3203    Asterisk will not update the caller with connected line changes when they
3204    occur.  This is similar to app_dial and app_queue.
3205
3206  * The 'N' option is now ignored if the call is already answered.
3207
3208  * Added 'b' and 'B' options to FollowMe that execute a Gosub on callee
3209    and caller channels respectively before the callee channels are called.
3210
3211  * The winning FollowMe outgoing call is now put on hold if the caller put it on
3212    hold.
3213
3214
3215 MixMonitor
3216 ------------------
3217  * MixMonitor hooks now have IDs associated with them which can be used to
3218    assign a target to StopMixMonitor. Use of MixMonitor's i(variable) option
3219    will allow storage of the MixMontior ID in a channel variable. StopMixmonitor
3220    now accepts that ID as an argument.
3221
3222  * Added 'm' option, which stores a copy of the recording as a voicemail in the
3223    indicated mailboxes.
3224
3225
3226 MySQL
3227 -------------------
3228  * The connect action in app_mysql now allows you to specify a port number to
3229    connect to.  This is useful if you run a MySQL server on a non-standard
3230    port number.
3231
3232
3233 OSP Applications
3234 -------------------
3235  * Increased the default number of allowed destinations from 5 to 12.
3236
3237
3238 Page
3239 -------------------
3240  * The app_page application now no longer depends on DAHDI or app_meetme.  It
3241    has been re-architected to use app_confbridge internally.
3242
3243
3244 Queue
3245 -------------------
3246  * Added queue options autopausebusy and autopauseunavail for automatically
3247    pausing a queue member when their device reports busy or congestion.
3248
3249  * The 'ignorebusy' option for queue members has been deprecated in favor of
3250    the option 'ringinuse. Also a 'queue set ringinuse' CLI command has been
3251    added as well as an AMI action 'QueueMemberRingInUse' to set this variable on a
3252    per interface basis. Individual ringinuse values can now be set in
3253    queues.conf via an argument to member definitions. Lastly, the queue
3254    'ringinuse' setting now only determines defaults for the per member
3255    'ringinuse' setting and does not override per member settings like it does
3256    in earlier versions.
3257
3258  * Added 'F()' option. Similar to the dial option, this can be supplied with
3259    arguments indicating where the callee should go after the caller is hung up,
3260    or without options specified, the priority after the Queue will be used.
3261
3262  * Added new option log_member_name_as_agent, which will cause the membername to
3263    be logged in the agent field for ADDMEMBER and REMOVEMEMBER queue events if a
3264    state_interface has been set.
3265
3266  * Add queue monitoring hints.  exten => 8501,hint,Queue:markq.
3267
3268  * App_queue will now play periodic announcements for the caller that
3269    holds the first position in the queue while waiting for answer.
3270
3271 SayUnixTime
3272 ------------------
3273  * Added 'j' option to SayUnixTime. SayUnixTime no longer auto jumps to extension
3274    when receiving DTMF.  Use the 'j' option to enable extension jumping. Also
3275    changed arguments to SayUnixTime so that every option is truly optional even
3276    when using multiple options (so that j option could be used without having to
3277    manually specify timezone and format) There are other benefits, e.g., format
3278    can now be used without specifying time zone as well.
3279
3280
3281 Voicemail
3282 ------------------
3283  * Addition of the VM_INFO function - see Function changes.
3284
3285  * The imapserver, imapport, and imapflags configuration options can now be
3286    overriden on a user by user basis.
3287
3288  * When voicemail plays a message's envelope with saycid set to yes, when
3289    reaching the caller id field it will play a recording of a file with the same
3290    base name as the sender's callerid if there is a similarly named file in
3291    <astspooldir>/recordings/callerids/
3292
3293  * Voicemails now contains a unique message identifier "msg_id", which is stored
3294    in the message envelope with the sound files.  IMAP backends will now store
3295    the message identifiers with a header of "X-Asterisk-VM-Message-ID".  ODBC
3296    backends will store the message identifier in a "msg_id" column.  See
3297    UPGRADE.txt for more information.
3298
3299  * Added VoiceMailPlayMsg application.  This application will play a single
3300    voicemail message from a mailbox.  The result of the application, SUCCESS or
3301    FAILED, is stored in the channel variable VOICEMAIL_PLAYBACKSTATUS.
3302
3303
3304 Functions
3305 ------------------
3306  * Hangup handlers can be attached to channels using the CHANNEL() function.
3307    Hangup handlers will run when the channel is hung up similar to the h
3308    extension. The hangup_handler_push option will push a GoSub compatible
3309    location in the dialplan onto the channel's hangup handler stack.  The
3310    hangup_handler_pop option will remove the last added location, and optionally
3311    replace it with a new GoSub compatible location.  The hangup_handler_wipe
3312    option will remove all locations on the stack, and optionally add a new
3313    location.
3314
3315  * The expression parser now recognizes the ABS() absolute value function,
3316    which will convert negative floating point values to positive values.
3317
3318  * FAXOPT(faxdetect) will enable a generic fax detect framehook for dialplan
3319    control of faxdetect.
3320
3321  * Addition of the VM_INFO function that can be used to retrieve voicemail
3322    user information, such as the email address and full name.
3323    The MAILBOX_EXISTS dialplan function has been deprecated in favour of
3324    VM_INFO.
3325
3326  * The REDIRECTING function now supports the redirecting original party id
3327    and reason.
3328
3329  * Two new functions have been added: FEATURE() and FEATUREMAP().  FEATURE()
3330    lets you set some of the configuration options from the [general] section
3331    of features.conf on a per-channel basis.  FEATUREMAP() lets you customize
3332    the key sequence used to activate built-in features, such as blindxfer,
3333    and automon.  See the built-in documentation for details.
3334
3335  * MESSAGE(from) for incoming SIP messages now returns "display-name" <uri>
3336    instead of simply the uri.  This is the format that MessageSend() can use
3337    in the from parameter for outgoing SIP messages.
3338
3339  * Added the PRESENCE_STATE function.  This allows retrieving presence state
3340    information from any presence state provider.  It also allows setting
3341    presence state information from a CustomPresence presence state provider.
3342    See AMI/CLI changes for related commands.
3343
3344  * Added the AMI_CLIENT function to make manager account attributes available
3345    to the dialplan. It currently supports returning the current number of
3346    active sessions for a given account.
3347
3348  * Added support for private party ID information to CALLERID, CONNECTEDLINE,
3349    and the REDIRECTING functions.
3350
3351
3352 Channel Drivers
3353 ------------------
3354
3355 chan_local
3356 ------------------
3357  * Added a manager event "LocalBridge" for local channel call bridges between
3358    the two pseudo-channels created.
3359
3360
3361 chan_dahdi
3362 ------------------
3363  * Added dialtone_detect option for analog ports to disconnect incoming
3364    calls when dialtone is detected.
3365
3366  * Added option colp_send to send ISDN connected line information.  Allowed
3367    settings are block, to not send any connected line information; connect, to
3368    send connected line information on initial connect; and update, to send
3369    information on any update during a call.  Default is update.
3370
3371  * Add options namedcallgroup and namedpickupgroup to support installations
3372    where a higher number of groups (>64) is required.
3373
3374  * Added support to use private party ID information with PRI calls.
3375
3376
3377 chan_motif
3378 ------------------
3379  * A new channel driver named chan_motif has been added which provides support for
3380    Google Talk and Jingle in a single channel driver. This new channel driver includes
3381    support for both audio and video, RFC2833 DTMF, all codecs supported by Asterisk,
3382    hold, unhold, and ringing notification. It is also compliant with the current Jingle
3383    specification, current Google Jingle specification, and the original Google Talk
3384    protocol.
3385
3386
3387 chan_ooh323
3388 ------------------
3389  * Added NAT support for RTP.  Setting in config is 'nat', which can be set
3390    globally and overriden on a peer by peer basis.
3391
3392  * Direct media functionality has been added. Options in config are:
3393    directmedia (directrtp) and directrtpsetup (earlydirect)
3394
3395  * ChannelUpdate events now contain a CallRef header.
3396
3397
3398 chan_sip
3399 ------------------
3400  * Asterisk will no longer substitute CID number for CID name in the display
3401    name field if CID number exists without a CID name. This change improves
3402    compatibility with certain device features such as Avaya IP500's directory
3403    lookup service.
3404
3405  * A new setting for autocreatepeer (autocreatepeer=persistent) allows peers
3406    created using that setting to not be removed during SIP reload.
3407
3408  * Added settings recordonfeature and recordofffeature.  When receiving an INFO
3409    request with a "Record:" header, this will turn the requested feature on/off.
3410    Allowed values are 'automon', 'automixmon', and blank to disable.  Note that
3411    dynamic features must be enabled and configured properly on the requesting
3412    channel for this to function properly.
3413
3414  * Add support to realtime for the 'callbackextension' option.
3415
3416  * When multiple peers exist with the same address, but differing
3417    callbackextension options, incoming requests that are matched by address
3418    will be matched to the peer with the matching callbackextension if it is
3419    available.
3420
3421  * Two new NAT options, auto_force_rport and auto_comedia, have been added
3422    which set the force_rport and comedia options automatically if Asterisk
3423    detects that an incoming SIP request crossed a NAT after being sent by
3424    the remote endpoint.
3425
3426  * The default global nat setting in sip.conf has been changed from force_rport
3427    to auto_force_rport.
3428
3429  * NAT settings are now a combinable list of options. The equivalent of the
3430    deprecated nat=yes is nat=force_rport,comedia. nat=no behaves as before.
3431
3432  * Adds an option send_diversion which can be disabled to prevent
3433    diversion headers from automatically being added to INVITE requests.
3434
3435  * Add support for lightweight NAT keepalive. If enabled a blank packet will
3436    be sent to the remote host at a given interval to keep the NAT mapping open.
3437    This can be enabled using the keepalive configuration option.
3438
3439  * Add option 'tonezone' to specify country code for indications.  This option
3440    can be set both globally and overridden for specific peers.
3441
3442  * The SIP Security Events Framework now supports IPv6.
3443
3444  * Add a new setting for directmedia, 'outgoing', to alleviate INVITE glares
3445    between multiple user agents. When set, for directmedia reinvites,
3446    Asterisk will not send an immediate reinvite on an incoming call leg. This
3447    option is useful when peered with another SIP user agent that is known to
3448    send immediate direct media reinvites upon call establishment.
3449
3450  * Add support for WebSocket transport. This can be configured using 'ws' or 'wss'
3451    as the transport.
3452
3453  * Add options subminexpiry and submaxexpiry to set limits of subscription
3454    timer independently from registration timer settings. The setting of the
3455    registration timer limits still is done by options minexpiry, maxexpiry
3456    and defaultexpiry. For backwards compatibility the setting of minexpiry
3457    and maxexpiry also is used to configure the subscription timer limits if
3458    subminexpiry and submaxexpiry are not set in sip.conf.
3459
3460  * Set registration timer limits to default values when reloading sip
3461    configuration and values are not set by configuration.
3462
3463  * Add options namedcallgroup and namedpickupgroup to support installations
3464    where a higher number of groups (>64) is required.
3465
3466  * When a MESSAGE request is received, the address the request was received from
3467    is now saved in the SIP_RECVADDR variable.
3468
3469  * Add ANI2/OLI parsing for SIP.  The "From" header in INVITE requests is now
3470    parsed for the presence of "isup-oli", "ss7-oli", or "oli" tags.  If present,
3471    the ANI2/OLI information is set on the channel, which can be retrieved using
3472    the CALLERID function.
3473
3474  * Peers can now be configured to support negotiation of ICE candidates using
3475    the setting icesupport.  See res_rtp_asterisk changes for more information.
3476
3477  * Added support for format attribute negotiation.  See the Codecs changes for
3478    more information.
3479
3480  * Extra headers specified with SIPAddHeader are sent with the REFER message
3481    when using Transfer application. See refer_addheaders in sip.conf.sample.
3482
3483  * Added support to use private party ID information with calls.
3484
3485  * Adds an option discard_remote_hold_retrieval that when set stops telling
3486    the peer to start music on hold.
3487
3488
3489 chan_skinny
3490 ------------------
3491  * Added skinny version 17 protocol support.
3492
3493
3494 chan_unistim
3495 --------------------
3496  * Added option 'dtmf_duration' allowing playback time of DTMF tones to be set
3497
3498  * Modified option 'date_format' to allow options to display date in 31Jan and Jan31
3499    formats as options 0 and 1. The previous options 0 and 1 now map to options 2 and 3
3500    as per the UNISTIM protocol.
3501
3502  * Fixed issues with dialtone not matching indications.conf and mute stopping rx
3503    as well as tx. Also fixed issue with call "Timer" displaying as French "Dur\E9e"
3504
3505  * Added ability to use multiple lines for a single phone.  This allows multiple
3506    calls to occur on a single phone, using callwaiting and switching between calls.
3507
3508  * Added option 'sharpdial' allowing end dialing by pressing # key
3509
3510  * Added option 'interdigit_timer' to control phone dial timeout
3511
3512  * Added options 'cwstyle', 'cwvolume' controlling callwaiting appearance
3513
3514  * Added global 'debug' option, that enables debug in channel driver
3515
3516  * Added ability to translate on-screen menu in multiple languages. Tested on
3517    Russian languages.  Supported encodings: ISO 8859-1, ISO 8859-2, ISO 8859-4,
3518    ISO 8859-5, ISO 2022-JP. Language controlled by 'language' and on-screen
3519    menu of phone
3520
3521  * In addition to English added French and Russian languages for on-screen menus
3522
3523  * Reworked dialing number input: added dialing by timeout, immediate dial on
3524    on dialplan compare, phone number length now not limited by screen size
3525
3526  * Added ability to pickup a call using features.conf defined value and
3527    on-screen key
3528
3529
3530 chan_mISDN:
3531 ------------------
3532  * Add options namedcallgroup and namedpickupgroup to support installations
3533    where a higher number of groups (>64) is required.
3534
3535  * Added support to use private party ID information with calls.
3536
3537
3538 Core
3539 ------------------
3540  * The minimum DTMF duration can now be configured in asterisk.conf
3541    as "mindtmfduration". The default value is (as before) set to 80 ms.
3542    (previously it was only available in source code)
3543
3544  * Named ACLs can now be specified in acl.conf and used in configurations that
3545    use ACLs. As a general rule, if some derivative of 'permit' or 'deny' is
3546    used to specify an ACL, a similar form of 'acl' will add a named ACL to the
3547    working ACL. In addition, some CLI commands have been added to provide
3548    show information and allow for module reloading - see CLI Changes.
3549
3550  * Rules in ACLs (specified using 'permit' and 'deny') can now contain multiple
3551    items (separated by commas), and items in the rule can be negated by prefixing
3552    them with '!'. This simplifies Asterisk Realtime configurations, since it is no
3553    longer necessray to control the order that the 'permit' and 'deny' columns are
3554    returned from queries.
3555
3556  * DUNDi now allows the built in variables ${NUMBER}, ${IPADDR} and ${SECRET} to
3557    be used within the dynamic weight attribute when specifying a mapping.
3558
3559  * CEL backends can now be configured to show "USER_DEFINED" in the EventName
3560    header, instead of putting the user defined event name there.  When enabled
3561    the UserDefType header is added for user defined events.  This feature is
3562    enabled with the setting show_user_defined.
3563
3564  * Macro has been deprecated in favor of GoSub.  For redirecting and connected
3565    line purposes use the following variables instead of their macro equivalents:
3566    REDIRECTING_SEND_SUB, REDIRECTING_SEND_SUB_ARGS, CONNECTED_LINE_SEND_SUB,
3567    CONNECTED_LINE_SEND_SUB_ARGS.  For CCSS, use cc_callback_sub instead of
3568    cc_callback_macro in channel configurations.
3569
3570  * Asterisk can now use a system-provided NetBSD editline library (libedit) if it
3571    is available.
3572
3573  * Call files now support the "early_media" option to connect with an outgoing
3574    extension when early media is received.
3575
3576  * Added support to use private party ID information with calls.
3577
3578
3579 AGI
3580 ------------------
3581  * A new channel variable, AGIEXITONHANGUP, has been added which allows
3582    Asterisk to behave like it did in Asterisk 1.4 and earlier where the
3583    AGI application would exit immediately after a channel hangup is detected.
3584
3585  * IPv6 addresses are now supported when using FastAGI (agi://).  Hostnames
3586    are resolved and each address is attempted in turn until one succeeds or
3587    all fail.
3588
3589
3590 AMI (Asterisk Manager Interface)
3591 ------------------
3592  * The originate action now has an option "EarlyMedia" that enables the
3593    call to bridge when we get early media in the call. Previously,
3594    early media was disregarded always when originating calls using AMI.
3595
3596  * Added setvar= option to manager accounts (much like sip.conf)
3597
3598  * Originate now generates an error response if the extension given is not found
3599    in the dialplan
3600
3601  * MixMonitor will now show IDs associated with the mixmonitor upon creating
3602    them if the i(variable) option is used. StopMixMonitor will accept
3603    MixMonitorID as an option to close specific MixMonitors.
3604
3605  * The SIPshowpeer manager action response field "SIP-Forcerport" has been
3606    updated to include information about peers configured with
3607    nat=auto_force_rport by returning "A" if auto_force_rport is set and nat is
3608    detected, and "a" if it is set and nat is not detected. "Y" and "N" are still
3609    returned if auto_force_rport is not enabled.
3610
3611  * Added SIPpeerstatus manager command which will generate PeerStatus events
3612    similar to the existing PeerStatus events found in chan_sip on demand.
3613
3614  * Hangup now can take a regular expression as the Channel option.  If you want
3615    to hangup multiple channels, use /regex/ as the Channel option.  Existing
3616    behavior to hanging up a single channel is unchanged, but if you pass a regex,
3617    the manager will send you a list of channels back that were hung up.
3618
3619  * Support for IPv6 addresses has been added.
3620
3621  * AMI Events can now be documented in the Asterisk source. Note that AMI event
3622    documentation is only generated when Asterisk is compiled using 'make full'.
3623    See the CLI section for commands to display AMI event information.
3624
3625  * The AMI Hangup event now includes the AccountCode header so you can easily
3626    correlate with AMI Newchannel events.
3627
3628  * The QueueMemberStatus, QueueMemberAdded, and QueueMember events now include
3629    the StateInterface of the queue member.
3630
3631  * Added AMI event SessionTimeout in the Call category that is issued when a
3632    call is terminated due to either RTP stream inactivity or SIP session timer
3633    expiration.
3634
3635  * CEL events can now contain a user defined header UserDefType.  See core
3636    changes for more information.
3637
3638  * OOH323 ChannelUpdate events now contain a CallRef header.
3639
3640  * Added PresenceState command.  This command will report the presence state for
3641    the given presence provider.
3642
3643  * Added Parkinglots command.  This will list all parking lots as a series of
3644    AMI Parkinglot events.
3645
3646  * Added MessageSend command.  This behaves in the same manner as the
3647    MessageSend application, and is a technolgoy agnostic mechanism to send out
3648    of call text messages.
3649
3650  * Added "message" class authorization.  This grants an account permission to
3651    send out of call messages.  Write-only.
3652
3653
3654 CLI
3655 -------------------
3656  * The "dialplan add include" command has been modified to create context a context
3657    if one does not already exist. For instance, "dialplan add include foo into bar"
3658    will create context "bar" if it does not already exist.
3659
3660  * A  "dialplan remove context" command has been added to remove a context from
3661    the dialplan
3662
3663  * The "mixmonitor list <channel>" command will now show MixMonitor ID, and the
3664    filenames of all running mixmonitors on a channel.
3665
3666  * The debug level of "pri set debug" is now a bitmask ranging from 0 to 15 if
3667    numeric instead of 0, 1, or 2.
3668
3669  * "stun show status" will show a table describing how the STUN client is
3670    behaving.
3671
3672  * "acl show [named acl]" will show information regarding a Named ACL.  The
3673    acl module can be reloaded with "reload acl".
3674
3675  * Added CLI command to display AMI event information - "manager show events",
3676    which shows a list of all known and documented AMI events, and "manager show
3677    event [event name]", which shows detail information about a specific AMI
3678    event.
3679
3680  * The result of the CLI command "queue show" now includes the state interface
3681    information of the queue member.
3682
3683  * The command "core set verbose" will now set a separate level of logging for
3684    each remote console without affecting any other console.
3685
3686  * Added command "cdr show pgsql status" to check connection status
3687
3688  * "sip show channel" will now display the complete route set.
3689
3690  * Added "presencestate list" command.  This command will list all custom
3691    presence states that have been set by using the PRESENCE_STATE dialplan
3692    function.
3693
3694  * Added "presencestate change <entity> <state>[,<subtype>[,message[,options]]]"
3695    command.  This changes a custom presence to a new state.
3696
3697
3698 Codecs
3699 -------------------
3700  * Codec lists may now be modified by the '!' character, to allow succinct
3701    specification of a list of codecs allowed and disallowed, without the
3702    requirement to use two different keywords.  For example, to specify all
3703    codecs except g729 and g723, one need only specify allow=all,!g729,!g723.
3704
3705  * Add support for parsing SDP attributes, generating SDP attributes, and
3706    passing it through. This support includes codecs such as H.263, H.264, SILK,
3707    and CELT. You are able to set up a call and have attribute information pass.
3708    This should help considerably with video calls.
3709
3710  * The iLBC codec can now use a system-provided iLBC library if one is installed,
3711    just like the GSM codec.
3712
3713 DUNDi changes
3714 -------------
3715  * Added CLI commands dundi show hints and dundi show cache which will list DUNDi
3716    'DONTASK' hints in the cache and list all DUNDi cache entires respectively.
3717
3718 Logging
3719 -------------------
3720  * Asterisk version and build information is now logged at the beginning of a
3721    log file.
3722
3723  * Threads belonging to a particular call are now linked with callids which get
3724    added to any log messages produced by those threads. Log messages can now be
3725    easily identified as involved with a certain call by looking at their call id.
3726    Call ids may also be attached to log messages for just about any case where
3727    it can be determined to be related to a particular call.
3728
3729  * Each logging destination and console now have an independent notion of the
3730    current verbosity level.  Logger.conf now allows an optional argument to
3731    the 'verbose' specifier, indicating the level of verbosity sent to that
3732    particular logging destination.  Additionally, remote consoles now each
3733    have their own verbosity level.  The command 'core set verbose' will now set
3734    a separate level for each remote console without affecting any other
3735    console.
3736
3737
3738 Music On Hold
3739 -------------------
3740  * Added 'announcement' option which will play at the start of MOH and between
3741    songs in modes of MOH that can detect transitions between songs (eg.
3742    files, mp3, etc).
3743
3744
3745 Parking
3746 -------------------
3747  * New per parking lot options: comebackcontext and comebackdialtime. See
3748    configs/features.conf.sample for more details.
3749
3750  * Channel variable PARKER is now set when comebacktoorigin is disabled in
3751    a parking lot.
3752
3753  * Channel variable PARKEDCALL is now set with the name of the parking lot
3754    when a timeout occurs.
3755
3756
3757 CDRs
3758 -------------------
3759
3760 CDR Postgresql Driver
3761 -------------------
3762  * Added command "cdr show pgsql status" to check connection status
3763
3764
3765 CDR Adaptive ODBC Driver
3766 -------------------
3767  * Added schema option for databases that support specifying a schema.
3768
3769
3770 Resource Modules
3771 -------------------
3772
3773 Calendars
3774 -------------------
3775  * A CALENDAR_SUCCESS=1/0 channel variable is now set to show whether or not
3776    CALENDAR_WRITE has completed successfully.
3777
3778
3779 res_rtp_asterisk
3780 -------------------
3781  * A new option, 'probation' has been added to rtp.conf
3782    RTP in strictrtp mode can now require more than 1 packet to exit learning
3783    mode with a new source (and by default requires 4). The probation option
3784    allows the user to change the required number of packets in sequence to any
3785    desired value. Use a value of 1 to essentially restore the old behavior.
3786    Also, with strictrtp on, Asterisk will now drop all packets until learning
3787    mode has successfully exited. These changes are based on how pjmedia handles
3788    media sources and source changes.
3789
3790  * Add support for ICE/STUN/TURN in res_rtp_asterisk.  This option can be
3791    enabled or disabled using the icesupport setting.  A variety of other
3792    settings have been introduced to configure STUN/TURN connections.
3793
3794
3795 res_corosync
3796 -------------------
3797  * A new module, res_corosync, has been introduced.  This module uses the
3798    Corosync cluster enginer (http://www.corosync.org) to allow a local cluster
3799    of Asterisk servers to both Message Waiting Indication (MWI) and/or
3800    Device State (presence) information.  This module is very similar to, and
3801    is a replacement for the res_ais module that was in previous releases of
3802    Asterisk.
3803
3804
3805 res_xmpp
3806 -------------------
3807  * This module adds a cleaned up, drop-in replacement for res_jabber called
3808    res_xmpp. This provides the same externally facing functionality but is
3809    implemented differently internally.  res_jabber has been deprecated in favor
3810    of res_xmpp; please see the UPGRADE.txt file for more information.
3811
3812
3813 Scripts
3814 -------------------
3815  * The safe_asterisk script has been updated to allow several of its parameters
3816    to be set from environment variables.  This also enables a custom run
3817    directory of Asterisk to be specified, instead of defaulting to /tmp.
3818
3819  * The live_ast script will now look for the LIVE_AST_BASE_DIR variable and use
3820    its value to determine the directory to assume is the top-level directory of
3821    the source tree.  If the variable is not set, it defaults to the current
3822    behavior and uses the current working directory.
3823
3824 ------------------------------------------------------------------------------
3825 --- Functionality changes from Asterisk 1.8 to Asterisk 10 -------------------
3826 ------------------------------------------------------------------------------
3827
3828 Text Messaging
3829 --------------
3830  * Asterisk now has protocol independent support for processing text messages
3831    outside of a call.  Messages are routed through the Asterisk dialplan.
3832    SIP MESSAGE and XMPP are currently supported.  There are options in
3833    jabber.conf and sip.conf to allow enabling these features.
3834      -> jabber.conf: see the "sendtodialplan" and "context" options.
3835      -> sip.conf: see the "accept_outofcall_message", "auth_message_requests"
3836         and "outofcall_message_context" options.
3837    The MESSAGE() dialplan function and MessageSend() application have been
3838    added to go along with this functionality.  More detailed usage information
3839    can be found on the Asterisk wiki (http://wiki.asterisk.org/).
3840  * If real-time text support (T.140) is negotiated, it will be preferred for
3841    sending text via the SendText application. For example, via SIP, messages
3842    that were once sent via the SIP MESSAGE request would be sent via RTP if
3843    T.140 text is negotiated for a call.
3844
3845 Parking
3846 -------
3847  * parkedmusicclass can now be set for non-default parking lots.
3848
3849 Asterisk Manager Interface
3850 --------------------------
3851  * PeerStatus now includes Address and Port.
3852  * Added Hold events for when the remote party puts the call on and off hold
3853    for chan_dahdi ISDN channels.
3854  * Added new action MeetmeListRooms to list active conferences (shows same
3855    data as "meetme list" at the CLI).
3856  * DAHDIShowChannels, SIPshowpeer, SIPpeers, and IAXpeers now contains a
3857    Description field that is set by 'description' in the channel configuration
3858    file.
3859  * Added Uniqueid header to UserEvent.
3860  * Added new action FilterAdd to control event filters for the current session.
3861    This requires the system permission and uses the same filter syntax as
3862    filters that can be defined in manager.conf
3863  * The Unlink event is now a Bridge event with Bridgestatus: Unlink. Previous
3864    versions had some instances of the event converted, but others were left
3865    as-is. All Unlink events should now be converted to Bridge events. The AMI
3866    protocol version number was incremented to 1.2 as a result of this change.
3867
3868 Asterisk HTTP Server
3869 --------------------------
3870  * The HTTP Server can bind to IPv6 addresses.
3871
3872 chan_dahdi
3873 --------------------------
3874  * Busy tone patterns featuring 2 silence and 2 tone lengths can now be used
3875    with busydetect.  usage example: busypattern=200,200,200,600
3876
3877 CLI Changes
3878 --------------------------
3879  * New 'gtalk show settings' command showing the current settings loaded from
3880    gtalk.conf.
3881  * The 'logger reload' command now supports an optional argument, specifying an
3882    alternate configuration file to use.
3883  * 'dialplan add extension' command will now automatically create a context if
3884    the specified context does not exist with a message indicated it did so.
3885  * 'sip show peers', 'iax show peers', and 'dahdi show peers' now contains a
3886    Description field which can be populated with 'description' in the channel
3887    configuration files (sip.conf, iax2.conf, and chan_dahdi.conf).
3888
3889 CDR
3890 --------------------------
3891  * The filter option in cdr_adaptive_odbc now supports negating the argument,
3892    thus allowing records which do NOT match the specified filter.
3893  * Added ability to log CONGESTION calls to CDR
3894
3895 CODECS
3896 --------------------------
3897  * Ability to define custom SILK formats in codecs.conf.
3898  * Addition of speex32 audio format with translation.
3899  * CELT codec pass-through support and ability to define
3900    custom CELT formats in codecs.conf.
3901  * Ability to read raw signed linear files with sample rates
3902    ranging from 8khz - 192khz.  The new file extensions introduced
3903    are .sln12, .sln24, .sln32, .sln44, .sln48, .sln96, .sln192.
3904  * Due to protocol limitations, channel drivers other than SIP (eg. IAX2, MGCP,
3905    Skinny, H.323, etc) can still only support the following codecs:
3906    Audio: ulaw, alaw, slin, slin16, g719, g722, g723, g726, g726aal2, g729, gsm,
3907           siren7, siren14, speex, speex16, ilbc, lpc10, adpcm
3908    Video: h261, h263, h263p, h264, mpeg4
3909    Image: jpeg, png
3910    Text:  red, t140
3911
3912 ConfBridge
3913 --------------------------
3914  * New highly optimized and customizable ConfBridge application capable of
3915    mixing audio at sample rates ranging from 8khz-96khz.
3916  * CONFBRIDGE dialplan function capable of creating dynamic ConfBridge user
3917    and bridge profiles on a channel.
3918  * CONFBRIDGE_INFO dialplan function capable of retrieving information
3919    about a conference such as locked status and number of parties, admins,
3920    and marked users.
3921  * Addition of video_mode option in confbridge.conf for adding video support
3922    into a bridge profile.
3923  * Addition of the follow_talker video_mode in confbridge.conf.  This video
3924    mode dynamically switches the video feed to always display the loudest talker
3925    supplying video in the conference.
3926
3927 Dialplan Variables
3928 ------------------
3929  * Added ASTETCDIR, ASTMODDIR, ASTVARLIBDIR, ASTDBDIR, ASTKEYDIR, ASTDATADIR,
3930    ASTAGIDIR, ASTSPOOLDIR, ASTRUNDIR, ASTLOGDIR which hold the equivalent
3931    variables from asterisk.conf.
3932
3933 Dialplan Functions
3934 ------------------
3935  * Addition of the JITTERBUFFER dialplan function. This function allows
3936    for jitterbuffering to occur on the read side of a channel.  By using
3937    this function conference applications such as ConfBridge and MeetMe can
3938    have the rx streams jitterbuffered before conference mixing occurs.
3939  * Added DB_KEYS, which lists the next set of keys in the Asterisk database
3940    hierarchy.
3941  * Added STRREPLACE function.  This function let's the user search a variable
3942    for a given string to replace with another string as many times as the
3943    user specifies or just throughout the whole string.
3944  * Added option to CHANNEL(pickupgroup) allow reading and setting the pickupgroup of channel.
3945  * Mark VALID_EXTEN() deprecated in favor of DIALPLAN_EXISTS()
3946  * Added extensions to chan_ooh323 in function CHANNEL()
3947
3948 libpri channel driver (chan_dahdi) DAHDI changes
3949 --------------------------
3950  * Added moh_signaling option to specify what to do when the channel's bridged
3951    peer puts the ISDN channel on hold.
3952  * Added display_send and display_receive options to control how the display ie
3953    is handled.  To send display text from the dialplan use the SendText()
3954    application when the option is enabled.
3955  * Added mcid_send option to allow sending a MCID request on a span.
3956
3957 Calendaring
3958 --------------------------
3959  * Added setvar option to calendar.conf to allow setting channel variables on
3960    notification channels.
3961  * Added "calendar show types" CLI command to list registered calendar
3962    connectors.
3963
3964 MixMonitor
3965 --------------------------
3966  * Added two new options, r and t with file name arguments to record
3967    single direction (unmixed) audio recording separate from the bidirectional
3968    (mixed) recording.  The mixed file name argument is optional now as long
3969    as at least one recording option is used.
3970
3971 FollowMe
3972 --------------------------
3973  * Added a new option, l, which will disable local call optimization for
3974    channels involved with the FollowMe thread.  Use this option to improve
3975    compatability for a FollowMe call with certain dialplan apps, options, and
3976    functions.
3977
3978 Meetme
3979 --------------------------
3980  * Added option "k" that will automatically close the conference when there's
3981    only one person left when a user exits the conference.
3982
3983 CEL
3984 --------------------------
3985  * cel_pgsql now supports the 'extra' column for data added using the
3986    CELGenUserEvent() application.
3987
3988 pbx_lua
3989 --------------------------
3990  * Support for defining hints has been added to pbx_lua.  See the 'hints' table
3991    in the sample extensions.lua file for syntax details.
3992  * Applications that perform jumps in the dialplan such as Goto will now
3993    execute properly.  When pbx_lua detects that the context, extension, or
3994    priority we are executing on has changed it will immediately return control
3995    to the asterisk PBX engine.  Currently the engine cannot detect a Goto to
3996    the priority after the currently executing priority.
3997  * An autoservice is now started by default for pbx_lua channels.  It can be
3998    stopped and restarted using the autoservice_stop() and autoservice_start()
3999    functions.
4000
4001 res_fax
4002 --------------------------
4003  * The ReceiveFAXStatus and SendFAXStatus manager events have been consolidated
4004    into a FAXStatus event with an 'Operation' header that will be either
4005    'send', 'receive', and 'gateway'.
4006  * T.38 gateway functionality has been added to res_fax (and res_fax_spandsp).
4007    Set FAXOPT(gateway)=yes to enable this functionality on a channel. This
4008    feature will handle converting a fax call between an audio T.30 fax terminal
4009    and an IFP T.38 fax terminal.
4010
4011 SIP Changes
4012 -----------
4013  * Add T38 support for REJECTED state where T.38 Negotiation is explicitly rejected.
4014  * Add option encryption_taglen to set auth taglen only 32 and 80 are supported currently.
4015  * SIP now generates security events using the Security Events Framework for REGISTER and INVITE.
4016
4017 Queue changes
4018 -------------
4019  * Added general option negative_penalty_invalid default off. when set
4020    members are seen as invalid/logged out when there penalty is negative.
4021    for realtime members when set remove from queue will set penalty to -1.
4022  * Added queue option autopausedelay when autopause is enabled it will be
4023    delayed for this number of seconds since last successful call if there
4024    was no prior call the agent will be autopaused immediately.
4025  * Added member option ignorebusy this when set and ringinuse is not
4026    will allow per member control of multiple calls as ringinuse does for
4027    the Queue.
4028
4029 Applications
4030 ------------
4031  * Added 'v' option to MeetMe to play voicemail greetings when a user joins/leaves
4032    a MeetMe conference
4033  * Added 'k' option to MeetMe to automatically kill the conference when there's only
4034    one participant left (much like a normal call bridge)
4035  * Added extra argument to Originate to set timeout.
4036
4037 Asterisk Database
4038 -----------------
4039  * The internal Asterisk database has been switched from Berkeley DB 1.86 to
4040    SQLite 3. An existing Berkeley astdb file can be converted with the astdb2sqlite3
4041    utility in the UTILS section of menuselect. If an existing astdb is found and no
4042    astdb.sqlite3 exists, astdb2sqlite3 will be compiled automatically. Asterisk will
4043    convert an existing astdb to the SQLite3 version automatically at runtime.
4044
4045 Asterisk Modules
4046 ----------------
4047  * Modules marked as deprecated are no longer marked as building by default. Enabling
4048    these modules is still available via menuselect.
4049
4050 IAX2 Changes
4051 ------------
4052  * authdebug is now disabled by default. To enable this functionaility again
4053    set authdebug = yes in iax.conf.
4054
4055 RTP Changes
4056 -----------
4057  * The rtp.conf setting "strictrtp" is now enabled by default. In previous
4058    releases it was disabled.
4059
4060 PBX Core
4061 --------
4062  * The PBX core previously made a call with a non-existing extension test for
4063    extension s@default and jump there if the extension existed.
4064    This was a bad default behaviour and violated the principle of least surprise.
4065    It has therefore been changed in this release. It may affect some
4066    applications and configurations that rely on this behaviour. Most channel
4067    drivers have avoided this for many releases by testing whether the extension
4068    called exists before starting the PBX and generating a local error.
4069    This behaviour still exists and works as before.
4070
4071    Extension "s" is used when no extension is given in a channel driver,
4072    like immediate answer in DAHDI or calling to a domain with no user part
4073    in a SIP uri.
4074
4075 ------------------------------------------------------------------------------
4076 --- Functionality changes from Asterisk 1.6.2 to Asterisk 1.8 ----------------
4077 ------------------------------------------------------------------------------
4078
4079 SIP Changes
4080 -----------
4081  * Due to potential username discovery vulnerabilities, the 'nat' setting in sip.conf
4082    now defaults to force_rport. It is very important that phones requiring nat=no be
4083    specifically set as such instead of relying on the default setting. If at all
4084    possible, all devices should have nat settings configured in the general section as
4085    opposed to configuring nat per-device.
4086  * Added preferred_codec_only option in sip.conf. This feature limits the joint
4087    codecs sent in response to an INVITE to the single most preferred codec.
4088  * Added SIP_CODEC_OUTBOUND dialplan variable which can be used to set the codec
4089    to be used for the outgoing call. It must be one of the codecs configured
4090    for the device.
4091  * Added tlsprivatekey option to sip.conf.  This allows a separate .pem file
4092    to be used for holding a private key.  If tlsprivatekey is not specified,
4093    tlscertfile is searched for both public and private key.
4094  * Added tlsclientmethod option to sip.conf.  This allows the protocol for
4095    outbound client connections to be specified.
4096  * The sendrpid parameter has been expanded to include the options
4097    'rpid' and 'pai'. Setting sendrpid to 'rpid' will cause Remote-Party-ID
4098    header to be sent (equivalent to setting sendrpid=yes) and setting
4099    sendrpid to 'pai' will cause P-Asserted-Identity header to be sent.
4100  * The 'ignoresdpversion' behavior has been made automatic when the SDP received
4101    is in response to a T.38 re-INVITE that Asterisk initiated. In this situation,
4102    since the call will fail if Asterisk does not process the incoming SDP, Asterisk
4103    will accept the SDP even if the SDP version number is not properly incremented,
4104    but will generate a warning in the log indicating that the SIP peer that sent
4105    the SDP should have the 'ignoresdpversion' option set.
4106  * The 'nat' option has now been been changed to have yes, no, force_rport, and
4107    comedia as valid values. Setting it to yes forces RFC 3581 behavior and enables
4108    symmetric RTP support. Setting it to no only enables RFC 3581 behavior if the
4109    remote side requests it and disables symmetric RTP support. Setting it to
4110    force_rport forces RFC 3581 behavior and disables symmetric RTP support.
4111    Setting it to comedia enables RFC 3581 behavior if the remote side requests it
4112    and enables symmetric RTP support.
4113  * Slave SIP channels now set HASH(SIP_CAUSE,<slave-channel-name>) on each
4114    response.  This permits the master channel to know how each channel dialled
4115    in a multi-channel setup resolved in an individual way. This carries a
4116    performance penalty and can be disabled in sip.conf using the
4117    'storesipcause' option.
4118  * Added 'externtcpport' and 'externtlsport' options to allow custom port
4119    configuration for the externip and externhost options when tcp or tls is used.
4120  * Added support for message body (stored in content variable) to SIP NOTIFY message
4121    accessible via AMI and CLI.
4122  * Added 'media_address' configuration option which can be used to explicitly specify
4123    the IP address to use in the SDP for media (audio, video, and text) streams.
4124  * Added 'unsolicited_mailbox' configuration option which specifies the virtual mailbox
4125    that the new/old count should be stored on if an unsolicited MWI NOTIFY message is
4126    received.
4127  * Added 'use_q850_reason' configuration option for generating and parsing
4128    if available  Reason: Q.850;cause=<cause code> header. It is implemented
4129    in some gateways for better passing PRI/SS7 cause codes via SIP.
4130  * When dialing SIP peers, a new component may be added to the end of the dialstring
4131    to indicate that a specific remote IP address or host should be used when dialing
4132    the particular peer. The dialstring format is SIP/peer/exten/host_or_IP.
4133  * SRTP SDES support for encrypting calls to/from Asterisk over SIP. The
4134    ability to selectively force bridged channels to also be encrypted is also
4135    implemented. Branching in the dialplan can be done based on whether or not
4136    a channel has secure media and/or signaling.
4137  * Added directmediapermit/directmediadeny to limit which peers can send direct media
4138    to each other
4139  * Added the 'snom_aoc_enabled' option to turn on support for sending Advice of
4140    Charge messages to snom phones.
4141  * Added support for G.719 media streams.
4142  * Added support for 16khz signed linear media streams.
4143  * SIP is now able to bind to and communicate with IPv6 addresses. In addition,
4144    RTP has been outfitted with the same abilities.
4145  * Added support for setting the Max-Forwards: header in SIP requests. Setting is
4146    available in device configurations as well as in the dial plan.
4147  * Addition of the 'subscribe_network_change' option for turning on and off
4148    res_stun_monitor module support in chan_sip.
4149  * Addition of the 'auth_options_requests' option for turning on and off
4150    authentication for OPTIONS requests in chan_sip.
4151
4152 Configuration files
4153 -------------------
4154  * Add #tryinclude statement for config files.  This provides the same
4155    functionality as the #include statement however an asterisk module will
4156    still load if the filename does not exist.  Using the #include statement
4157    Asterisk will not allow the module to load.
4158
4159 IAX2 Changes
4160 -----------
4161  * Added rtsavesysname option into iax.conf to allow the systname to be saved
4162    on realtime updates.
4163  * Added the ability for chan_iax2 to inform the dialplan whether or not
4164    encryption is being used. This interoperates with the SIP SRTP implementation
4165    so that a secure SIP call can be bridged to a secure IAX call when the
4166    dialplan requires bridged channels to be "secure".
4167  * Addition of the 'subscribe_network_change' option for turning on and off
4168    res_stun_monitor module support in chan_iax.
4169
4170
4171 MGCP Changes
4172 ------------
4173  * Added ability to preset channel variables on indicated lines with the setvar
4174    configuration option.  Also, clearvars=all resets the list of variables back
4175    to none.
4176  * PacketCable NCS 1.0 support has been added for Docsis/Eurodocsis Networks.
4177    See configs/res_pktccops.conf for more information.
4178
4179 XMPP Google Talk/Jingle changes
4180 -------------------------------
4181   * Added the externip option to gtalk.conf.
4182   * Added the stunaddr option to gtalk.conf which allows for the automatic
4183     retrieval of the external ip from a stun server.
4184
4185 Applications
4186 ------------
4187  * Added 'p' option to PickupChan() to allow for picking up channel by the first