This table is used by the ACC module for keeping track of missed calls. This table is similar to the 'acc' table. More information is available at: https://opensips.org/docs/modules/devel/acc.html
Table 1-1. Table "acc"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
unique ID
method
string
16
''
no
A method is the primary function that a request is meant to invoke on a server.
from_tag
string
64
''
no
The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
to_tag
string
64
''
no
The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
callid
string
64
''
no
Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
sip_code
string
3
''
no
SIP reply code
sip_reason
string
32
''
no
SIP reply reason
time
datetime
not specified
default
no
Date and time when this record was written.
duration
unsigned int
11
0
no
Call duration (from 200OK INVITE to BYE request) in seconds - this field is populated only if CDR support is enabled in ACC module (see cdr_flag parameter)
ms_duration
unsigned int
11
0
no
Call duration (from 200OK INVITE to BYE request) in milliseconds - this field is populated only if CDR support is enabled in ACC module (see cdr_flag parameter)
setuptime
unsigned int
11
0
no
Call initialization duration - (from INVITE request to 200 OK INVITE) - this filed is populated only if CDR support is enabled in ACC module (see cdr_flag parameter)
created
datetime
not specified
NULL
yes
The call creation date and time.
Table 1-2. Table "acc" indexes
name
type
links
description
callid_idx
default
callid
Table 1-3. Table "missed_calls"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
unique ID
method
string
16
''
no
A method is the primary function that a request is meant to invoke on a server.
from_tag
string
64
''
no
The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
to_tag
string
64
''
no
The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
callid
string
64
''
no
Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
sip_code
string
3
''
no
SIP reply code
sip_reason
string
32
''
no
SIP reply reason
time
datetime
not specified
default
no
Date and time when this record was written.
setuptime
unsigned int
11
0
no
Call initialization duration - (from INVITE request to reply) - this filed is populated only if CDR support is enabled in ACC module (see cdr_flag parameter)
The SIP Remote-Party-ID header identifies the calling party and includes user, party, screen and privacy headers that specify how a call is presented and screened.
This table is used by the Call Center module to store ongoing
calls for restart persitancy. It consists only of runtime data and
should not be manually provisioned.
More information can be found at: https://opensips.org/docs/modules/devel/call_center.html.
Table 9-1. Table "cc_flows"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Flow unique ID in DB
flowid
string
64
default
no
The unique ID of the flow in the
Call Center module - to be used to identify the
flow/queue in the module and from outside the module;
It is an alphanumerical string.
priority
unsigned int
11
256
no
The priority of the flow (in relation to
the other flows); 0 is maximum priority and calls for
this flow will be processed first all the time.
skill
string
64
default
no
The skill required from an agent in order
to receive calls from this flow/queue.
prependcid
string
32
NULL
yes
Aphanumerical prefix to be added to the
caller displayname when sending calls from this flow
to agents (so agent - serving muliple flows - can see
what was the flow the call was received on.
max_wrapup_time
unsigned int
11
0
no
The maximum warpup time (in seconds) allowed
for the call terminated via this flow. This value will
limit the default or per-agent wrapup time. A 0 value means
no limit/max defined.
dissuading_hangup
unsigned int
11
0
no
If set to true (non zero value), the calls diverted
to dissuading destination will be closed after the dissuading
terminates (useful when using a playback for dissuading).
dissuading_onhold_th
unsigned int
11
0
no
For how long (in seconds) a call will wait in the
queue before getting a dissuading redirect.
dissuading_ewt_th
unsigned int
11
0
no
The Estimated Waiting Time (in seconds) threshold that
will redirect a new incoming call (not queued yet) to the
dissuading destination.
dissuading_qsize_th
unsigned int
11
0
no
The Size of the Queue (as already waiting calls in this
flow) that will redirect a new incoming call (not queued yet) to the
dissuading destination.
message_welcome
string
128
NULL
yes
SIP URI point to a media server; this is
used for playing the welcome message for this
flow.
message_queue
string
128
default
no
SIP URI point to a media server; this is
used for playing the onhold message for this
flow. IMPORTANT - this message must cycle and media
server must never hung up on it.
message_dissuading
string
128
NULL
yes
SIP URI point to a media server; this is
used for playing the dissuading message for this
flow.
message_flow_id
string
128
NULL
yes
SIP URI point to a media server; this is
used for playing the name of the flow id to the agent
before delivering a call to him.
Table 9-2. Table "cc_flows" indexes
name
type
links
description
unique_flowid
unique
flowid
Table 9-3. Table "cc_agents"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Agent unique ID in DB
agentid
string
128
default
no
The unique ID of the agent in the
Call Center module - to be used to identify the
agent in the module and from outside the module;
It is an alphanumerical string.
location
string
128
default
yes
SIP URI point to the agent location;
All calls for this agents will be sent to this
SIP address.
logstate
unsigned int
10
0
no
The call login state of the agent;
0 - not logged in; 1 - logged in ; Agent will
start receiving calls only if logged in.
msrp_location
string
128
default
yes
MSRP SIP URI point to the agent location;
All chat sessions for this agents will be sent to this
SIP address.
msrp_max_sessions
unsigned int
10
4
no
How many MSRP/chat sessions the agent
can handle in the same time.
skills
string
255
default
no
Comma separated list of skills offered
by the agent; these skills must match the skills used
in the queues/flows definition; In order to receive
calls from a flow, the agent must have the skill required
by that flow.
wrapup_end_time
int
11
0
no
The timestamp when the last wrapup ends/ended for the
agent. If different than 0, the agent will only receive calls after
this timestamp.
wrapup_time
int
11
0
no
The duration in seconds needed by the agent to wrap
up the call he just completed. If set to 0, the global wraptup time
will be used for this agent.
Table 9-4. Table "cc_agents" indexes
name
type
links
description
unique_agentid
unique
agentid
Table 9-5. Table "cc_cdrs"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
CDR unique ID in DB
caller
string
64
default
no
The SIP URI identifing the caller.
received_timestamp
datetime
not specified
default
no
When the call was received.
wait_time
unsigned int
11
0
no
Time (in seconds) spent by the call
in queue (onhold).
pickup_time
unsigned int
11
0
no
Time (in seconds) spent by the call
in ringing to the agent.
talk_time
unsigned int
11
0
no
The duration (in seconds) of the call.
flow_id
string
128
default
no
The ID of the flow the call was
received on.
agent_id
string
128
NULL
yes
The ID of the agent who picked
this call (if any).
call_type
int
11
-1
no
Type of call: -2 - call rejected by agent;
-1 - call dropped because of internal error;
0 - call handled by agent;
1 - call dropped while in queue;
rejected
unsigned int
11
0
no
How many times the call was rejected by agents
(agent not answering his phone).
fstats
unsigned int
11
0
no
Bitmask of the following binary flags:
0 - it is inbound call;
1 - call was distributed to agents;
2 - call was answered;
3 - call was abandoned.
cid
unsigned int
11
0
yes
Sequence number of the call.
media
int
11
0
no
Media type of the call:
1 - RTP/audio;
2 - MSRP/chat;
Table 9-6. Table "cc_calls"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
unique ID of the call.
state
int
11
default
no
The state of the call.
media
int
11
default
no
Indicates the media type of the call,
(0) RTP/audio or (1) MSRP/chat.
ig_cback
int
11
default
no
Indicates if the call should be ignored.
no_rej
int
11
default
no
Indicates whether the call can be rejected or not.
setup_time
int
11
default
no
Stores the call setup time.
eta
int
11
default
no
The estimated wait time for a call until
it is answered by an agent.
last_start
int
11
default
no
Stores the timestamp when the last call has started.
recv_time
int
11
default
no
Stores the timestamp when the call was received by the
call center.
caller_dn
string
128
default
no
Caller Display Name.
caller_un
string
128
default
no
Caller User Name.
b2buaid
string
128
''
no
The B2B id internally used by the B2B module to identify
the call.
flow
string
128
default
no
The flow/queue this call belongs to.
agent
string
128
default
no
The agent that handles the call.
script_param
string
128
default
no
Parameter passed to the callcenter B2B logic scriptt.
This table is used by the closeddial module to provide closed dial functionality for groups of usernames; This is a functionality similar to a Centrex. More information about the closeddial module can be found at: https://opensips.org/docs/modules/devel/closeddial.html
The tag parameter serves as a general mechanism to
identify a dialog, which is the combination of the Call-ID along
with two tags, one from participant in the dialog.
to_uri
string
255
default
no
The URI of the TO header (as per INVITE)
to_tag
string
64
default
no
The tag parameter serves as a general mechanism to
identify a dialog, which is the combination of the Call-ID along
with two tags, one from participant in the dialog.
mangled_from_uri
string
64
NULL
yes
The mangled from URI, in case uac_replace_from
was called for this dialog.
mangled_to_uri
string
64
NULL
yes
The mangled to URI, in case uac_replace_to
was called for this dialog
caller_cseq
string
11
default
no
Last Cseq number on the caller side.
callee_cseq
string
11
default
no
Last Cseq number on the callee side.
caller_ping_cseq
unsigned int
11
default
no
Last Cseq number of pings generated on caller side.
callee_ping_cseq
unsigned int
11
default
no
Last Cseq number of pings generated on callee side.
caller_route_set
text
512
default
yes
Route set on the caller side.
callee_route_set
text
512
default
yes
Route set on on the caller side.
caller_contact
string
255
default
yes
Caller's contact uri.
callee_contact
string
255
default
yes
Callee's contact uri.
caller_sock
string
64
default
no
Local socket used to communicate with caller
callee_sock
string
64
default
no
Local socket used to communicate with callee
state
unsigned int
10
default
no
The state of the dialog.
start_time
unsigned int
10
default
no
The timestamp (unix time) when the dialog was confirmed.
timeout
unsigned int
10
default
no
The timestamp (unix time) when the dialog will expire.
vars
binary
4096
NULL
yes
Variables attached to this dialog.
profiles
text
512
NULL
yes
Profiles this dialog belongs to.
script_flags
string
255
NULL
yes
Script flags for the dialog.
module_flags
unsigned int
10
0
no
Module flags for the dialog.
flags
unsigned int
10
0
no
Internal flags used by the module.
rt_on_answer
string
64
NULL
yes
The name of the script route to be executed
upon call answering
rt_on_timeout
string
64
NULL
yes
The name of the script route to be executed
upon call timeout (as duration)
rt_on_hangup
string
64
NULL
yes
The name of the script route to be executed
upon call hangup
This table is used by the dispatcher module. It contains the sets of destinations used for load balancing and dispatching. More information about the dispatcher module can be found at: https://opensips.org/docs/modules/devel/dispatcher.html
Table 16-1. Table "dispatcher"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
unique ID
setid
int
not specified
0
no
Destination set id
destination
string
192
''
no
Destination SIP address
socket
string
128
NULL
yes
Local Socket to be used when sending requests (traffic and probes)
to the destination - must be an listener configured in opensips.
state
int
not specified
0
no
The state of the destination (0 enabled, 1 disabled , 2 probing)
probe_mode
unsigned int
11
0
no
0-Probe only when in probing state; 1-Probe even in enable/active state;
weight
string
64
1
no
The weight of the destination (integer or socket definition)
priority
int
not specified
0
no
The priority of each destination (only useful with algorithm 8)
attrs
string
128
''
no
Attribute string - custom, opaque string that
will be pushed into script when this destination will
be selected
This table is used by the domain module to determine if a host part of a URI is "local" or not. More information about the domain module can be found at: https://opensips.org/docs/modules/devel/domain.html
Domain policy rule name which is equal to the URI as published in the domain policy NAPTRs.
type
string
255
default
no
Domain policy rule type. In the case of federation names, this is "fed". For standard referrals according to draft-lendl-speermint-technical-policy-00, this is "std". For direct domain lookups, this is "dom". Default value is "type".
att
string
255
default
yes
It contains the AVP's name. If the rule stored in this row triggers, than dp_can_connect() will add an AVP with that name.
val
string
128
default
yes
It contains the values for AVPs created by dp_can_connect(). Default value is "val"
This table is used by the Dynamic Routing module to store
information about the destinations/gateways where to route calls.
More information can be found at: https://opensips.org/docs/modules/devel/drouting.html.
This table is used by the Dynamic Routing module to define
carriers (a carrier is defined by a list of gateways and an ordering
rule).
More information can be found at: https://opensips.org/docs/modules/devel/drouting.html.
This table is used by the Dynamic Routing module to store
information about the partitions used in routing (url to database,
table names and AVP names for each partition).
More information can be found at: https://opensips.org/docs/modules/devel/drouting.html.
Table 19-1. Table "dr_gateways"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Table primary key, not used by module
gwid
string
64
default
no
GW unique ID - used to link the GW from
the routing rules
type
unsigned int
11
0
no
Type/class of the GW (user defined)
address
string
128
default
no
GW/destination address as name/IP[:port]
strip
unsigned int
11
0
no
Number of digits to be striped out for the beginning
of the username when using this GW/destination
pri_prefix
string
16
NULL
yes
String to prefix the username of RURI when using
this GW/destination
attrs
string
255
NULL
yes
Generic string describing GW attributes - this string is
to be interpreted from the script
probe_mode
unsigned int
11
0
no
0- No probing; 1-Probe on disable only ; 2-Always probe;
state
unsigned int
11
0
no
State of the gateway: 0 - enabled; 1 - permanent disabled;
2 - temporary disabled (probing)
socket
string
128
NULL
yes
Local Socket to be used when sending requests (traffic and probes)
to the destination - must be an listener configured in opensips.
description
string
128
NULL
yes
Text description of the GW/destination
Table 19-2. Table "dr_gateways" indexes
name
type
links
description
dr_gw_idx
unique
gwid
Table 19-3. Table "dr_rules"
name
type
size
default
null
key
extra attributes
description
ruleid
unsigned int
10
default
no
primary
autoincrement
Rule unique ID
groupid
string
255
default
no
The ID(s) of the routing group(s) this rule is to be
used for - comma separeted list of numerical Ids
prefix
string
64
default
no
Numerical prefix to match this rule
timerec
string
255
NULL
yes
Time recurrence used for matching this rule.
priority
int
11
0
no
Priority of this rule (among rules with same prefix
and timerec).
routeid
string
255
NULL
yes
Route block (from cfg script) to be called when rule
matches.
gwlist
string
255
default
yes
A comma-separated list of GW unique IDs (e.g. GW-5)
and/or hash-prefixed ("#") Carrier unique IDs (e.g. #CR-2).
sort_alg
string
1
'N'
no
The sorting algorithm to be employed for the rule's
destinations when do_routing() is called. Possible values:
'N' (default; no sorting, preserve given order),
'W' (weight based sorting),
'Q' (quality-based sorting, provided by the qrouting module)
sort_profile
unsigned int
10
NULL
yes
Whenever the 'Q' (quality-based routing) sorting algorithm
is provided, this column must hold a profile id belonging to the
"qr_profiles" table.
attrs
string
255
NULL
yes
Generic string describing RULE attributes - this string is
to be interpreted from the script
description
string
128
NULL
yes
Text description of the rule
Table 19-4. Table "dr_carriers"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Table key, not used by module
carrierid
string
64
default
no
Unique ID of the carrier
gwlist
string
255
default
no
A comma-separated list of GW unique IDs (e.g. GW-5).
flags
unsigned int
11
0
no
Flags of the carriers (for different purposes:
use only first gw from cr (set the first bit of the flag);
disable gateway (set the second bit of the flag);
sort_alg
string
1
'N'
no
The sorting algorithm to be employed for the carrier's
destinations when do_routing() is called. Possible values:
'N' (default; no sorting, preserve given order),
'W' (weight based sorting),
'Q' (quality-based sorting, provided by the qrouting module)
state
unsigned int
11
0
no
The state of the carrier (on / off).
attrs
string
255
NULL
yes
Attributes string for the carrier
description
string
128
NULL
yes
Text description of the GW list
Table 19-5. Table "dr_carriers" indexes
name
type
links
description
dr_carrier_idx
unique
carrierid
Table 19-6. Table "dr_groups"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Unique ID
username
string
64
default
no
Username part of user
domain
string
128
NULL
yes
Domain part of user
groupid
unsigned int
11
0
no
The ID of the routing group the user belongs to.
description
string
128
NULL
yes
Text description of the group/user
Table 19-7. Table "dr_partitions"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Partition unique ID
partition_name
string
255
default
no
The name of the partition.
db_url
string
255
default
no
The url to the database containing the tables: dr_rules, dr_groups,
dr_carriers and dr_gateways
drd_table
string
255
default
yes
The name of the dr_gateways table in the given database (for the given partition).
drr_table
string
255
default
yes
The name of the dr_rules table in the given database (for the given partition).
drg_table
string
255
default
yes
The name of the dr_groups table in the given database (for the given partition).
drc_table
string
255
default
yes
The name of the dr_carriers table in the given database (for the given partition).
This table is used by the Emergency module to save information associated
with a emergency call, for trouble shooting purposes.
More information can be found at: https://opensips.org/docs/modules/devel/emergency.html.
This table is used by the Emergency module to store information of the organizations involved
in the routing of the emergency call, this information is necessary to send the request to the VPC,
according to the NENA standard.
This table isn't necessary if opensips role not send request to VPC, such as the opensips acting as call server in the scenarios II and III.
More information can be found at: https://opensips.org/docs/modules/devel/emergency.html.
Table 20-1. Table "emergency_routing"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Unique ID
selectiveRoutingID
string
11
default
no
The Common Language Location Indicator(CLLI) code associated
with the Selective Router to which the emergency call is to be directed
routingESN
unsigned int
5
0
no
The Emergency Services Number associated with a particular ESZ
that respresents a unique combination of Police, Fire and EMS emergency responders.
npa
unsigned int
3
0
no
The primary Numbering Plan Area (NPA) associated with
the outgoing route to the Selective Router that is appropriate for
caller's location.
esgwri
string
50
default
no
Routing information used to direct the call to the ESGW.
Table 20-2. Table "emergency_report"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Unique ID
callid
string
25
default
no
header that uniquely identifies the call.
selectiveRoutingID
string
11
default
no
The Common Language Location Indicator(CLLI) code associated
with the Selective Router to which the emergency call is to be directed
routingESN
unsigned int
5
0
no
The Emergency Services Number associated with a particular ESZ
that respresents a unique combination of Police, Fire and EMS emergency responders.
npa
unsigned int
3
0
no
The primary Numbering Plan Area (NPA) associated with
the outgoing route to the Selective Router that is appropriate for
caller's location.
esgwri
string
50
default
no
Routing information used to direct the call to the ESGW.
lro
string
20
default
no
last routing option destination for the call.
VPC_organizationName
string
50
default
no
company name or other label of the VPC that provided the routing information.
VPC_hostname
string
50
default
no
identifies the fully qualified domain name or IP address
of the VPC that provided routing information.
VPC_timestamp
string
30
default
no
Date Time Stamp indicating UTC date and time that the message was sent from VPC.
result
string
4
default
no
Code indicating the reason for success or failure to determine an ERT/ESGWRI and ESQK.
disposition
string
10
default
no
Describe how routing of call was done(e.g.,by ESGWRI or bye LRO)
Table 20-3. Table "emergency_service_provider"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Unique ID
organizationName
string
50
default
no
provider company name's. This parameter is optional
field in the NENA v2 interface (call server - VPC)
hostId
string
30
default
no
provider hostname's. This parameter is mandatory if
attribution is 0(source) or 2(VSP), otherwise it is optional.
nenaId
string
50
default
no
the NENA administered company identifier (NENA Company ID) of provider.
This parameter is optional field in the NENA v2 interface (call server - VPC).
contact
string
20
default
no
telephone number by which the provider operator can be reached 24 hours a day, 7 days a week.
This parameter is mandatory if attribution is 0(source) or 2(VSP), otherwise it is optional.
certUri
string
50
default
no
provides a means of directly obtaining the VESA(Valid Emergency Services Authority) issued certificate for the provider.
This parameter is optional field in the NENAÂ v2 interface (call server - VPC).
nodeIP
string
20
default
no
IP address of the node that is being registered. This parameter is mandatory.
attribution
unsigned int
2
default
no
It is a field of type int designating the function of the organization involved in the composition of architecture NENA being registered in this table. This parameter is mandatory.Â
The values that this field can take are:
0 - the organization is a Source. Source is node directly requesting emergency call routing from the VPC.
1 - the organization is a VPC. VPC is the routing information provider to emengency call
2- the organization is a VSP. VSP is the caller's voice service provider
This table us used by the group module as a means of group membership checking. Used primarily for Access Control Lists (ACL's). More information about the group module can be found at: https://opensips.org/docs/modules/devel/group.html
The group ID - each address may belong to a group/set
ip
string
50
default
no
IP address, IPv4 or IPv6 format
mask
char
not specified
32
no
Network mask, a number from 0 to 128; It should be up to 32 if the IP is v4 and up to 128 if the IP is v6
port
unsigned short
5
0
no
Port number, 0 value meaning 'any' (wildcard)
proto
string
4
'any'
no
Transport protocol is either "any" or equal to transport protocol of request. Possible values that can be stored are "any", "udp", "tcp", "tls", and "sctp".
pattern
string
64
NULL
yes
A shell wildcard pattern to be used for matching string provided by the check address functions.
context_info
string
32
NULL
yes
Extra context information, not used by OpenSIPS, but simply exposed to the script level via scripting variables
This table is used by the Quality Routing module to store
information about the thresholds for warnings and disabling destinations. A profile is
associated with a drouting rule.
More information can be found at: https://opensips.org/docs/modules/devel/qrouting.html.
Table 29-1. Table "qr_profiles"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Table primary key
profile_name
string
64
default
no
The name of the profile
warn_threshold_asr
double
not specified
-1
no
The warning threshold for answer seizure ratio
warn_threshold_ccr
double
not specified
-1
no
The warning threshold for call completion ratio
warn_threshold_pdd
double
not specified
-1
no
The warning threshold for post dial delay
warn_threshold_ast
double
not specified
-1
no
The warning threshold for average setup time
warn_threshold_acd
double
not specified
-1
no
The warning threshold for average call duration
crit_threshold_asr
double
not specified
-1
no
The critical threshold for answer seizure ratio
crit_threshold_ccr
double
not specified
-1
no
The critical threshold for call completion ratio
crit_threshold_pdd
double
not specified
-1
no
The critical threshold for post dial delay
crit_threshold_ast
double
not specified
-1
no
The critical threshold for average setup time
crit_threshold_acd
double
not specified
-1
no
The critical threshold for average call duration
warn_penalty_asr
double
not specified
0.5
no
Traffic volume reduction when ASR falls below warn limit
warn_penalty_ccr
double
not specified
0.5
no
Traffic volume reduction when CCR falls below warn limit
warn_penalty_pdd
double
not specified
0.5
no
Traffic volume reduction when PDD falls below warn limit
warn_penalty_ast
double
not specified
0.5
no
Traffic volume reduction when AST falls below warn limit
warn_penalty_acd
double
not specified
0.5
no
Traffic volume reduction when ACD falls below warn limit
crit_penalty_asr
double
not specified
0.05
no
Traffic volume reduction when ASR falls below crit limit
crit_penalty_ccr
double
not specified
0.05
no
Traffic volume reduction when CCR falls below crit limit
crit_penalty_pdd
double
not specified
0.05
no
Traffic volume reduction when PDD falls below crit limit
crit_penalty_ast
double
not specified
0.05
no
Traffic volume reduction when AST falls below crit limit
crit_penalty_acd
double
not specified
0.05
no
Traffic volume reduction when ACD falls below crit limit
Password for authentication. If the password
starts with 0x and is an MD5 hash, then
it is considered to be the HA1 representation of the hash.
Otherwise, it is considered to be plain text.
binding_URI
string
255
''
no
Contact URI in REGISTER.
binding_params
string
64
NULL
yes
Contact params in REGISTER.
expiry
unsigned int
1
NULL
yes
Expiration time.
forced_socket
string
64
NULL
yes
socket for sending the REGISTER.
cluster_shtag
string
64
NULL
yes
A cluster sharing tag (as [tag_name/custer_id]) used to control this registration in clustering scenarios
state
int
not specified
0
no
The state of the registrant (0 enabled, 1 disabled)
This table is used to provision Short Message Service Center (SMSC)
information to connect to over the SMPP (Short Message Peer-to-Peer).
More information can be found at: https://opensips.org/docs/modules/devel/proto_smpp.html.
Table 35-1. Table "smpp"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Unique ID
name
string
255
default
no
An arbitrary name of the SMSC, used to uniquely identify the binding.
ip
string
50
default
no
The IP address used to connect to the SMSC.
port
unsigned int
5
default
no
The port used to connect to the SMSC.
system_id
string
16
default
no
The System ID (also called user name) for the gateway
to use when connecting to the SMPP server.
password
string
9
default
no
The password for the gateway to use when connecting to
the SMPP server.
system_type
string
13
''
no
Configures the System Type parameter of the
the SMPP server.
src_ton
unsigned int
not specified
0
no
Specifies the Source TON (Type of Number).
src_npi
unsigned int
not specified
0
no
Specifies the Source NPI (Numbering Plan Indicator).
dst_ton
unsigned int
not specified
0
no
Specifies the Destination TON (Type of Number).
dst_npi
unsigned int
not specified
0
no
Specifies the Destination NPI (Numbering Plan Indicator).
session_type
unsigned int
not specified
1
no
Specifies the type of binding: 1 - transciever,
2 - transmitter, 3 - receiver, 4 - outbind.
This table is used for defining TCP connection profiles.
Table 38-1. Table "tcp_mgm"
name
type
size
default
null
key
extra attributes
description
id
unsigned int
10
default
no
primary
autoincrement
Unique DB ID
proto
string
8
'any'
no
Restrict this profile to a specific OpenSIPS supported protocol.
remote_addr
string
43
NULL
yes
Remote network address in "ip[/prefix_length]" format, or the special values NULL or "any", which will both match any remote IPv4 or IPv6 address.
remote_port
unsigned int
not specified
0
no
Remote network port. A value of 0 will match any remote port.
local_addr
string
43
NULL
yes
Local network address in "ip[/prefix_length]" format, or the special values NULL or "any", which will both match any of the OpenSIPS network listeners.
local_port
unsigned int
not specified
0
no
Local network port. A value of 0 will match any OpenSIPS listening port.
priority
int
not specified
0
no
By default, higher network prefix lengths will match first. The priority field can be used to override this behavior, with lower priority rules being attempted first.
attrs
string
255
NULL
yes
A URI params string with various TCP-connection related flags or properties pertaining to specific OpenSIPS modules or areas of code.
connect_timeout
unsigned int
not specified
100
no
Time in milliseconds before an ongoing blocking TCP connect attempt is aborted. Default: 100 ms.
con_lifetime
unsigned int
not specified
120
no
Time in seconds with no READ or WRITE events on a TCP connection before it is destroyed. Default: 120 s.
msg_read_timeout
unsigned int
not specified
4
no
The maximum number of seconds that a complete SIP message is expected to arrive via TCP. Default: 4 s.
send_threshold
unsigned int
not specified
0
no
The maximum number of microseconds that sending a TCP request can take. Send latencies above this threshold will trigger a logging warning. A value of 0 disables the check. Default: 0 us.
no_new_conn
unsigned int
not specified
0
no
Set this to 1 in order to instruct OpenSIPS to never open connections to the "remote" side. This may be useful when there is a NAT firewall in-between, so only remote->local connections are possible. Default: 0.
alias_mode
unsigned int
not specified
0
no
Controls TCP connection reusage for requests in the opposite direction to the original one. 0 (never reuse), 1 (only reuse if RFC 5923 Via ";alias" is present), 2 (always reuse). Default: 0.
parallel_read
unsigned int
not specified
0
no
Set to 1 to re-balance a TCP connection for reading after a worker processes one packet. Set to 2 in order to have proto modules re-balance a TCP conn for reading before processing a fully read packet, but only if they have support for this (e.g. proto_tcp). Default: 0 (lock a connection in a TCP reader process for "tcp_con_lifetime" seconds at a time).
keepalive
unsigned int
not specified
1
no
Set to 0 in order to disable TCP keepalives at Operating System level. Default: 1 (enabled).
keepcount
unsigned int
not specified
9
no
Number of keepalives to send before closing the connection. Default: 9.
keepidle
unsigned int
not specified
7200
no
Amount of time, in seconds, before OpenSIPS will start to send keepalives if the connection is idle. Default: 7200.
keepinterval
unsigned int
not specified
75
no
Interval in seconds between successive (failed) keepalive probes. Default: 75.
TLS domain name, uniquely identifies a client or server domain
match_ip_address
string
255
NULL
yes
network address in "ip:port" format, or the wildcard value "*", used to match connections with a tls domain
match_sip_domain
string
255
NULL
yes
FQDN used to match connections with a tls domain
type
int
1
1
no
type of the domain : client domain(1), server domain (2) or both (0); 0 can be used only for default domains when the same specification is desired for both client and server
method
string
16
'SSLv23'
yes
SSL method used by a certain domain
verify_cert
int
1
1
yes
verify certificate: 0 - no, 1 - yes
require_cert
int
1
1
yes
require certificate: 0 - no, 1 - yes
certificate
binary
not specified
default
yes
certificate associated with a certain domain
private_key
binary
not specified
default
yes
private_key
crl_check_all
int
1
0
yes
check all crl: 0 -no, 1 - yes
crl_dir
string
255
NULL
yes
crl directory
ca_list
binary
not specified
NULL
yes
CA list
ca_dir
string
255
NULL
yes
ca directory
cipher_list
string
255
NULL
yes
the list of algorithms used for authentication and encryption allowed
dh_params
binary
not specified
NULL
yes
specifies the Diffie-Hellmann parameters
ec_curve
string
255
NULL
yes
specifies an elliptic curve which should be used for
ciphers which demand an elliptic curve
