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