---
title: "Presence_CallInfo Module"
description: "This module provides OpenSIPS support for shared call appearances (SCA) as defined by BroadWorks SIP Access Side Extensions Interface specifications."
---

## Admin Guide


### Overview


This module provides OpenSIPS support for shared call appearances (SCA)
as defined by BroadWorks SIP Access Side Extensions Interface specifications.
The SCA mechanism is a fundamental building block for a variety of enhanced 
telephony services. Features like attendant console, line extensions,
and key system emulation cannot be delivered without some mechanism for
sharing call appearances across access devices. Although SIP (RFC 3261)
by itself offers no inherent semantics for supporting SCA features, when
coupled with an appropriate instantiation of the “SIP Specific Event Notification”
framework (RFC 3265), these services can be deployed quite easily in a 
distributed network.


A shared line is an address of record managed by central
controlling element, such as an application server. The application server 
allows multiple endpoints to register locations against the address of record.
The application server is responsible for policing who can register and who 
cannot register against the shared line.


The module enables the handling of "call-info" and "line-seize"
events inside the presence module. It is used with the general event
handling module: presence and it constructs and adds "Call-Info" headers
to notification events.


### Usage modes


The module can be used in two ways (depending on who is doing the
publishing of the "call-info" data:


- external publishing - the "call-info" data
is received from a third party via SIP PUBLISH requests. In this
mode, the modules simply distributes the SCA info, it is not 
producing any of it - a third-party application must publish 
"call-info" events to the presence server.
- internal publishing - the "call-info" data
is internally generated by the module, based on the information
received from the dialog module - what calls are using what 
line/index, what is the state of the call, etc. There is no SIP
PUBLISH in this case and there is no need for a third-party - 
the module is self-sufficient and stand alone as functionality.


The used mode can be controlled via the module parameter 
"disable_dialog_support_for_sca" - see below in the parameter's
section.


#### External publishing


The module does not currently implement any authorization
rules.  It assumes that publish requests are only issued by
a third-party application and subscribe requests only by
subscriber to call-info and line-seize events.  Authorization
can thus be easily done by OpenSIPS configuration file before
calling handle_publish() and handle_subscribe() functions.


To get better understanding on how the module works please take a
look at the follwing figure:


```c
   caller       proxy &   callee        watcher        publisher
alice@example  presence  bob@example  watcher@example
                 server                       
     |             |           |           |              |
     |             |<-----SUBSCRIBE bob----|              |
     |             |------200 OK---------->|              |
     |             |------NOTIFY---------->|              |
     |             |<-----200 OK-----------|              |
     |             |           |           |              |
     |--INV bob--->|           |           |              |
     |             |--INV bob->|           |              |
     |             |<-100------|           |              |
     |             |<-----PUBLISH(alerting)---------------|
     |             |------200 OK------------------------->|
     |             |------NOTIFY---------->|              |
     |             |<-----200 OK-----------|              |
     |             |           |           |              |
     |             |<-180 ring-|           |              |
     |<--180 ring--|           |           |              |
     |             |           |           |              |
     |             |           |           |              |
     |             |<-200 OK---|           |              |
     |<--200 OK----|           |           |              |
     |             |<-----PUBLISH(active)-----------------|
     |             |------200 OK------------------------->|
     |             |------NOTIFY---------->|              |
     |             |<-----200 OK-----------|              |
     |             |           |           |              |

			
```


- The watcher subscribes the "Event: dialog" of Bob.
- Alice calls Bob.
- The publisher is publishing the "alerting" state for Bob.
- PUBLISH is received and handled by presence module.
Presence module updates the "presentity".
Presence module checks for active watchers of the presentity.
The active watcher is notified via a NOTIFY SIP request.
- Bob answers the call.
- The publisher is publishing the "active" state for Bob.
- PUBLISH is received and handled by presence module.
Presence module updates the "presentity".
Presence module checks for active watchers of the presentity.
The active watcher is notified via a NOTIFY SIP request.


#### Internal publishing


In this mode, the module requires the "dialog" module to be
loaded into OpenSIPS. All the publishing will be automatically
done (the modules will exchange data directly via C API).


From presence perspective, the OpenSIPS script must be configured
to handle the SUBSCRIBE requests only (there is no need for PUBLISH
handling as there is no SIP publishing in this mode). So be sure
to use the "handle_subscribe()" function (from presence module) in
the script.


To trigger the internal publishing (from the dialog module) for a
certain call, use the "sca_set_calling_line()" or
"sca_set_called_line()" functions from the script when handling a
new call. These functions will do all the work (creating dialog, 
setting the internal publishing, etc) - you just need to use them
and eventually specify the name of the line (if other then the one
from the SIP INVITE) - see the below documentation.


LIMITATIONS : in this mode, the module does not really check if the
line exists or not (like defined) - it blindly trust the traffic;
also there is no check on how many indexes are for each line. Such
information (lines and indexes) are not provisioned into the module,
but the module will dynamically accept and handle any line and index
based on the SIP traffic.


### Dependencies


#### OpenSIPS Modules


The following modules must be loaded before this module:


- *presence*.
- *dialog*.


#### External Libraries or Applications


None.


### Exported Parameters


#### call_info_timeout_notification (int)


Enables or disables call_info event timeout notifications.


*Default value is "1"* (enabled).


```opensips title="Set call_info_timeout_notification parameter"
...
modparam("presence_callinfo", "call_info_timeout_notification", 0)
...
			
```


#### line_seize_timeout_notification (int)


Enables or disables line_seize event timeout notifications.


*Default value is "0"* (disabled).


```opensips title="Set line_seize_timeout_notification parameter"
...
modparam("presence_callinfo", "line_seize_timeout_notification", 1)
...
			
```


#### disable_dialog_support_for_sca (int)


Disables the internal publishing of the "call-info" events (generated by the dialog module).
The publishing is expected to be done via SIP PUBLISH from a third-party. See
the wroking mode described in the beginning of this document.


*Default value is "0"* (not disabled).


```opensips title="Set disable_dialog_support_for_sca parameter"
...
modparam("presence_callinfo", "disable_dialog_support_for_sca", 1)
...
			
```


#### line_hash_size (int)


Allows you to controll the size of the internal hash table used for storing the
information about the lines and indexes (in the internal publishing mode).


The value must be a power of 2. You may consider increasing the value if using
a large set of lines (>1000).


*Default value is "64"*.


```opensips title="Set line_hash_size parameter"
...
modparam("presence_callinfo", "line_hash_size", 128)
...
			
```


### Exported Functions


#### sca_set_calling_line([line])


The function (to be used only in internal publishing mode) is setting
for the current new call (initinal INVITE) the outbound line - the line
used for calling out.


If no parameter is provided, the name of the line is taken from the
SIP FROM header of the INVITE. You can override that by providing 
the name of the line as a string parameter - be careful as the value must be
a SIP URI !


This function can be used from REQUEST_ROUTE.


```opensips title="sca_set_calling_line() usage"
...
	if (is_method("INVITE") and !has_totag()) {
		sca_set_calling_line();
	}
...
```


#### sca_set_called_line([line])


The function (to be used only in internal publishing mode) is setting
for the current new call (initinal INVITE) the inbound line - the line
the call was received on.


If no parameter is provided, the name of the line is taken from the
SIP RURI of the INVITE. You can override that by providing 
the name of the line as a string parameter - be careful as the value must be
a SIP URI ! Variables are accepted.


This function can be used from REQUEST_ROUTE.


```opensips title="sca_set_called_line() usage"
...
	if (is_method("INVITE") and !has_totag()) {
		sca_set_called_line();
	}
...
```


### Exported MI Functions


#### presence_callinfo:list_lines


Replaces obsolete MI command: *sca_list_lines*.


Lists the SCA lines and indexes currently tracked by the module.


Parameters:


- *sca_line* (optional) - only list
information for this SCA line.


MI FIFO Command Format:


```bash
opensips-cli -x mi presence_callinfo:list_lines
opensips-cli -x mi presence_callinfo:list_lines sca_line=sip:line@example.com
```


#### presence_callinfo:release_line


Replaces obsolete MI command: *sca_release_line*.


Releases a tracked SCA line, a specific index from a line, or all
lines.


Parameters:


- *sca_line* - the SCA line to release;
use *ALL* to release all lines.
- *sca_index* (optional) - release only
this index from the selected line.


MI FIFO Command Format:


```bash
opensips-cli -x mi presence_callinfo:release_line sca_line=sip:line@example.com
opensips-cli -x mi presence_callinfo:release_line sca_line=sip:line@example.com sca_index=1
opensips-cli -x mi presence_callinfo:release_line sca_line=ALL
```


#### presence_callinfo:set_log_level


Replaces obsolete MI command: *sca_set_log_level*.


Gets or sets the SCA-specific log level used by this module.


Parameters:


- *log_level* (optional) - the new log
level. If missing, the command returns the current level.


MI FIFO Command Format:


```bash
opensips-cli -x mi presence_callinfo:set_log_level
opensips-cli -x mi presence_callinfo:set_log_level log_level=3
```
<!-- CONTRIBUTORS -->

### License

All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0
