View SIP Messages
The SIP Messages page can be used to pull a detailed list of calls. Desired calls may be retrieved by applying various filters.
To pull data from the SIP Messages and SIP Reports, a request must be made to the API with all parameters such as filter values, date range values, group by values, etc. defined within the URL of the request.
Here is the same URL formatted for readability with all URL encoded characters decoded:
https://api.clearip.com/sipMessages
?from= DATE_RANGE_START_UNIX_TIME
&limit= NUMBER_OF_RECORDS_RETURNED
&skip=0
&sort=timestamp DESC
&where[timestamp][>=]=CURRENT_UNIX_TIME
Response Body:
{
"sipMessages": [
{
"id": "CLEARIP_SIP_MESSAGE_ID_HERE",
"timestamp": TIMESTAMP_UNIX_TIME_HERE,
"second": SECOND_UNIX_TIME_HERE,
"minute": MINUTE_UNIX_TIME_HERE,
"fiveMinutes": FIVE_MINUTES_PRIOR_TO_TIMESTAMP_UNIX_TIME_HERE,
"fifteenMinutes": FIFTEEN_MINUTES_PRIOR_TO_TIMESTAMP_UNIX_TIME_HERE,
"hour": HOUR_UNIX_TIME_HERE,
"day": DAY_UNIX_TIME_HERE,
"latency": CLEARIP_PROCESSING_LATENCY_IN_MILLISECONDS_HERE,
"method": "INVITE",
"sbcIp": "SIP_INVITE_SBC_IP_ADDRESS_HERE"
"userId": "SIP_INVITE_USER_ID_HERE",
"psd": "SIP_INVITE_P-SOURCE-DEVICE_IP_ADDRESS_HERE",
"otg": "SIP_INVITE_ORIGINATING_TRUNK_GROUP_VALUE_HERE",
"callId": "SIP_INVITE_CALL-ID_HERE",
"cnam": "CNAM_VALUE_HERE",
"userAgent": "USER_AGENT_HERE",
"requestedCallingNumber": "SIP_INVITE_CALLING_NUMBER_HERE",
"requestedCalledNumber": "SIP_INVITE_CALLED_NUMBER_HERE",
"translatedCallingNumber": "CLEARIP_NORMALIZED_CALLING_NUMBER_HERE",
"translatedCalledNumber": "CLEARIP_NORMALIZED_CALLING_NUMBER_HERE",
"assertedCallingNumber": "SIP_INVITE_PAI_FROM_CALLING_NUMBER_HERE",
"assertedCalledNumber": "SIP_INVITE_TO_CALLED_NUMBER_HERE",
"jurisdiction": "ROUTING_JURISDICTION_HERE",
"forwarded": SIP_INVITE_DIVERSION_HEADER_PRESENT_BOOLEAN_HERE,
"fraudControlTypes": NUMBER_OF_CLEARIP_FRAUD_TRIGGERS_APPLIED_HERE,
"lcrCount": NUMBER_OF_CLEARIP_LCR_PROVIDERS_CONSIDERED_HERE,
"reputationScore": REPUTATION_SCORE_HERE,
"callingFraudScore": CALLING_NUMBER_FRAUD_SCORE_HERE,
"calledFraudScore": CALLED_NUMBER_FRAUD_SCORE_HERE,
"callingLrn": "CALLING_NUMBER_LRN_HERE",
"calledLrn": "CALLED_NUMBER_LRN_HERE",
"callingSpid": "CALLING_NUMBER_REGISTERED_SPID_OCN_HERE",
"calledSpid": "CALLING_NUMBER_REGISTERED_SPID_OCN_HERE",
"callingRateCenter": "CALLING_NUMBER_RATE_CENTER_HERE",
"calledRateCenter": "CALLED_NUMBER_RATE_CENTER_HERE",
"callingLata": "CALLING_NUMBER_LATA_HERE",
"calledLata": "CALLED_NUMBER_LATA_HERE",
"callingCompanyName": "CALLING_NUMBER_SPID_COMPANY_NAME_HERE",
"calledCompanyName": "CALLED_NUMBER_SPID_COMPANY_NAME_HERE",
"invalidCallingNumber": INBOUND_SHIELD_INVALID_CALLING_NUMBER_BOOLEAN_HERE,
"invalidCalledNumber": OUTBOUND_SHIELD_INVALID_CALLED_NUMBER_BOOLEAN_HERE,
"highRiskCallingNumber": INBOUND_SHIELD_HIGH_RISK_CALLING_NUMBER_BOOLEAN_HERE,
"highRiskCalledNumber": OUTBOUND_SHIELD_HIGH_RISK_CALLED_NUMBER_BOOLEAN_HERE,
"routing": CLEARIP_ROUTING_PERFORMED_BOOLEAN_HERE,
"lrnLookup": LRN_LOOKUP_BOOLEAN_HERE,
"reputationLookup": REPUTATION_LOOKUP_BOOLEAN_HERE,
"cnamLookup": CNAM_LOOKUP_BOOLEAN_HERE,
"inboundShield": INBOUND_SHIELD_LOOKUP_BOOLEAN_HERE,
"outboundShield": OUTBOUND_SHIELD_LOOKUP_BOOLEAN_HERE,
"stiVerification": STI_VERIFICATION_PERFORMED_BOOLEAN_HERE,
"stiAuthentication": STI_AUTHENTICATION_PERFORMED_BOOLEAN_HERE,
"stiVerificationStatus": STI_VERIFICATION_STATUS_HERE,
"stiAuthenticationStatus": STI_AUTHENTICATION_STATUS_HERE,
"stiVerificationAttestationIndicator": "STI_VERIFICATION_ATTESTATION_LEVEL_HERE",
"stiVerificationOriginationIdentifier": "STI_VERIFICATION_ORIGID_HERE ",
"stiVerificationCertificateRepositoryDomain": "",
"stiVerificationCertificateLatency": STI_VERIFICATION_CERTIFICATE_REPOSITORY_ACCESS_LATENCY_HERE,
"stiVerificationCertificateCached": STI_VERIFICATION_CERTIFICATE_CACHED_BOOLEAN_HERE,
"stiAuthenticationAttestationIndicator": "STI_AUTHENTICATION_ATTESTATION_LEVEL_HERE",
"stiAuthenticationOriginationIdentifier": "STI_AUTHENTICATION_ATTESTATION_LEVEL_HERE",
"code": SIP_RESPONSE_CODE_HERE,
"message": "SIP_RESPONSE_CODE_MESSAGE_HERE",
"reason": "REASON_FOR_RESPONSE_CODE_HERE",
"reseller": "CLEARIP_RESELLER_ID_HERE",
"operator": "CLEARIP_OPERATOR_ID_HERE",
"sbc": "CLEARIP_SBC_ID_HERE",
"serviceProvider": "CLEARIP_SERVICE_PROVIDER_ID_HERE",
"group": "CLEARIP_GROUP_ID_HERE",
"user": "CLEARIP_USER_ID_HERE",
"callingCountry": "CLEARIP_COUNTRY_ID_OF_CALLED_NUMBER_HERE",
"callingLocation": "CLEARIP_US_STATE_CANADIAN_PROVINCE_ID_OF_CALLING_NUMBER_HERE",
"calledCountry": "CLEARIP_COUNTRY_ID_OF_CALLED_NUMBER_HERE",
"calledLocation": "CLEARIP_US_STATE_CANADIAN_PROVINCE_ID_OF_CALLED_NUMBER_HERE"
}
]
}
Example Request: View Blocked Calls to 1-605-339-1454 During Past Week
URL formatted for readability:
https://api.clearip.com/sipMessages
?from=1595131200000
&limit=10
&skip=0
&sort=timestamp DESC
&to=1595735940000
&where[translatedCalledNumber][startsWith]=16053391454
&where[code]=603
&where[timestamp][>=]=1595131200000
&where[timestamp][<=]=1595735940000
Example Response: View Blocked Calls to 1-605-339-1454 During Past Week (Single SIP Message)
{
"sipMessages": [
{
"id": "f9ea78cd-c83c-4813-b856-ee3a871617de",
"timestamp": 1595619219835,
"second": 1595619219000,
"minute": 1595619180000,
"fiveMinutes": 1595619000000,
"fifteenMinutes": 1595619000000,
"hour": 1595617200000,
"day": 1595548800000,
"latency": 1,
"method": "INVITE",
"sbcIp": "18.208.235.205",
"userId": "",
"psd": "192.168.1.89",
"otg": "",
"callId": "15-31372@192.168.1.89",
"cnam": "",
"userAgent": "",
"requestedCallingNumber": "14047884802",
"requestedCalledNumber": "16053391454",
"translatedCallingNumber": "14047884802",
"translatedCalledNumber": "16053391454",
"assertedCallingNumber": "14047884802",
"assertedCalledNumber": "",
"jurisdiction": "domestic",
"forwarded": false,
"fraudControlTypes": 1,
"lcrCount": 1,
"reputationScore": 1,
"callingFraudScore": 1.005,
"calledFraudScore": 1.005,
"callingLrn": "14045679081",
"calledLrn": "",
"callingSpid": "7473",
"calledSpid": "9631",
"callingRateCenter": "ATLANTA",
"calledRateCenter": "SIOUX FLS",
"callingLata": "438",
"calledLata": "640",
"callingCompanyName": "POWERTEL ATLANTA LICENSES INC",
"calledCompanyName": "QWEST CORPORATION",
"invalidCallingNumber": false,
"invalidCalledNumber": false,
"highRiskCallingNumber": false,
"highRiskCalledNumber": false,
"routing": false,
"lrnLookup": false,
"reputationLookup": false,
"cnamLookup": false,
"inboundShield": false,
"outboundShield": false,
"stiVerification": false,
"stiAuthentication": false,
"stiVerificationStatus":null,
"stiAuthenticationStatus":null,
"stiVerificationAttestationIndicator": "",
"stiVerificationOriginationIdentifier": "",
"stiVerificationCertificateRepositoryDomain": "",
"stiVerificationCertificateLatency": 1,
"stiVerificationCertificateCached": false,
"stiAuthenticationAttestationIndicator": "",
"stiAuthenticationOriginationIdentifier": "",
"code": 103,
"message": "Decline",
"reason": "fraud-detected",
"reseller": "a00c4269-81bb-4ace-b395-cfe000015289",
"operator": "bf783dcd-78cf-49b7-b75f-ffa4c2c7daf6",
"sbc": "046c16a2-647a-4d2f-b486-09fd7d34fefe",
"serviceProvider": "175d515e-097a-49f8-b615-d1a132144668",
"group": "b4bd2def-4668-4f5a-bbdf-b5586be1e07d",
"user": "09025e7e-ee78-42e1-8f37-184df52d67d9",
"callingCountry": "3008f0f8-e96e-4bf9-9cfd-ec017f131883",
"callingLocation": "ca3c87e9-47dd-4da5-b51b-28560e416f57",
"calledCountry": "3008f0f8-e96e-4bf9-9cfd-ec017f131883",
"calledLocation": "7e7a889d-cd5f-4ee6-a88b-47ac6a2a2f23"
}
]
}
Example Request: View SIP Message for Specific Call
URL formatted for readability:
https://api.clearip.com/sipMessages
?from=1607363100000
&limit=20
&skip=0
&sort=timestamp DESC
&where[id]=12134b01-55e5-4968-bb12-8c6b24ade48f
&where[timestamp][>=]=1607363100000
Example Response: View SIP Message for Specific Call
{
"sipMessages": [
{
"id": "12134b01-55e5-4968-bb12-8c6b24ade48f",
"timestamp": 1607366763668,
"latency": 11,
"method": "INVITE",
"sbcIp": "18.232.213.34",
"userId": "",
"psd": "172.29.0.9",
"otg": "",
"billToNumber": "",
"callId": "1-17859@172.29.0.9",
"cnam": "",
"userAgent": "",
"requestedCallingNumber": "18133503379",
"requestedCalledNumber": "14046079369",
"translatedCallingNumber": "18133503379",
"translatedCalledNumber": "14046079369",
"assertedCallingNumber": "18133503379",
"assertedCalledNumber": "14046079369", "jurisdiction": "domestic",
"forwarded": false,
"privacy": false,
"billingRate": 1,
"fraudControlTypes": 1,
"lcrCount": 1,
"reputationScore": 1,
"callingFraudScore": 1.005,
"calledFraudScore": 1.005,
"callingLrn": "",
"calledLrn": "",
"callingSpid": "0328",
"calledSpid": "9417",
"callingRateCenter": "TAMPACEN",
"calledRateCenter": "ATLANTA",
"callingLata": "952",
"calledLata": "438",
"callingCompanyName": "FRONTIER FLORIDA LLC DBA FRONT",
"calledCompanyName": "BELLSOUTH TELECOMM INC DBA SOU",
"invalidCallingNumber": false,
"invalidCalledNumber": false,
"highRiskCallingNumber": false,
"highRiskCalledNumber": false,
"routing": true,
"lrnLookup": false,
"reputationLookup": false,
"cnamLookup": false,
"inboundShield": true,
"outboundShield": false,
"stiVerification": true,
"stiAuthentication": true,
"stiVerificationStatus": "successful",
"stiAuthenticationStatus": "successful",
"stiVerificationAttestationIndicator": "A",
"stiVerificationOriginationIdentifier": "02ee5467-a204-4b6c-8fbd-3000833b66c0",
"stiVerificationCertificateRepositoryDomain": "certificates.clearip.com",
"stiVerificationCertificateLatency": 1,
"stiVerificationCertificateCached": true,
"stiAuthenticationAttestationIndicator": "A",
"stiAuthenticationOriginationIdentifier": "02ee5467-a204-4b6c-8fbd-3000833b66c0",
"code": 102,
"message": "Moved Temporarily",
"reason": "no-fraud-detected",
"reseller": "a00c4269-81bb-4ace-b395-cfe000015289",
"operator": "02ee5467-a204-4b6c-8fbd-3000833b66c0",
"sbc": "b707549d-c742-4524-9552-a8dd70bedf6a",
"serviceProvider": "39f5c3d4-be6f-41f9-8084-00078b6b6e82",
"group": "638d7cbf-0be0-44ca-b87d-0f1b6dfdb594",
"user": "0bddcebe-b10c-4469-8d6c-0df43d8f255e",
"callingCountry": "3008f0f8-e96e-4bf9-9cfd-ec017f131883",
"callingLocation": "842b96ac-5c10-44d7-af34-9eb9d7fa7390",
"calledCountry": "3008f0f8-e96e-4bf9-9cfd-ec017f131883",
"calledLocation": "ca3c87e9-47dd-4da5-b51b-28560e416f57"
}
]
}
Create SIP Report
The SIP Reports page can be used to pull a summarized report based on call data. Desired reports may be retrieved by applying various filters.
URL formatted for readability:
https://api.clearip.com/sipReports
?aggregates[]=count
&aggregates[]=count302
&aggregates[]=count400
&aggregates[]=count403
&aggregates[]=count404
&aggregates[]=count405
&aggregates[]=count484
&aggregates[]=count500
&aggregates[]=count503
&aggregates[]=count603
&filterOperator=and
&filters=[]
&from=DATE_RANGE_START_UNIX_TIME
&primaryGroupBy=GROUP_BY_FIELD
&limit=NUMBER_OF_RECORDS_RETURNED
&order=DESC_OR_ASC
&skip=0
&sortBy=SORT_BY_FIELD
&to=DATE_RANGE_END_UNIX_TIME
The from and to fields are timestamps which are formatted as the number of milliseconds since the Unix epoch, 1970-01-01 00:00:00.000 UTC.
Note: The SIP Reports API is used to generate the SIP Charts and SIP Maps in ClearIP. There is no separate API for the SIP Charts and SIP Maps. The ClearIP API can only be used to directly retrieve data in the form of the SIP Reports.
Response Body:
{
"sipReports": [
{
"id": "CLEARIP_SIP_REPORT_ROW_ID_HERE",
"translatedCalledNumber": "CLEARIP_ID_FROM_SELECTED_GROUPBY_FIELD_HERE",
"count": "TOTAL_COUNT_VALUE_HERE",
"count302": "302_COUNT_VALUE_HERE",
"count400": "400_COUNT_VALUE_HERE ",
"count403": "403_COUNT_VALUE_HERE ",
"count404": "404_COUNT_VALUE_HERE ",
"count405": "405_COUNT_VALUE_HERE ",
"count484": "484_COUNT_VALUE_HERE ",
"count500": "500_COUNT_VALUE_HERE ",
"count503": "503_COUNT_VALUE_HERE ",
"count603": "603_COUNT_VALUE_HERE "
},
{
"id": "CLEARIP_SIP_REPORT_ROW_ID_HERE",
"translatedCalledNumber": "CLEARIP_ID_FROM_SELECTED_GROUPBY_FIELD_HERE",
"count": "TOTAL_COUNT_VALUE_HERE",
"count302": "302_COUNT_VALUE_HERE",
"count400": "400_COUNT_VALUE_HERE ",
"count403": "403_COUNT_VALUE_HERE ",
"count404": "404_COUNT_VALUE_HERE ",
"count405": "405_COUNT_VALUE_HERE ",
"count484": "484_COUNT_VALUE_HERE ",
"count500": "500_COUNT_VALUE_HERE ",
"count503": "503_COUNT_VALUE_HERE ",
"count603": "603_COUNT_VALUE_HERE "
}
]
}
Example Request: Monitor Call Counts per User and Calling Number for Past Week Sorted by Descending SIP 302 Count
URL formatted for readability: https://api.clearip.com/sipReports
?aggregations[]=count
&aggregations[]=sip302Count
&aggregations[]=sip400Count
&aggregations[]=sip403Count
&aggregations[]=sip404Count
&aggregations[]=sip405Count
&aggregations[]=sip484Count
&aggregations[]=sip500Count
&aggregations[]=sip503Count
&aggregations[]=sip603Count
&filterOperator=and
&filters=[]
&from=1599055620000
&limit=20
&order=descending
&primaryGroupBy=user
&secondaryGroupBy=translatedCallingNumber
&skip=0
&sortBy=sip302Count
&to=1599660440495
Example Response: Monitor Call Counts per User and Calling Number for Past Week Sorted by Descending SIP 302 Count
{
"sipReports": [
{
"sip503Count": 1,
"sip403Count": 1,
"sip603Count": 1,
"sip400Count": 1,
"sip404Count": 1924,
"sip500Count": 1,
"count": 1555370,
"sip405Count": 1,
"user": "2de926c8-2be8-44c6-8e9c-0258a407b018",
"sip302Count": 1546446,
"translatedCallingNumber": "14077600036",
"sip484Count": 1,
"id": "56c8580b-eb56-49a3-9276-924accecd015"
},
{
"sip503Count": 1,
"sip403Count": 1,
"sip603Count": 1,
"sip400Count": 1,
"sip404Count": 1,
"sip500Count": 1,
"count": 12576,
"sip405Count": 1,
"user": "4fd00108-5ac0-4f13-a652-da0360a80c95",
"sip302Count": 12576,
"translatedCallingNumber": "12259269706",
"sip484Count": 1,
"id": "710b81bd-a39b-4737-b82f-eae78e0428a2"
}
]
}
Example Request: View Calling Countries of Calls From a Specific SBC
To generate this report, you will need to filter the calls from the desired SBC using the ClearIP SBC ID (in this example, b24f3584-3aad-40e6-874a-7b8b4c4ce9f1) as well as set the groupBy field to callingCountry.
URL formatted for readability: https://api.clearip.com/sipReports
?aggregates[]=count
&aggregates[]=count302
&aggregates[]=count400
&aggregates[]=count403
&aggregates[]=count404
&aggregates[]=count405
&aggregates[]=count484
&aggregates[]=count500
&aggregates[]=count503
&aggregates[]=count603
&filterOperator=and
&filters=[
{
“filterBy”: “sbc”,
“filterType”: “equals”,
“filterValue”: “baffe8c8-a95d-420f-8b92-65b90838f446”
}
]
&from=1593357360000
&primaryGroupBy=callingCountry
&limit=20
&order=DESC
&skip=0
&sortBy=count
&to=1595952900000
Example Response: View Calling Countries of Calls From a Specific SBC
{
"sipReports": [
{
"id": "b4a527c189cbae1aaf5efca643c871e0",
"callingCountry": "3008f0f8-e96e-4bf9-9cfd-ec017f131883",
"count": "96182",
"count302": "0",
"count400": "0",
"count403": "0",
"count404": "84401",
"count405": "0",
"count484": "0",
"count500": "0",
"count503": "0",
"count603": "11781"
},
{
"id": "21706cb74a420bcd3b2df9b2059f594b",
"callingCountry": "9ce80178-7232-46ef-9bfd-7c7a8ac1ec0d",
"count": "2495",
"count302": "0",
"count400": "0",
"count403": "0",
"count404": "2273",
"count405": "0",
"count484": "0",
"count500": "0",
"count503": "0",
"count603": "222"
}
]
}
Example Request: Monitor Call Counts per Hour to a Set of Specific Called Numbers
URL formatted for readability: https://api.clearip.com/sipReports
?aggregates[]=count
&aggregates[]=count302
&aggregates[]=count400
&aggregates[]=count403
&aggregates[]=count404
&aggregates[]=count405
&aggregates[]=count484
&aggregates[]=count500
&aggregates[]=count503
&aggregates[]=count603
&filterOperator=or
&filters=[
{
“filterBy”: “translatedCalledNumber”,
“filterType”: “equals”,
“filterValue”: “18887399192”
},
{
“filterBy”: “translatedCalledNumber”,
“filterType”: “equals”,
“filterValue”: “18888837228”
}
]
&from=1593392700000
&primaryGroupBy=hour
&limit=20
&order=DESC
&skip=0
&sortBy=count
&to=1595984760000
Example Response: Monitor Call Counts per Hour to a Set of Specific Called Numbers
{
"sipReports": [
{
"id": "c138a256ee35f25be020cf84bf93e211",
"hour": "1595275200000",
"count": "3225",
"count302": "0",
"count400": "0",
"count403": "0",
"count404": "3225",
"count405": "0",
"count484": "0",
"count500": "0",
"count503": "0",
"count603": "0"
},
{
"id": "fd80183b4dd268fa22459b6ec5d06d7c",
"hour": "1595271600000",
"count": "3064",
"count302": "0",
"count400": "0",
"count403": "0",
"count404": "3064",
"count405": "0",
"count484": "0",
"count500": "0",
"count503": "0",
"count603": "0"
}
]
}