Pure CallerID provides several event types for webhook notifications. See the following event types and associated example payloads for reference.
Method: POST
Content-Type: application/json
x-event-type: CampaignList, InboundCall, SMSMessage, PhoneDeactivated PhoneProvisioned, Sentry, UCProtect, AegisEvent
x-event-origin: purecallerid.app
Example Payloads
Aegis workflow webhook
{
"id": "98zy7x6wv5432u1t098765sr",
"orgId": 10000,
"workspaceId": 99999,
"workflowId": "123a45678bc90d12e34567fg",
"to": "+15551234567",
"timestamp": "2024-10-21T11:16:48.285Z",
"result": "Accepted",
"channelType": "Voice",
"reason": "DataBoost",
"from": "+15559876543",
"pcidFromNumber": "+15559876543",
"city": "New York",
"state": "NY",
"zip": "12345",
"originalZip": "54321",
"timezone": "UTC",
"isTest": false,
"isSipTrunk": true,
"validationResult": {
"phone_number": "+1234567890",
"is_valid": true,
"activity_score": 85,
"line_type": "mobile",
"carrier": "Verizon Wireless",
"is_prepaid": false
},
"doNotCallResult": {
"blocked": true,
"sanCoverage": true,
"reason": "Customer opt-in"
},
"stateDoNotCallResult": {
"blocked": true,
"reason": "National DNC Record Found"
},
"sipCallResult": {
"duration": 300,
"callId": "v3:24iiVu6-JmbDNrj5Kg2_eSVeCWbWXit-uxS20GdO1adcuOhL2Y5kAA",
"status": "completed",
"hangupCause": 200
},
"rndStatus": "no",
"activeProspectResult": {
"outcome": "error",
"reason": "No certificate provided"
},
"startTime": "2024-10-21T11:16:48.285Z",
"finishTime": "2024-10-21T11:16:49.198Z",
"currentIterations": 1,
"currentNodeId": "02c0fb0f-91ca-400b-8779-627e4a492f43",
"data": {},
"events": [
{
"timestamp": "2024-10-21T11:16:48.335Z",
"type": "INFO",
"message": "Start"
},
{
"timestamp": "2024-10-21T11:16:48.628Z",
"type": "INFO",
"message": "RecordSet: TEST - Record found"
},
{
"timestamp": "2024-10-21T11:16:48.628Z",
"type": "INFO",
"message": "ReassignedNumberDatabase: Using 2024-03-01 for query to RND"
},
{
"timestamp": "2024-10-21T11:16:49.147Z",
"type": "INFO",
"message": "ReassignedNumberDatabase: C040206343 - Pure CallerId - OK"
},
{
"timestamp": "2024-10-21T11:16:49.198Z",
"type": "WARNING",
"message": "ActiveProspect: Pure CallerID - error:No certificate provided"
}
]
}
Campaign list result
{
"events": [
{
"timestamp": "2024-07-31T12:19:47.093Z",
"type": "INFO",
"message": "list successfully loaded."
},
{
"timestamp": "2024-07-31T12:19:44.893Z",
"type": "INFO",
"message": "Starting processing"
},
{
"timestamp": "2024-07-31T12:19:44.101Z",
"type": "INFO",
"message": "Starting provisioning"
},
{
"timestamp": "2024-07-31T12:19:43.679Z",
"type": "INFO",
"message": "Queued for processing"
}
],
"id": "98zy7x6wv5432u1t098765sr",
"orgId": 10000,
"workspaceId": 99999,
"campaignId": "123a45678bc90d12e34567fg",
"dialerListId": null,
"messagingListId": null,
"dialerListName": "Sample List",
"firstRowHeaders": true,
"name": "Sample_List.csv",
"file": {
"region": "us-east-2",
"bucket": "pcid-prod99",
"path": "10000/workspaces/99999/campaigns/123a45678bc90d12e34567fg/",
"fileName": "ebc598cd-45d5-4d65-b6d3-0e236316ee0a",
"fileType": "FILE",
"timestamp": "2024-07-31T12:18:37.519Z"
},
"processedFile": {
"region": "us-east-2",
"bucket": "pcid-prod99",
"path": "10000/workspaces/99999/campaigns/123a45678bc90d12e34567fg/",
"fileName": "66aa2b9de1870d3f392035dd16084794860909151294.csv",
"fileType": "CSV",
"timestamp": "2024-07-31T12:19:47.093Z"
},
"uploaded": "2024-07-31T12:18:36.999Z",
"status": "FINALIZED",
"metrics": {
"valid": 20,
"landline": 20,
"mobile": 0,
"invalid": 0,
"inactive": 0,
"tcpa": 0,
"dnc": 0,
"tokenError": 0,
"duplicate": 0,
"dialerRejected": 0,
"rejected": 0,
"billableTransactions": 20,
"total": 20
},
"mode": "APPEND",
"type": "DIALER",
"dedupe": "RING_RETAIN_ALL",
"crmUpdateMode": null,
"crmAddMode": null,
"listAddMode": null,
"callNowMode": null,
"uploadType": "UPLOAD",
"nextImport": null,
"reimportListId": null,
"processingStart": "2024-07-31T12:19:44.893Z",
"processingFinish": "2024-07-31T12:19:47.093Z",
"processedBy": {
"id": "999aaa88bb77cc66dddd555e",
"firstName": "Joanne",
"lastName": "Smith",
"email": "joannesmith@gmail.com"
},
"mapping": [
{
"columnIndex": 0,
"columnId": "externId"
},
{
"columnIndex": 1,
"columnId": "firstName"
},
{
"columnIndex": 2,
"columnId": "lastName"
},
{
"columnIndex": 3,
"columnId": "address1"
},
{
"columnIndex": 4,
"columnId": "address2"
},
{
"columnIndex": 5,
"columnId": "city"
},
{
"columnIndex": 6,
"columnId": "state"
},
{
"columnIndex": 7,
"columnId": "zip"
},
{
"columnIndex": 10,
"columnId": "leadPhone"
},
{
"columnIndex": 16,
"columnId": "title"
},
{
"columnIndex": 17,
"columnId": "auxData5"
},
{
"columnIndex": 20,
"columnId": "auxData2"
},
{
"columnIndex": 21,
"columnId": "auxData3"
},
{
"columnIndex": 22,
"columnId": "auxData4"
}
],
"phoneColumn": null,
"fileHeaders": [
"NEW_MBR_ID",
"FRST_NM",
"LST_NM",
"SRC_ADDR_LN_1_TXT",
"SRC_ADDR_LN_2_TXT",
"SRC_CITY_NM",
"SRC_STATE_DEST_TXT",
"SRC_POST_CD",
"PRIM_PHONE_NBR",
"MBR_TYP",
"MEMBER LEVEL",
"",
"",
"",
"POINT_BALANCE"
],
"originalFileHeaders": [
"NEW_MBR_ID",
"FRST_NM",
"LST_NM",
"SRC_ADDR_LN_1_TXT",
"SRC_ADDR_LN_2_TXT",
"SRC_CITY_NM",
"SRC_STATE_DEST_TXT",
"SRC_POST_CD",
"SRC_CTRY_DESC",
"PRIM_PHONE_AREA_CD",
"PRIM_PHONE_NBR",
"PRIM_PHONE_IND",
"LastCkOutDate",
"LST_STAY_BRAND",
"MBR_TYP",
"DOMINANT_BRAND",
"MEMBER LEVEL",
"POINT_BALANCE",
"EFFORT_ID",
"Time_Zone"
],
"webhookUrl": "https://webhookUrl.com",
"skillId": null,
"processingDuration": 2
}
Inbound call backs
{
"id": "65897e7e80ec9661aceeedf5",
"orgId": 10000,
"workspaceId": 99999,
"campaignId": "123a45678bc90d12e34567fg",
"timestamp": "2024-11-06T20:05:23.853Z",
"vendorCallId": "02f63a9c-9938-4137-9c4e-ca15415f8f8e",
"callStatus": "COMPLETED",
"caller": "+15555550123",
"called": "+15551234567",
"forwardedTo": "+15559876543",
"duration": 300
}
Inbound SMS messages
{
"id": "672bcc0344f5ba7b8815f387",
"orgId": 10000,
"workspaceId": 99999,
"campaignId": "123a45678bc90d12e34567fg",
"timestamp": "2024-11-06T20:05:23.853Z",
"vendorMessageId": "02f63a9c-9938-4137-9c4e-ca15415f8f8e",
"from": "33333",
"to": "+15551234567",
"message": "Sample message",
"status": "RECEIVED",
"segments": 1
}
Phone number deactivated
{
"orgId": 10000,
"workspaceId": 99999,
"campaignId": "123a45678bc90d12e34567fg",
"campaignName": "Sample Campaign",
"numbers": [
{
"number": "+15551234567",
"locality": "New York",
"region": "NY",
"postal": null
}
]
}
Phone number provisioned
{
"orgId": 10000,
"workspaceId": 99999,
"campaignId": "123a45678bc90d12e34567fg",
"campaignName": "Sample Campaign",
"numbers": [
{
"number": "+15551234567",
"locality": "New York",
"region": "NY",
"postal": null
}
]
}
Real time list load
{
"events": [],
"id": "6764688f3f5cf3043869d8b9",
"orgId": 10000,
"workspaceId": 99999,
"campaignId": "123a45678bc90d12e34567fg",
"dialerListId": null,
"messagingListId": null,
"dialerListName": "Sample List",
"firstRowHeaders": true,
"name": "API LIST",
"file": null,
"processedFile": null,
"uploaded": "2024-12-19T18:40:15.887Z",
"status": "API",
"metrics": {
"valid": 2,
"landline": 2,
"mobile": 0,
"invalid": 0,
"inactive": 0,
"tcpa": 0,
"dnc": 0,
"tokenError": 0,
"duplicate": 0,
"dialerRejected": 0,
"total": 2,
"rejected": 0,
"billableTransactions": 2
},
"mode": "APPEND",
"type": "DIALER",
"dedupe": "RING_RETAIN_ALL",
"crmUpdateMode": null,
"crmAddMode": null,
"listAddMode": null,
"callNowMode": null,
"uploadType": null,
"nextImport": null,
"reimportListId": null,
"processingStart": "2024-12-19T18:40:15.887Z",
"processingFinish": null,
"processedBy": {
"id": "999aaa88bb77cc66dddd555e",
"firstName": "Joanne",
"lastName": "Smith",
"email": "joannesmith@gmail.com"
},
"mapping": [],
"phoneColumn": null,
"fileHeaders": null,
"originalFileHeaders": null,
"webhookUrl": null,
"skillId": null,
"processingDuration": 4829156
}
Sentry replacement
{
"orgId": 10000,
"workspaceId": 99999,
"campaignId": "123a45678bc90d12e34567fg",
"campaignName": "Sample Campaign",
"replacements": [
{
"original": "+15551234567",
"replacement": "+15559876543"
}
]
}
UCProtect SPAM Risk
{
"businessRecord": {
"id": "65897e7e80ec9661aceeedf5",
"orgId": 10000,
"workspaceId": 99999,
"resourceStatus": "ACTIVE",
"validUntil": null,
"dateCreated": "2023-12-26T20:41:12.666Z",
"dateUpdated": "2023-12-26T20:41:12.667Z",
"cnams": [
{
"id": "25ae839a-08b5-40e3-bbb7-29c07fb22469",
"name": "Pure CallerID"
}
],
"ucProtectBrandedCallingProfileId": null,
"appToPersonCampaigns": [
{
"id": "4b20018c-9c89-be71-7e18-7e7ae70c0ec2",
"name": "Pure CallerID",
"resourceStatus": "ACTIVE",
"dateCreated": "2023-12-26T20:41:12.693Z",
"dateUpdated": "2023-12-26T20:41:12.694Z"
}
],
"legalName": "Pure CallerID",
"callCategory": "Informational",
"callsPerMonth": 10000,
"ein": "99-1111111",
"website": "www.purecallerid.com",
"phone": "5551234567",
"address": {
"address1": "123 N MAIN ST",
"address2": "",
"city": "NEW YORK",
"state": "NY",
"zip": "12345"
},
"contact": {
"firstName": "Maggie",
"lastName": "Smith",
"title": "President",
"email": "example@purecallerid.com",
"phone": "5551234567"
}
},
"spamRisk": [
{
"events": [
{
"timestamp": "2024-11-07T16:43:41.005Z",
"type": "INFO",
"message": "Scan completed. SPAM Activity: MEDIUM"
},
{
"timestamp": "2024-06-21T19:59:04.461Z",
"type": "INFO",
"message": "Scan completed. SPAM Activity: LOW"
},
{
"timestamp": "2024-04-11T19:12:32.835Z",
"type": "INFO",
"message": "Number provisioned"
}
],
"number": "+15559876543",
"orgId": 10000,
"workspaceId": 99999,
"businessRecordId": "65897e7e80ec9661aceeedf5",
"businessRecordName": "Pure CallerID",
"description": "Test Example",
"status": "ACTIVE",
"createdTime": "2024-04-11T19:12:32.835Z",
"lastScanTime": "2024-11-07T16:43:41.005Z",
"nextScanTime": "2024-11-14T16:43:41.005Z",
"spamResult": {
"spamScore": 48,
"riskLevel": "MEDIUM",
"cleanCall": {
"reason": "CleanCall",
"recommendation": "PASS",
"riskLevel": "LOW"
},
"icehookScout": {
"risk_rating": "possible",
"risk_level": 48,
"riskLevel": "LOW"
},
"nomoRobo": {
"score": 1,
"neighbor_score": 0,
"riskLevel": "HIGH"
},
"trueSpam": {
"spam_score": 0,
"spam_score_match": 1,
"riskLevel": "LOW"
}
},
"validationResult": {
"phone_number": "+15559876543",
"is_valid": true,
"activity_score": 60,
"line_type": "NonFixedVOIP",
"carrier": "Pinger - Bandwidth.com - Sinch",
"is_prepaid": false,
"active": true,
"mobile": false
},
"ftcComplaints": 0,
"npaNxx": {
"id": "64482b1628d3f4d901103ee8",
"npa": "555",
"nxx": "987",
"state": "NY",
"zip": "12345",
"lat": 40.73061,
"lon": -73.93524
},
"cnam": {
"name": "TEST EXAMPLE",
"type": "BUSINESS",
"invalid": false
},
"newSpamFlag": true,
"registrationPending": false
}
]
}