Retrieves a list of active phone in a workspace.
URL: https://core.purecallerid.app/api/public/campaign/phoneInventory
Method: GET
Content-Type: application/json
Security: A custom HTTP header must be included in the POST request. The Header name is "X-API-KEY" and the value passed within this header is one of the encrypted API keys associated with your workspace.
Query Params:
- campaignId - (Optional) - If provided, only phone numbers for the specified campaign will be returned. When omitted, all phone numbers in the workspace will be returned.
Response Format:
[
{
"number": "+19015548300",
"orgId": 1,
"workspaceId": 14,
"campaignId": "66b4d9abf64c1d56322c2444",
"status": "ACTIVE",
"locality": "Memphis",
"region": "TN",
"country": "US",
"created": "2024-07-22T23:34:43.597Z",
"expireAt": null,
"matureAt": null,
"usageCount": 0,
"riskLevel": "LOW"
}
]
Definitions:
-
status:
- ACTIVE - In Service
- MATURING - Recently provisioned - in SPAM prevention registration stage
- AGING - Number is being decommissioned and will be deleted soon
- usageCount: The number of times this phone number has been mapped to a lead or Aegis interaction
- riskLevel: current SPAM risk level: LOW, MEDIUM, HIGH