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