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