The SIP Messages function is the go-to source for a wide variety of information about call activity in ClearIP. This function allows for selecting, sorting and viewing SIP records received, processed and responded to by ClearIP.
ClearIP receives SIP records from VoIP telecom networks, saves them in the ClearIP SIP records database, analyzes them and applies services according to policy settings.
Viewing SIP Messages
SIP messages can be viewed on the Sip Messages page under the Analytics dropdown menu.
As with other ClearIP analytics functions, the top of the screen provides options for date/time range selection. (See date/time range selection for more information.) ClearIP retains 1 year of history, and old data rolls out of the system automatically.
The default initial view shows SIP messages created during the past hour. The date/time that each SIP message was created is in the timestamp column. ClearIP displays timestamps according to local time zone.
The table shows SIP messages selected when the page was first opened, or the selection criteria was last changed. By default, this view does not automatically refresh, but click the Refresh button to choose an automatic refresh rate. The automatic refresh rate chosen will remain in effect while on the SIP Messages page and will revert to manual refresh once the page is closed and returned to later.
The default sort order for records in the SIP messages table is by descending timestamp.
Some column headers have drop-down selectors underneath that allow the selection of records that match the specific values.
View SIP Message Detail
Click the plus sign + in the leftmost column to view details for that record.
Click the minus sign - to collapse the detail view for that record.
View SIP Request and Response
Click the Show button to view the SIP request received by ClearIP and the SIP response that ClearIP sent back to the telecom network.
This combination of views, from SIP request to SIP details, to SIP response, enables tracing and understanding the actions in detail.
SIP Messages Columns
Every ClearIP page with a table also has a Columns button that can be used to change the visible columns. There are also shortcuts to show all columns, hide all columns, and restore the visible columns to the default setting.
Below is a list of these columns available on the SIP Messages page, their definitions and how they are used on a high level.
Asserted Called Number
Asserted Called Number is a field with a value derived from a SIP INVITE sent to ClearIP. It refers to Called Number normalized into E164 format. ClearIP will establish the value based on information in the SIP INVITE.
The Asserted Called Number is taken from the To header in the SIP INVITE, and called number translation rules are applied.
Asserted Called Number is used for many features throughout ClearIP, such as STI Authentication and Verification.
Asserted Calling Number
Asserted Calling Number is a field with a value derived from a SIP INVITE sent to ClearIP. It refers to Calling Number normalized into E164 format. ClearIP will establish the Asserted Calling Number from one of the following two headers in the SIP INVITE in order of priority, and apply translation rules if applicable:
- P-Asserted-Identity - ClearIP will first look to the P-Asserted Identity header for the Asserted Calling Number.
- From - ClearIP will only get the Asserted Calling Number via the From header if the P-Asserted Identity is not present or malformed.
BCID Authentication Status
The BCID Authentication Status represents the outcome of the BCID Authentication process for the call. Possible values are:
- No Authentication Requested
- Invalid Calling Number
- Invalid Called Number
- No Authority
- Successful
BCID Authentication Service Provider Code
The BCID Authentication Service Provider Code represents the Service Provider Code (SPC), or OCN, or SPID that was used for the call.
BCID Authentication Origination Identifier
The BCID Authentication Origination Identifier is a unique identifier for tracing a call, if necessary.
BCID Authentication Enterprise ID
The BCID Authentication Enterprise ID represents the BCID Enterprise ID that was used for the call.
BCID Authentication Display Identity Record ID
The BCID Authentication Display Identity Record ID represents the Display Identity Record ID for the call.
BCID Authentication Onboarding Agent ID
The BCID Authentication Onboarding Agent ID represents the BCID onboarding agent ID for the call.
BCID Authentication Vetting Agent ID
The BCID Authentication Vetting Agent ID represents the BCID vetting agent ID for the call.
Bill To Number
The Bill To Number field represents the bill-to for a customer. The user part of the SIP message request p-charge-info header. There are multiple ways ClearIP can match a user configured in ClearIP with an incoming SIP INVITE; using the Bill To Number is one of those ways.
Billing Rate
The Billing Rate field reflects how much the call costs per minute. The configured billing product policies, billing rate plans, billing rates, and jurisdiction determine the Billing Rate.
CNAM Lookup
CNAM Lookup is a Boolean field that shows whether the CNAM Lookup service was used to retrieve the Caller ID information.
CNAM
The CNAM field shows the value of the Caller ID information, either from the SIP INVITE, or set by ClearIP.
Call ID
The Call ID contains the value of the Call-ID header of the SIP message request.
Called Company Name
The Called Company Name field’s value is retrieved from the NNACL database, if the called number is found in that database. The Called Company Name is the carrier of record in the NNACL for the called telephone number, or the called LRN if the called number has been ported.
Called Country
The Called Country contains the name of the country for the called number’s country code.
Called Fraud Score
The Called Fraud Score contains the value of the custom or default fraud rate for the called number or the called number’s matching prefix.
Called LATA
The Called LATA field contains the value of the Local Access and Transport Area, retrieved from the NNACL database.
Called Location
The Called Location field contains the Translated Called Number’s location within the Called Country. It can be a State or Province of the Called Country.
Called LRN
The Called Location Routing Number is retrieved from the NPAC number portability database, if the called number is found in that database.
Called LRN Company Name
The Called LRN Company Name is retrieved from the NPAC number portability database or from the LERG database.
Called LRN LATA
The Called LRN LATA value is retrieved from the NPAC number portability database or from the NNACL database.
Called LRN Location
The Called LRN Location value represents the location within the Called Country, of the Ported Called Number or the Translated Called Number. It can be a State or Province of the Called Country.
Called LRN NPANXX
The Called LRN NPANXX is the first seven digits (1-NPA-NXX) of the ported called number or the translated called number.
Called LRN SPID
The Called LRN SPID value is retrieved from the NPAC number portability database or from the NNACL database.
Called LRN Rate Center
The Called LRN Rate Center value is retrieved from the NPAC number portability database or from the NNACL database.
Called NPANXX
The Called NPANXX value is the first seven digits (1-NPA-NXX) of the translated called number.
Called Rate Center
The Called Rate Center value is retrieved from the NNACL database.
Called SPID
The Called SPID value refers to the porting-corrected SPID or OCN of the called number and is retrieved from the NNACL database.
Calling Company Name
The Calling Company Name value is retrieved from the NNACL database.
Calling Country
The Calling Country contains the name of the country for the called number’s country code.
Calling Fraud Score
The Calling Fraud Score contains the value of the custom or default fraud rate for the called number or the calling number’s matching prefix.
Calling LATA
The Calling LATA field contains the value of the Local Access and Transport Area, retrieved from the NNACL database.
Calling Location
The Calling Location field contains the Translated Calling Number’s location within the Calling Country. It can be a State or Province of the Calling Country.
Calling LRN
The Calling LRN value is retrieved from the NNACL number portability database.
Calling LRN Company Name
The Calling LRN Company Name is retrieved from the NPAC number portability database or from the LERG database.
Calling LRN LATA
The Calling LRN LATA value is retrieved from the NPAC number portability database or from the NNACL database.
Calling LRN Location
The Calling LRN Location value represents the location within the Calling Country, of the Ported Called Number or the Translated Called Number. It can be a State or Province of the Called Country.
Calling LRN NPANXX
The Calling LRN NPANXX value is the first seven digits (1-NPA-NXX) of the ported calling number or the translated calling number.
Calling LRN Rate Center
The Calling LRN Rate Center is retrieved from the NPAC number portability database or from the NNACL database.
Calling LRN SPID
The Calling LRN SPID value is retrieved from the NPAC number portability database or from the NNACL database.
Calling NPANXX
The Calling NPANXX is the first seven digits (1-NPA-NXX) of the translated calling number.
Calling Rate Center
The Calling Rate Center is retrieved from the NNACL database.
Calling SPID
The Calling SPID refers to the porting corrected OCN and is retrieved from the NNACL database.
Code
The Code field represents the returned SIP message response code.
Forwarded
Forwarded is a Boolean field, that is based on the Diversion header, if present, in a SIP INVITE. If the Diversion header is present, then the Forwarded field is set to ‘Yes’; otherwise, it is set to ‘No’.
Forwarding Number
The Forwarding Number contains the User part of the SIP message request Diversion header.
Fraud Control Types
The Fraud Control Types field contains the number of enabled fraud control triggers. If this value is zero, there are a few possible reasons why:
- Fraud Control was either disabled.
- The call was found in the whitelist.
- The call did not trigger a fraud control event.
- A previous call did not trigger a fraud control event recently.
Group
The Group field represents the group of the matching User that was found during User Lookup.
High Risk Called Number
High Risk Called Number is a Boolean field, which depends on whether ClearIP has flagged the called number as risky.
High Risk Calling Number
High Risk Calling Number is a Boolean field, which depends on whether ClearIP has flagged the calling number as risky.
ID
The ID field contains the unique identifier, generated by ClearIP, of the SIP message request.
Inbound Shield
Inbound Shield is a Boolean field that reflects whether the reseller has Inbound Shield configured and a matching policy was found for this SIP INVITE.
Invalid Called Number
Invalid Called Number is a Boolean field that reflects where the Requested Called Number in the SIP INVITE was properly formatted. This only shows that a valid number format was used. If a number has not been made available by the national numbering authority, the format could still be valid.
Invalid Calling Number
Invalid Called Number is a Boolean field that reflects where the Requested Calling Number in the SIP INVITE was properly formatted.
Jurisdiction
Jurisdiction reflects the calculated jurisdiction of the call. The possible values for this field are:
- Local
- Intrastate
- Domestic
- International
Latency
Latency refers to the time, in milliseconds, that ClearIP takes to handle the SIP Request. It does not include network latency from the customer network to ClearIP or from a ClearIP proxy to ClearIP.
LCR Count
LCR Count reflects the number of LCR Providers that are being examined in the process of doing Least-Cost Routing.
Message
The message field contains a description of the code contained in the Response Code field.
Method
Method contains the value of the Method header of the SIP message request. This will usually be either ‘INVITE’ or ‘OPTIONS’ or ‘ACK.’ If ClearIP sees a value besides these three values, then it will return a 405 Method Not Allowed code in the SIP Response.
NANP Called Number
NANP Called Number is a Boolean field, which depends on whether the Translated Called Number conforms to a standard ten-digit format.
NANP Calling Number
NANP Calling Number is a Boolean field, which depends on whether the Translated Calling Number conforms to a standard ten-digit format.
NNACL
The NNACL is the NPA NXX Active Code List (NNACL) sold by iconectiv. The NNACL lists all NPA NXX assignments, and one-thousand blocks, that are active (in service). Data includes the assigned service provider (OCN) of the NPA NXX, company name, the type of service that is provided (e.g. wireless) by the assigned service provider, the associated Rate Center and State/Province/Country, and a Portability Indicator.
Operator
The Operator field contains the name of the ClearIP operator for the SBC that the SIP INVITE came from.
Originating Trunk Group
The Originating trunk group (OTG) is defined by one of the following (ordered from highest priority):
- X-OTG header
- OTG URI parameter in the From header
- OTG parameter in the From header
- TGRP user parameter in the Contact header
Outbound Shield
Outbound Shield is a Boolean field that reflects whether the reseller has Outbound Shield configured and a matching policy was found for this SIP INVITE.
P Source Device
The P Source Device indicates the IP address of the source device, and its value comes from one of three possible sources (ordered from highest priority):
- The P-Source-Device header of the SIP message request
- The trunk-context parameter of the Contact Header URI
- The host value of the From header URI NOTE: This field is supposed to be an IP address, but ClearIP will set it to whatever value is in the field that is used to set its value based on the above.
Ported Called Number
Ported Called Number is a Boolean field that depends on whether the called number has been ported.
Ported Calling Number
Ported Calling Number is a Boolean field that depends on whether the calling number has been ported.
Privacy
Privacy is a Boolean field, that indicates that the calling party wishes to remain private/anonymous. It is determined based on the following logic relating to a SIP INVITE:
- If there is a Remote Party ID header and the privacy parameter in the header is set to ‘full’ or ’name’, then Privacy will be set to ‘Yes’.
- Or if the Privacy header is present and contains the values ‘header’, ‘id’, or ‘user’, then Privacy will be set to ‘Yes’.
- Or if the display name in the From header is set to ‘Anonymous’, then Privacy will be set to ‘Yes’.
- Or if the display name in the P-Asserted Identity header is set to ‘Anonymous’, then Privacy will be set to ‘Yes’.
- Otherwise, Privacy will be set to ‘No’. Privacy has implications on CNAM and STI Verification.
Reason
The value of the Reason field further explains why ClearIP sent a particular response code in the SIP Response.
Reputation Lookup
Reputation Lookup is a Boolean field that depends on whether the ClearIP Reputation Lookup service was accessed for the SIP INVITE.
Reputation Score
The Reputation Score field contains a number that reflects what the ClearIP Reputation Lookup service assigned the calling number, if that feature is enabled for the customer. If there was a problem with access the reputation service, the value will be set to 0. The default value is zero.
Requested Called Number
Requested Called Number is a field whose value is established based on information from a SIP INVITE. It refers to the Called Number sent by the Originating Service Provider. Requested Called Number is taken from the user part of the request URI in the SIP INVITE. The value is a number which is not normalized, i.e. it might contain special characters like a plus sign.
NOTE: For any Action that is set to Divert, ClearIP will use the Requested Called Number in the Contact Header of the SIP response, if the SBC is configured to do so.
Requested Calling Number
Requested Calling Number is a field whose value is established based on information from
- Diversion - ClearIP will first look to the Diver header to get the Requested Calling Number, if it is present.
- P-Asserted Identity - ClearIP will get the requested Calling Number from the P-Asserted Identity header, if the Diversion header is not present.
- Remote Party ID - ClearIP will look for the Remote Party ID header, if neither of the above headers is present.
- P-Charge Info - ClearIP will look for the P Charge Info header if none of the above headers is present.
- From - ClearIP will finally look to the From header for Requested Calling Number, if none of the above headers is present.
Routing
Routing is a Boolean field that depends on whether Routing has been enabled for both the Reseller and the SBC.
SBC IP
The SBC IP field contains the IPv4 public network address of the SBC.
SBC Partition
SBC Partition is the subdomain of the host section of the SIP Message request URI. See the Partition section of SBCs page for more information.
SBC
The SBC field contains the name of the SBC that was matched for the SIP INVITE.
STI Authentication Attestation Indicator
The STI Authentication Attestation Indicator is a field with a value of A, B, or C, based on the attestation used in the signaling call.
STI Authentication Origination Identifier
The STI Authentication Origination Identifier is a unique identifier for tracing a call, if necessary. It will be the GUID of the Operator or the GUID of the User agent.
STI Authentication Status
The STI Authentication Status field contains ‘Successful’ or any one of the following error statuses returned in the attempt to authenticate:
- No Authentication Requested
- Ignore
- Invalid Calling Number
- Invalid Called Number
- No Authority
- Blocked
STI Authentication
The STI Authentication is a Boolean field that reflects whether ClearIP attempted to authenticate the SIP INVITE, based on the STI Authentication policy configuration.
STI Verification Attestation Indicator
The STI Verification Attestation Indicator is a field with a value of A, B, or C, based on the attestation used in verifying the call.
STI Verification Certificate Cached
STI Verification Certificate Cached is a Boolean field that conveys whether ClearIP used a cached version of the certificate or not.
STI Verification Certificate Latency
The STI Authentication Certificate Latency field refers to the time, in milliseconds, that ClearIP took in retrieving the public certificate.
STI Verification Certificate Repository Domain
The STI Authentication Certificate Repository Domain field contains the domain name of the certificate repository.
STI Verification Origination Identifier
The STI Verification Origination Identifier is a unique identifier for tracing a call, if necessary. The value comes from the origId field within the authentication token payload.
STI Verification Service Provider Code
The STI Verification Service Provider Code field contains the value of the spc field within the public certificate.
STI Verification Status
The STI Verification Status field contains ‘Successful’ or any one of the following error statuses returned in the attempt to verify:
- No Verification Requested
- No Identity Header
- Malformed Identity Header
- Invalid Parameter info
- Invalid Parameter alg
- Invalid Parameter ppt
- Malformed Token
- Malformed Certificate Repository
- Invalid Token Attestation Indicator
- Invalid Token origid
- Invalid Token iat
- Invalid Token dest
- Invalid Token x5u
- Invalid Token alg
- Invalid Token ppt
- Invalid Token typ
- Calling Number Mismatch
- Called Number Mismatch
- Certificate Repository Error
- Certificate Error
- Certificate Chain Error
- Invalid Token Signature
STI Verification
STI Verification is a Boolean field that reflects whether ClearIP attempted to verify the SIP INVITE, based on the STI Verification policy configuration.
Service Provider
The Service Provider field contains the name of the Service Provider for the User that ClearIP matched for the SIP INVITE.
Timestamp
The Timestamp field contains the exact time that the SIP INVITE was received by ClearIP.
Toll Free Called Number
Toll Free Called Number is a Boolean field that depends on whether the called number was a toll-free number.
Toll Free Calling Number
The Toll Free Calling Number is a Boolean field that depends on whether the calling number was a toll-free number. The Toll Free Calling Number is a Boolean field that depends on whether the calling number was a toll-free number.
Translated Called Number
Translated Called Number is a field created based on the Requested Called Number. Since the Requested Called Number is not normalized, called number translation rules must be applied. Translated Called Number is the Requested Called Number after translation rakes are applied.
Translated Calling Number
Translated Calling Number is a field created based on the Requested Calling Number. Since the Requested Calling Number is not normalized, calling number translation rules must be applied. Translated Calling Number is the Requested Calling Number after translation rakes are applied.
User Agent
The User Agent field contains the value of the user-agent header of the SIP Message.
User ID
The value of the User ID field comes from either the x-user-id or x-broadworks-dnc header and contains the value of the user-id parameter of either header.
User
The User field contains the name of the User that ClearIP matched for the SIP INVITE.