Pages for other versions: devel 3.5 3.4 Older versions: 3.3 3.2 3.1 3.0 2.4 2.3 2.2 2.1 1.11 1.10 1.9 1.8 1.7 1.6 1.5 1.4
DB Schema v2.2 |
Prev | Next |
OpenSIPS database tables
- Table of Contents
- 1. Accounting
- 2. alias db
- 3. Subscriber
- 4. AVP Operations
- 5. B2BUA
- 6. SCA support
- 7. CacheDB_SQL
- 8. Call Center
- 9. carrierroute
- 10. Accounting
- 11. Clusterer support
- 12. Call-processing language
- 13. Dialog support
- 14. Matching and translation rules
- 15. Dispatcher
- 16. Domain
- 17. Domainpolicy
- 18. Dynamic Routing
- 19. Emergency
- 20. Extensions
- 21. Fraud Detection
- 22. Group checking
- 23. Instant Message Conference
- 24. Load Balancer
- 25. Message Storage
- 26. Permissions
- 27. Presence
- 28. Registrant support
- 29. Registrar
- 30. RLS
- 31. RTPProxy
- 32. SIPtrace
- 33. Speed dial
- 34. Version
- 35. TLS_MGM support
- 36. SIP URI checks
- 37. User and global blacklists
- 38. User location
- List of Tables
- 1-1. Table "acc"
- 1-2. Table "acc" indexes
- 1-3. Table "missed_calls"
- 1-4. Table "missed_calls" indexes
- 2-1. Table "dbaliases"
- 2-2. Table "dbaliases" indexes
- 3-1. Table "subscriber"
- 3-2. Table "subscriber" indexes
- 4-1. Table "usr_preferences"
- 4-2. Table "usr_preferences" indexes
- 5-1. Table "b2b_entities"
- 5-2. Table "b2b_entities" indexes
- 5-3. Table "b2b_logic"
- 5-4. Table "b2b_logic" indexes
- 6-1. Table "b2b_sca"
- 6-2. Table "b2b_sca" indexes
- 7-1. Table "cachedb"
- 8-1. Table "cc_flows"
- 8-2. Table "cc_flows" indexes
- 8-3. Table "cc_agents"
- 8-4. Table "cc_agents" indexes
- 8-5. Table "cc_cdrs"
- 8-6. Table "cc_calls"
- 8-7. Table "cc_calls" indexes
- 9-1. Table "carrierroute"
- 9-2. Table "carrierfailureroute"
- 9-3. Table "route_tree"
- 10-1. Table "closeddial"
- 10-2. Table "closeddial" indexes
- 11-1. Table "clusterer"
- 11-2. Table "clusterer" indexes
- 12-1. Table "cpl"
- 12-2. Table "cpl" indexes
- 13-1. Table "dialog"
- 14-1. Table "dialplan"
- 15-1. Table "dispatcher"
- 16-1. Table "domain"
- 16-2. Table "domain" indexes
- 17-1. Table "domainpolicy"
- 17-2. Table "domainpolicy" indexes
- 18-1. Table "dr_gateways"
- 18-2. Table "dr_gateways" indexes
- 18-3. Table "dr_rules"
- 18-4. Table "dr_carriers"
- 18-5. Table "dr_carriers" indexes
- 18-6. Table "dr_groups"
- 18-7. Table "dr_partitions"
- 19-1. Table "emergency_routing"
- 19-2. Table "emergency_report"
- 19-3. Table "emergency_service_provider"
- 21-1. Table "fraud_detection"
- 22-1. Table "grp"
- 22-2. Table "grp" indexes
- 22-3. Table "re_grp"
- 22-4. Table "re_grp" indexes
- 23-1. Table "imc_rooms"
- 23-2. Table "imc_rooms" indexes
- 23-3. Table "imc_members"
- 23-4. Table "imc_members" indexes
- 24-1. Table "load_balancer"
- 24-2. Table "load_balancer" indexes
- 25-1. Table "silo"
- 25-2. Table "silo" indexes
- 26-1. Table "address"
- 27-1. Table "presentity"
- 27-2. Table "presentity" indexes
- 27-3. Table "active_watchers"
- 27-4. Table "active_watchers" indexes
- 27-5. Table "watchers"
- 27-6. Table "watchers" indexes
- 27-7. Table "xcap"
- 27-8. Table "xcap" indexes
- 27-9. Table "pua"
- 27-10. Table "pua" indexes
- 28-1. Table "registrant"
- 28-2. Table "registrant" indexes
- 29-1. Table "aliases"
- 29-2. Table "aliases" indexes
- 30-1. Table "rls_presentity"
- 30-2. Table "rls_presentity" indexes
- 30-3. Table "rls_watchers"
- 30-4. Table "rls_watchers" indexes
- 31-1. Table "rtpproxy_sockets"
- 32-1. Table "sip_trace"
- 32-2. Table "sip_trace" indexes
- 33-1. Table "speed_dial"
- 33-2. Table "speed_dial" indexes
- 34-1. Table "version"
- 34-2. Table "version" indexes
- 35-1. Table "tls_mgm"
- 36-1. Table "uri"
- 36-2. Table "uri" indexes
- 37-1. Table "userblacklist"
- 37-2. Table "userblacklist" indexes
- 37-3. Table "globalblacklist"
- 37-4. Table "globalblacklist" indexes
- 38-1. Table "location"
- 38-2. Table "location" indexes
Chapter 1. Accounting
- acc
This table is used by the ACC module to report on transactions - accounted calls. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/acc.html
- missed_calls
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: http://www.opensips.org/html/docs/modules/2.2.x/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-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)
created
datetime
not specified
NULL yes The call creation date and time.
Chapter 2. alias db
- dbaliases
This table us used by the alias_db module as an alternative for user aliases via userloc. More information about the alias_db module can be found at: http://www.opensips.org/html/docs/modules/2.2.x/alias_db.html
Table 2-1. Table "dbaliases"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
alias_username
string
64
'' no Alias username / phone number
alias_domain
string
64
'' no Alias domain name
username
string
64
'' no Username / phone number
domain
string
64
'' no Domain name
Chapter 3. Subscriber
- subscriber
This table is used to provide authentication information. More information about the auth_db module can be found at: http://www.opensips.org/html/docs/modules/2.2.x/auth_db.html
Table 3-1. Table "subscriber"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
username
string
64
'' no Username / phone number
domain
string
64
'' no Domain name
password
string
25
'' no Password
email_address
string
64
'' no Email address
ha1
string
64
'' no md5(username:realm:password)
ha1b
string
64
'' no md5(username@domain:realm:password)
rpid
string
64
NULL yes 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.
Chapter 4. AVP Operations
- usr_preferences
This table us used by the avpops module to implement Attribute Value Pairs (AVP's). More information about the avpops module can be found at: http://www.opensips.org/html/docs/modules/2.2.x/avpops.html
Table 4-1. Table "usr_preferences"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
uuid
string
64
'' no Unique user ID
username
string
128
0 no Username / phone number
domain
string
64
'' no Domain name
attribute
string
32
'' no AVP attribute
type
int
11
0 no AVP type
value
string
128
'' no AVP value
last_modified
datetime
not specified
'1900-01-01 00:00:01' no Date and time when this record was last modified.
Chapter 5. B2BUA
- b2b_entities
Table for the b2b_entities module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/b2b_entities.html
- b2b_logic
Table for the b2b_logic module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/b2b_logic.html
Table 5-1. Table "b2b_entities"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
type
int
2
default no Entity type: 0-server, 1-client
state
int
2
default no Dialog state
ruri
string
128
default yes RURI(stored only for server entities to correctly match CANCEL)
from_uri
string
128
default no From URI
to_uri
string
128
default no To URI
from_dname
string
64
default yes From display name
to_dname
string
64
default yes To display name
tag0
string
64
default no TO tag
tag1
string
64
default yes From tag
callid
string
64
default no Call ID
cseq0
int
11
default no Cseq0
cseq1
int
11
default yes Cseq1
contact0
string
128
default no Contact0
contact1
string
128
default yes Contact1
route0
text
not specified
default yes Record route 0
route1
text
not specified
default yes Record route 1
sockinfo_srv
string
64
default yes Socket Info
param
string
128
default no Logic parameter
lm
int
11
default no Last method
lrc
int
11
default yes Last reply code
lic
int
11
default yes Last invite cseq
leg_cseq
int
11
default yes Leg cseq
leg_route
text
not specified
default yes Leg route
leg_tag
string
64
default yes Leg tag
leg_contact
string
128
default yes Leg contact
leg_sockinfo
string
128
default yes Leg sockinfo
Table 5-2. Table "b2b_entities" indexes
name type links description b2b_entities_idx
unique type, tag0, tag1, callid
b2b_entities_param
default param
Table 5-3. Table "b2b_logic"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
si_key
string
64
default no Scenario instantiation key
scenario
string
64
default yes Scenario id
sstate
int
2
default no Scenario State
next_sstate
int
2
default no Next Scenario State
sparam0
string
64
default yes Scenario id
sparam1
string
64
default yes Scenario id
sparam2
string
64
default yes Scenario id
sparam3
string
64
default yes Scenario id
sparam4
string
64
default yes Scenario id
sdp
text
64
default yes Scenario id
lifetime
int
10
0 no Lifetime
e1_type
int
2
default no E1 type
e1_sid
string
64
default yes E1 Scenario ID
e1_from
string
128
default no E1 From URI
e1_to
string
128
default no E1 To URI
e1_key
string
64
default no E1 Key
e2_type
int
2
default no E2 type
e2_sid
string
64
default yes E2 Scenario ID
e2_from
string
128
default no E2 From URI
e2_to
string
128
default no E2 To URI
e2_key
string
64
default no E2 Key
e3_type
int
2
default yes E3 type
e3_sid
string
64
default yes E3 Scenario ID
e3_from
string
128
default yes E3 From URI
e3_to
string
128
default yes E3 To URI
e3_key
string
64
default yes E3 Key
Chapter 6. SCA support
- b2b_sca
Persistent sca information for the b2b_sca module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/b2b_sca.html
Table 6-1. Table "b2b_sca"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
shared_line
string
64
default no The shared line.
watchers
string
255
default no The URI list of watchers
app1_shared_entity
unsigned int
1
NULL yes The entity to keep.
app1_call_state
unsigned int
1
NULL yes The state of the appearance index.
app1_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app1_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app1_b2bl_key
string
64
NULL yes The b2b_logic key.
app2_shared_entity
unsigned int
1
NULL yes The entity to keep.
app2_call_state
unsigned int
1
NULL yes The state of the appearance index.
app2_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app2_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app2_b2bl_key
string
64
NULL yes The b2b_logic key.
app3_shared_entity
unsigned int
1
NULL yes The entity to keep.
app3_call_state
unsigned int
1
NULL yes The state of the appearance index.
app3_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app3_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app3_b2bl_key
string
64
NULL yes The b2b_logic key.
app4_shared_entity
unsigned int
1
NULL yes The entity to keep.
app4_call_state
unsigned int
1
NULL yes The state of the appearance index.
app4_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app4_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app4_b2bl_key
string
64
NULL yes The b2b_logic key.
app5_shared_entity
unsigned int
1
NULL yes The entity to keep.
app5_call_state
unsigned int
1
NULL yes The state of the appearance index.
app5_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app5_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app5_b2bl_key
string
64
NULL yes The b2b_logic key.
app6_shared_entity
unsigned int
1
NULL yes The entity to keep.
app6_call_state
unsigned int
1
NULL yes The state of the appearance index.
app6_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app6_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app6_b2bl_key
string
64
NULL yes The b2b_logic key.
app7_shared_entity
unsigned int
1
NULL yes The entity to keep.
app7_call_state
unsigned int
1
NULL yes The state of the appearance index.
app7_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app7_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app7_b2bl_key
string
64
NULL yes The b2b_logic key.
app8_shared_entity
unsigned int
1
NULL yes The entity to keep.
app8_call_state
unsigned int
1
NULL yes The state of the appearance index.
app8_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app8_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app8_b2bl_key
string
64
NULL yes The b2b_logic key.
app9_shared_entity
unsigned int
1
NULL yes The entity to keep.
app9_call_state
unsigned int
1
NULL yes The state of the appearance index.
app9_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app9_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app9_b2bl_key
string
64
NULL yes The b2b_logic key.
app10_shared_entity
unsigned int
1
NULL yes The entity to keep.
app10_call_state
unsigned int
1
NULL yes The state of the appearance index.
app10_call_info_uri
string
128
NULL yes The URI of the Call-Info header
app10_call_info_appearance_uri
string
128
NULL yes The URI of the appearance in Call-Info header
app10_b2bl_key
string
64
NULL yes The b2b_logic key.
Chapter 7. CacheDB_SQL
- cachedb
DB implementation of the CacheDB interface: http://www.opensips.org/html/docs/modules/2.2.x/cachedb_sql.html
Chapter 8. Call Center
- cc_flows
This table is used by the Call Center module to store the definition of the call queues / flows. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/call_center.html.
- cc_agents
This table is used by the Call Center module to store the definition of the agents serving the flows/queues. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/call_center.html.
- cc_cdrs
This table is used by the Call Center module to store the Call Data Records (CDRs) for all the handled calls. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/call_center.html.
- cc_calls
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: http://www.opensips.org/html/docs/modules/2.2.x/call_center.html.
Table 8-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
default no 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.
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.
Table 8-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 no 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 login state of the agent; 0 - not logged in; 1 - logged in ; Agent will start receiving calls only if logged in.
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.
last_call_end
int
11
0 no The timestamp of the last call of an agent. If different than 0, the agent will only receive calls after wrapup seconds pass after this timestamp.
Table 8-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.
Table 8-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.
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.
Chapter 9. carrierroute
- carrierroute
This table is used by the carrierroute module to provides routing, balancing and blacklisting capabilities. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/carrierroute.html
- carrierfailureroute
This table is used by the carrierroute module to provide failure routing capabilities. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/carrierroute.html
- route_tree
This table is used by the carrierroute module to provides routing, balancing and blacklisting capabilities. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/carrierroute.html
Table 9-1. Table "carrierroute"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
carrier
unsigned int
10
0 no This column contains the carrier id.
domain
string
64
'' no This column contains the route domain. Additional domains could be used for example as fallback.
scan_prefix
string
64
'' no This column contains the scan prefix, which define the matching portion of a phone number.
flags
unsigned int
11
0 no This column contains the flags used for rule matching.
mask
unsigned int
11
0 no This column contains the mask that is applied to the message flags before rule matching.
prob
float
not specified
0 no Name of column containing the probability. The probability value is used to distribute the traffic between several gateways.
strip
unsigned int
11
0 no Name of the column containing the number of digits to be stripped of the userpart of an URI before prepending rewrite_prefix.
rewrite_host
string
128
'' no Name of column containing rewrite prefixes. Here you can define a rewrite prefix for the localpart of the SIP URI.
rewrite_prefix
string
64
'' no Rewrite prefix for the localpart of the SIP URI.
rewrite_suffix
string
64
'' no Rewrite suffix for the localpart of the SIP URI.
description
string
255
NULL yes A comment for the route entry, useful for larger routing tables.
Table 9-2. Table "carrierfailureroute"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
carrier
unsigned int
10
0 no This column contains the carrier id.
domain
string
64
'' no This column contains the route domain. Additional domains could be used for example as fallback.
scan_prefix
string
64
'' no This column contains the scan prefix, which define the matching portion of a phone number.
host_name
string
128
'' no This column contains the routing destination used for rule matching.
reply_code
string
3
'' no This column contains the reply code used for rule matching.
flags
unsigned int
11
0 no This column contains the flags used for rule matching.
mask
unsigned int
11
0 no This column contains the mask that is applied to the message flags before rule matching.
next_domain
string
64
'' no This column contains the route domain that should be used for the next routing attempt.
description
string
255
NULL yes A comment for the route entry, useful for larger routing tables.
Chapter 10. Accounting
- closeddial
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: http://www.opensips.org/html/docs/modules/2.2.x/closeddial.html
Table 10-1. Table "closeddial"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
username
string
64
'' no Username / phone number
domain
string
64
'' no Domain name
cd_username
string
64
'' no Closed dial username
cd_domain
string
64
'' no Closed dial domain
group_id
string
64
'' no Attribute use to group usernames
new_uri
string
128
'' no New URI
Chapter 11. Clusterer support
- clusterer
This table is used for defining clusters of OpenSIPS instances.
Table 11-1. Table "clusterer"
name type size default null key extra attributes description id
int
10
default no primary autoincrement unique ID
cluster_id
int
10
default no unique identifier for a cluster
machine_id
int
10
default no unique identifier for a machine (a node in a cluster)
url
string
64
default no network location of the machine, like protocol:ip:port
state
int
1
1 no state of the machine 0 - down/ 1 - up / 2 - temporary disable
last_attempt
unsigned long
64
0 no last time(UNIX timestamp) when a failed attempt has occurred
failed_attempts
int
10
3 no maximum number of failed attempts
no_tries
int
10
0 no number of failed tries before auto-disabling
duration
int
10
30 no tempory disabled state duration(seconds)
description
string
64
default yes opaque text not used by the module
Chapter 12. Call-processing language
- cpl
Table for the call processing language "cpl" module. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/cpl_c.html
Chapter 13. Dialog support
- dialog
Persistent dialog information for the dialog module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/dialog.html
Table 13-1. Table "dialog"
name type size default null key extra attributes description dlg_id
unsigned long
10
default no primary h_entry | h_id
callid
string
255
default no Call-ID of the dialog
from_uri
string
128
default no The URI of the FROM header (as per INVITE)
from_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.
to_uri
string
128
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
128
default no Caller's contact uri.
callee_contact
string
128
default no 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
unsigned int
10
0 no 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.
Chapter 14. Matching and translation rules
- dialplan
This table is used by the dialplan module for the translation rules. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/dialplan.html
Table 14-1. Table "dialplan"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
dpid
int
11
default no Dialplan ID.
pr
int
11
default no Priority of rule.
match_op
int
11
default no Matching operator for rule (0-equal, 1-regexp).
match_exp
string
64
default no Matching expression (regexp or string).
match_flags
int
11
default no Matching flags (0-case sensitive, 1-case insensitive).
subst_exp
string
64
default no Substitution expression.
repl_exp
string
32
default no Replacement expression (sed like).
timerec
string
255
default no Time recurrence used to match this rule.
disabled
int
11
0 no Specifies if the command can be used, or is disabled.
attrs
string
32
default no General attributes string to be returned in case of rule matching.
Chapter 15. Dispatcher
- dispatcher
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: http://www.opensips.org/html/docs/modules/2.2.x/dispatcher.html
Table 15-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)
weight
int
not specified
1 no The weight of the destination
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
description
string
64
'' no Description for this destination
Chapter 16. Domain
- domain
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: http://www.opensips.org/html/docs/modules/2.2.x/domain.html
Table 16-1. Table "domain"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
domain
string
64
'' no Domain name
attrs
string
255
NULL yes Domain Attributes
last_modified
datetime
not specified
'1900-01-01 00:00:01' no Date and time when this record was last modified.
Chapter 17. Domainpolicy
- domainpolicy
Table for the domainpolicy module. More information at http://www.opensips.org/html/docs/modules/2.2.x/domainpolicy.html.
Table 17-1. Table "domainpolicy"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
rule
string
255
default no 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"
description
string
255
default no Comment about the rule
Chapter 18. Dynamic Routing
- dr_gateways
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: http://www.opensips.org/html/docs/modules/2.2.x/drouting.html.
- dr_rules
This table is used by the Dynamic Routing module to store information about the routing rules. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/drouting.html.
- dr_carriers
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: http://www.opensips.org/html/docs/modules/2.2.x/drouting.html.
- dr_groups
This table is used by the Dynamic Routing module to store information about the routing groups (users mapped over groups). More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/drouting.html.
- dr_partitions
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: http://www.opensips.org/html/docs/modules/2.2.x/drouting.html.
Table 18-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
'' no Text description of the GW/destination
Table 18-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
default no 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 no Reference to the GWs/destinations to be used when rule matches.
attrs
string
255
NULL yes Generic string describing RULE attributes - this string is to be interpreted from the script
description
string
128
'' no Text description of the rule
Table 18-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 Reference to the GWs/destinations from the list.
flags
unsigned int
11
0 no Flags (for different purposes) of the carriers
state
unsigned int
11
0 no The state of the carrier (on / off).
attrs
string
255
'' yes Attributes string for the carrier
description
string
128
'' no Text description of the GW list
Table 18-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
'' no Domain part of user
groupid
unsigned int
11
0 no The ID of the routing group the user belongs to.
description
string
128
'' no Text description of the group/user
Table 18-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).
ruri_avp
string
255
default yes The name of ruri_avp AVP.
gw_id_avp
string
255
default yes The name of gw_id_avp AVP
gw_priprefix_avp
string
255
default yes The name of gw_priprefix_avp AVP.
gw_sock_avp
string
255
default yes The name of gw_sock_avp AVP.
rule_id_avp
string
255
default yes The name of rule_id_avp AVP.
rule_prefix_avp
string
255
default yes The name of rule_prefix_avp AVP.
carrier_id_avp
string
255
default yes The name of carrier_id_avp AVP.
Chapter 19. Emergency
- emergency_routing
This table is used by the Emergency module to translate ERT informations in ESGWRI. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/emergency.html.
- emergency_report
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: http://www.opensips.org/html/docs/modules/2.2.x/emergency.html.
- emergency_service_provider
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: http://www.opensips.org/html/docs/modules/2.2.x/emergency.html.
Table 19-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 19-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 19-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
Chapter 21. Fraud Detection
- fraud_detection
This table is used by the Fraud Detection module to store information about fraud-profiles. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/fraud_detection.html.
Table 21-1. Table "fraud_detection"
name type size default null key extra attributes description ruleid
unsigned int
10
default no primary autoincrement Rule unique ID
profileid
unsigned int
not specified
default no The ID of the profile the current rule is part of
prefix
string
64
default no Numerical prefix to match this rule
start_hour
string
5
default no Start of the interval in which the rule should be matched.
end_hour
string
5
default no End of the interval in which the rule should be matched.
daysoftheweek
string
64
default no List/interval of days in which the rule is available.
cpm_warning
unsigned int
5
default no Warning threshold for calls per minute.
cpm_critical
unsigned int
5
default no Crtical threshold for calls per minute.
call_duration_warning
unsigned int
5
default no Warning threshold for calls per minute.
call_duration_critical
unsigned int
5
default no Crtical threshold for call duration.
total_calls_warning
unsigned int
5
default no Warning threshold for total calls.
total_calls_critical
unsigned int
5
default no Crtical threshold for total calls.
concurrent_calls_warning
unsigned int
5
default no Warning threshold for concurrent calls.
concurrent_calls_critical
unsigned int
5
default no Crtical threshold for concurrent calls.
sequential_calls_warning
unsigned int
5
default no Warning threshold for sequential calls.
sequential_calls_critical
unsigned int
5
default no Crtical threshold for sequential calls.
Chapter 22. Group checking
- grp
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: http://www.opensips.org/html/docs/modules/2.2.x/group.html
- re_grp
This table is used by the group module to check membership based on regular expressions. More information about the group module can be found at: http://www.opensips.org/html/docs/modules/2.2.x/group.html
Table 22-1. Table "grp"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
username
string
64
'' no Username / phone number
domain
string
64
'' no Domain name
grp
string
64
'' no Group name
last_modified
datetime
not specified
'1900-01-01 00:00:01' no Date and time when this record was last modified.
Table 22-2. Table "grp" indexes
name type links description account_group_idx
unique username, domain, grp
Chapter 23. Instant Message Conference
- imc_rooms
Room table for the IMC module. More information at http://www.opensips.org/html/docs/modules/2.2.x/imc.html.
- imc_members
Member table for the IMC module. More information at http://www.opensips.org/html/docs/modules/2.2.x/imc.html.
Table 23-1. Table "imc_rooms"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
name
string
64
default no Name of the room
domain
string
64
default no Domain of the room
flag
int
11
default no Flags
Chapter 24. Load Balancer
- load_balancer
This table is used by the Load-Balancer module to store information about the destinations the balance the calls between. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/load_balancer.html.
Table 24-1. Table "load_balancer"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID of the destination
group_id
unsigned int
11
0 no The group the destination belongs to
dst_uri
string
128
default no Destination address as a SIP URI
resources
string
255
default no String with the definition of the resource provided by the destination and the capacity of each resource
probe_mode
unsigned int
11
0 no Probing mode (0-none, 1-if disabled, 2-all the time)
description
string
128
'' no Text description of the destination
Chapter 25. Message Storage
- silo
This table us used by the msilo module to provide offline message storage More information about the msilo module can be found at: http://www.opensips.org/html/docs/modules/2.2.x/msilo.html
Table 25-1. Table "silo"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
src_addr
string
128
'' no Source address - From URI
dst_addr
string
128
'' no Destination address - To URI
username
string
64
'' no SIP domain of target user
domain
string
64
'' no Username / phone number of target user
inc_time
int
not specified
0 no Incoming time
exp_time
int
not specified
0 no Expiration time
snd_time
int
not specified
0 no Reminder send time
ctype
string
255
NULL yes Content type
body
binary
not specified
NULL yes Body of the message
Chapter 26. Permissions
- address
This table is used by the permissions module. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/permissions.html
Table 26-1. Table "address"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
grp
unsigned short
5
0 no Group
ip
string
50
default no IP address
mask
char
not specified
32 no Network mask
port
unsigned short
5
0 no Port
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 Regular expression
context_info
string
32
NULL yes Extra context information
Chapter 27. Presence
- presentity
Table for the presence module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/presence.html
- active_watchers
Table for the presence module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/presence.html
- watchers
Table for the presence module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/presence.html
- xcap
Table for the presence module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/presence.html
- pua
Table for the presence related pua module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/pua.html
Table 27-1. Table "presentity"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
username
string
64
default no User name
domain
string
64
default no Domain
event
string
64
default no Event
etag
string
64
default no User name
expires
int
11
default no Expires
received_time
int
11
default no Reveived time
body
binary
not specified
default no
extra_hdrs
binary
not specified
'' no
sender
string
128
default no Sender contact
Table 27-2. Table "presentity" indexes
name type links description presentity_idx
unique username, domain, event, etag
Table 27-3. Table "active_watchers"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
presentity_uri
string
128
default no Presence URI
watcher_username
string
64
default no From User
watcher_domain
string
64
default no From Domain
to_user
string
64
default no To User
to_domain
string
64
default no To Domain
event
string
64
'presence' no Event description
event_id
string
64
default yes Event ID
to_tag
string
64
default no TO tag
from_tag
string
64
default no From tag
callid
string
64
default no Call ID
local_cseq
int
11
default no Local cseq
remote_cseq
int
11
default no Remote cseq
contact
string
128
default no Contact
record_route
text
not specified
default yes Record route
expires
int
11
default no Expires
status
int
11
2 no Status
reason
string
64
default yes Reason
version
int
11
0 no Version
socket_info
string
64
default no Socket info
local_contact
string
128
default no Local contact
Table 27-4. Table "active_watchers" indexes
name type links description active_watchers_idx
unique presentity_uri, callid, to_tag, from_tag
Table 27-5. Table "watchers"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
presentity_uri
string
128
default no Presentity Uri
watcher_username
string
64
default no Watcher User
watcher_domain
string
64
default no Watcher Domain
event
string
64
'presence' no Event description
status
int
11
default no Status
reason
string
64
default yes Reason
inserted_time
int
11
default no
Table 27-6. Table "watchers" indexes
name type links description watcher_idx
unique presentity_uri, watcher_username, watcher_domain, event
Table 27-7. Table "xcap"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
username
string
64
default no User name
domain
string
64
default no Domain
doc
binary
not specified
default no doc
doc_type
int
11
default no Document type
etag
string
64
default no Document Etag
source
int
11
default no Entity inserting the record
doc_uri
string
128
default no Document uri
port
int
11
default no XCAP server port
Table 27-8. Table "xcap" indexes
name type links description account_doc_type_idx
unique username, domain, doc_type, doc_uri
source_idx
default source
Table 27-9. Table "pua"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
pres_uri
string
128
default no URI
pres_id
string
255
default no ID
event
int
11
default no Event
expires
int
11
default no Expires
desired_expires
int
11
default no Desired Expires
flag
int
11
default no Flags
etag
string
64
default yes Etag
tuple_id
string
64
default yes Tuple ID
watcher_uri
string
128
default yes Watcher URI
to_uri
string
128
default yes URI
call_id
string
64
default yes Call ID
to_tag
string
64
default yes To tag
from_tag
string
64
default yes From tag
cseq
int
11
default yes
record_route
text
not specified
default yes Record route
contact
string
128
default yes Contact
remote_contact
string
128
default yes Remote contact
version
int
11
default yes
extra_headers
text
not specified
default yes Extra Headers
Chapter 28. Registrant support
- registrant
Registrant information for the uac_registrant module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/uac_registrant.html
Table 28-1. Table "registrant"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
registrar
string
128
'' no URI pointing to the remote registrar.
proxy
string
128
NULL yes URI pointing to the outbond proxy.
aor
string
128
'' no URI defining the address of record.
third_party_registrant
string
128
NULL yes URI defining the third party registrant.
username
string
64
NULL yes Username for authentication.
password
string
64
NULL yes Password for authentication.
binding_URI
string
128
'' 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.
Chapter 29. Registrar
- aliases
This table for the registrar module is similar to the "location" table, (the aliases index makes lookup of missed calls much faster). Thus, the function lookup("alias") can be used to map aliases to AORs. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/registrar.html. Most people uses the dbaliases table with the alias_db module now.
Table 29-1. Table "aliases"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
username
string
64
'' no Alias Username / Phone Number
domain
string
64
'' no Domain name
contact
string
255
'' no Contact header field value provides a URI whoses meaning depends on the type of request or response it is in.
received
string
128
NULL yes Received IP:PORT in the format SIP:IP:PORT
path
string
255
NULL yes Path Header(s) per RFC 3327
expires
datetime
not specified
'2020-05-28 21:32:15' no Date and time when this entry expires.
q
float
10,2
1.0 no Value used for preferential routing.
callid
string
255
'Default-Call-ID' no Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
cseq
int
11
13 no CSeq header field contains a single decimal sequence number and the request method.
last_modified
datetime
not specified
'1900-01-01 00:00:01' no Date and time when this entry was last modified.
flags
int
11
0 no Flags
cflags
string
255
NULL yes CFlags
user_agent
string
255
'' no User-Agent header field contains information about the UAC originating the request.
socket
string
64
NULL yes Socket used to connect to OpenSIPS. For example: UDP:IP:PORT
methods
int
11
NULL yes Flags that indicate the SIP Methods this contact will accept.
sip_instance
string
255
NULL yes SIP Instance for this particular contact
attr
string
255
NULL yes Optional information specific to each registration
Chapter 30. RLS
- rls_presentity
Table for the RLS module.
- rls_watchers
Table for RLS module used for storing resource lists subscribe information.
Table 30-1. Table "rls_presentity"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
rlsubs_did
string
255
default no Resource list subscribe dialog id
resource_uri
string
128
default no List Uri
content_type
string
255
default no Content type
presence_state
binary
not specified
default no
expires
int
11
default no Expires
updated
int
11
default no Update flag
auth_state
int
11
default no Watcher authorization state
reason
string
64
default no reason for watcher authorization state
Table 30-2. Table "rls_presentity" indexes
name type links description rls_presentity_idx
unique rlsubs_did, resource_uri
updated_idx
default updated
Table 30-3. Table "rls_watchers"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
presentity_uri
string
128
default no Presence URI
to_user
string
64
default no To user
to_domain
string
64
default no To domain
watcher_username
string
64
default no From user
watcher_domain
string
64
default no From domain
event
string
64
'presence' no Event description
event_id
string
64
default yes Event ID
to_tag
string
64
default no To tag
from_tag
string
64
default no From tag
callid
string
64
default no Call ID
local_cseq
int
11
default no Local cseq
remote_cseq
int
11
default no Remote cseq
contact
string
64
default no Contact
record_route
text
not specified
default yes Record route
expires
int
11
default no Expires
status
int
11
2 no Status
reason
string
64
default no Reason
version
int
11
0 no Version
socket_info
string
64
default no Socket info
local_contact
string
128
default no Local contact
Chapter 31. RTPProxy
- rtpproxy_sockets
This table is used by the NAT Helper module to store definitions of socket(s) used to connect to (a set) RTPProxy. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/nathelper.html.
Table 31-1. Table "rtpproxy_sockets"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement Unique ID
rtpproxy_sock
text
not specified
default no A list of sockets use to connect to a set of RTPProxy. Example: "udp:localhost:12221 udp:localhost:12222".
set_id
unsigned int
10
default no The ID of the RTPProxy set.
Chapter 32. SIPtrace
- sip_trace
This table is used to store incoming/outgoing SIP messages in database. More informations can be found in the siptrace module documentation at: http://www.opensips.org/html/docs/modules/2.2.x/siptrace.html.
Table 32-1. Table "sip_trace"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
time_stamp
datetime
not specified
'1900-01-01 00:00:01' no Recording date
callid
string
255
'' no call ID from SIP message
trace_attrs
string
128
NULL yes SIP URI of the user being traced
msg
text
not specified
default no Full SIP message
method
string
32
'' no SIP method name
status
string
128
NULL yes SIP reply status
from_proto
string
5
default no Source protocol
from_ip
string
50
'' no Source IP address
from_port
unsigned int
5
default no Source port
to_proto
string
5
default no Destination protocol
to_ip
string
50
'' no Destination IP address
to_port
unsigned int
5
default no Destination port
fromtag
string
64
'' no From tag
direction
string
4
'' no Destination IP address
Chapter 33. Speed dial
- speed_dial
This table is used by the speeddial module to provide on-server speed dial facilities. More information about the speeddial module can be found at: http://www.opensips.org/html/docs/modules/2.2.x/speeddial.html
Table 33-1. Table "speed_dial"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
username
string
64
'' no Username / phone number
domain
string
64
'' no Domain name
sd_username
string
64
'' no Speed dial username
sd_domain
string
64
'' no Speed dial domain
new_uri
string
128
'' no New URI
fname
string
64
'' no First name
lname
string
64
'' no Last name
description
string
64
'' no Description
Chapter 34. Version
Chapter 35. TLS_MGM support
- tls_mgm
This table is used for defining domains.
Table 35-1. Table "tls_mgm"
name type size default null key extra attributes description id
string
64
default no primary unique ID
address
string
64
default no network location, like: "ip:port" or "name"
type
int
1
default no specifies the type of a domain : client domain(0) or server domain (1)
method
string
16
default yes SSL method used by a certain domain
verify_cert
int
1
default yes verify certificate: 0 - no, 1 - yes
require_cert
int
1
default yes require certificate: 0 - no, 1 - yes
certificate
string
255
default yes certificate associated with a certain domain
private_key
string
255
default yes private_key
crl_check_all
int
1
default yes check all crl: 0 -no, 1 - yes
crl_dir
string
255
default yes crl directory
ca_list
string
255
default yes CA list
ca_dir
string
255
default yes ca directory
cipher_list
string
255
default yes the list of algorithms used for authentication and encryption allowed
dh_params
string
255
default yes specifies the Diffie-Hellmann parameters
ec_curve
string
255
default yes specifies an elliptic curve which should be used for ciphers which demand an elliptic curve
Chapter 36. SIP URI checks
- uri
This table is used by uri_db module to implement various SIP URI checks. More information about the uri_db module can be found at: http://www.opensips.org/html/docs/modules/2.2.x/uri_db.html
Table 36-1. Table "uri"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement
username
string
64
'' no Username / phone number
domain
string
64
'' no Domain name
uri_user
string
64
'' no Username / phone number
last_modified
datetime
not specified
'1900-01-01 00:00:01' no Date and time when this record was last modified.
Chapter 37. User and global blacklists
- userblacklist
This table is used by the userblacklist module for the user specific blacklists. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/userblacklist.html
- globalblacklist
This table is used by the userblacklist module for the global blacklists. More information is available at: http://www.opensips.org/html/docs/modules/2.2.x/userblacklist.html
Table 37-1. Table "userblacklist"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
username
string
64
'' no The user that is used for the blacklist lookup.
domain
string
64
'' no The domain that is used for the blacklist lookup.
prefix
string
64
'' no The prefix that is matched for the blacklist.
whitelist
char
1
0 no Specify if this a blacklist (0) or a whitelist (1) entry.
Table 37-2. Table "userblacklist" indexes
name type links description userblacklist_idx
default username, domain, prefix
Table 37-3. Table "globalblacklist"
name type size default null key extra attributes description id
unsigned int
10
default no primary autoincrement unique ID
prefix
string
64
'' no The prefix that is matched for the blacklist.
whitelist
char
1
0 no Specify if this a blacklist (0) or a whitelist (1) entry.
description
string
255
NULL yes A comment for the entry.
Chapter 38. User location
- location
Persistent user location information for the usrloc module. More information can be found at: http://www.opensips.org/html/docs/modules/2.2.x/usrloc.html
Table 38-1. Table "location"
name type size default null key extra attributes description contact_id
unsigned long
10
default no primary autoincrement unique ID
username
string
64
'' no Username / phone number
domain
string
64
NULL yes Domain name
contact
string
255
'' no Contact header field value provides a URI whoses meaning depends on the type of request or response it is in.
received
string
128
NULL yes Received IP:PORT in the format SIP:IP:PORT
path
string
255
NULL yes Path Header(s) per RFC 3327
expires
datetime
not specified
'2020-05-28 21:32:15' no Date and time when this entry expires.
q
float
10,2
1.0 no Value used for preferential routing.
callid
string
255
'Default-Call-ID' no Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
cseq
int
11
13 no CSeq header field contains a single decimal sequence number and the request method.
last_modified
datetime
not specified
'1900-01-01 00:00:01' no Date and time when this entry was last modified.
flags
int
11
0 no Flags
cflags
string
255
NULL yes CFlags
user_agent
string
255
'' no User-Agent header field contains information about the UAC originating the request.
socket
string
64
NULL yes Socket used to connect to OpenSIPS. For example: UDP:IP:PORT
methods
int
11
NULL yes Flags that indicate the SIP Methods this contact will accept.
sip_instance
string
255
NULL yes SIP Instance for this particular contact
attr
string
255
NULL yes Optional information specific to each registration