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