Phone Intelligence
Validates a phone number and returns its E.164, national and international formats, country, calling code and line type.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ phone. intelligenceAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/phone.intelligence with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/phone.intelligence" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"phone_number":"+14155552671"}'const res = await fetch('https://api.primaryapi.com/v1/run/phone.intelligence', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
phone_number: '+14155552671',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/phone.intelligence",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"phone_number": "+14155552671",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "phone.intelligence",
"input": {
"phone_number": "+14155552671"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/phone.intelligence" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"phone_number":"+14155552671"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
phone_numberstringrequired- Phone number in E.164 (+14155552671) or national format together with `country`.max 32 chars
countrystring- ISO 3166-1 alpha-2 default region used to parse a national-format phone_number, for example "us". Not needed for E.164.exactly 2 chars
Output
When output.found is true, output.data has these fields.
phoneNumberstring- E.164 form.
validboolean- The number is in an assignable range of its numbering plan.
countryCodestring | null- ISO 3166-1 alpha-2 country of the number.
callingCodestring | null- Country calling code, for example "1".
nationalFormatstring | nullinternationalFormatstring | nullregionstring | null- State, province or area when the source knows it.
timezonesstring[]- IANA time zones when the source knows them.
lineTypeenum- one of: mobile, landline, voip, toll_free, premium_rate, shared_cost, personal, pager, uan, voicemail, fixed_line_or_mobile, unknown
carrierobject | null- Current (portability-aware) carrier; null when the serving source cannot tell.
carrier.namestring | nullcarrier.typestring | nullcarrier.mccstring | nullcarrier.mncstring | nullcarrier.ocnstring | nullcarrier.lrnstring | nullportedboolean | null- null when the serving source cannot tell.
numberStatusenum- "valid"/"invalid" = numbering-plan check only; "active"/"inactive" come from live carrier sources.one of: active, inactive, invalid, valid, unknown
reachableboolean | null- Handset reachability; only HLR-grade sources fill it.
coverageenum- What kind of data answered: live US/CA carrier data, static international data, or offline numbering-plan metadata.one of: live-nanp, international-static, offline
sourcestring- Identifier of the data source that answered.
TypeScript type
/** output.data when output.found is true */
type PhoneIntelligence = {
/** E.164 form. */
phoneNumber: string;
/** The number is in an assignable range of its numbering plan. */
valid: boolean;
/** ISO 3166-1 alpha-2 country of the number. */
countryCode: string | null;
/** Country calling code, for example "1". */
callingCode: string | null;
nationalFormat: string | null;
internationalFormat: string | null;
/** State, province or area when the source knows it. */
region: string | null;
/** IANA time zones when the source knows them. */
timezones: string[];
lineType: "mobile" | "landline" | "voip" | "toll_free" | "premium_rate" | "shared_cost" | "personal" | "pager" | "uan" | "voicemail" | "fixed_line_or_mobile" | "unknown";
/** Current (portability-aware) carrier; null when the serving source cannot tell. */
carrier: {
name: string | null;
type: string | null;
mcc: string | null;
mnc: string | null;
ocn: string | null;
lrn: string | null;
} | null;
/** null when the serving source cannot tell. */
ported: boolean | null;
/** "valid"/"invalid" = numbering-plan check only; "active"/"inactive" come from live carrier sources. */
numberStatus: "active" | "inactive" | "invalid" | "valid" | "unknown";
/** Handset reachability; only HLR-grade sources fill it. */
reachable: boolean | null;
/** What kind of data answered: live US/CA carrier data, static international data, or offline numbering-plan metadata. */
coverage: "live-nanp" | "international-static" | "offline";
/** Identifier of the data source that answered. */
source: string;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"phoneNumber": "string",
"valid": true,
"countryCode": "string",
"callingCode": "string",
"nationalFormat": "string",
"internationalFormat": "string",
"region": "string",
"timezones": [
"string"
],
"lineType": "mobile",
"carrier": {
"name": "string",
"type": "string",
"mcc": "string",
"mnc": "string",
"ocn": "string",
"lrn": "string"
},
"ported": true,
"numberStatus": "active",
"reachable": true,
"coverage": "live-nanp",
"source": "string"
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Currently answered from numbering-plan metadata (coverage "offline"): carrier, porting and reachability are null. An invalid number is still a result (valid=false); unparseable input is rejected with HTTP 400 and no charge.
More Phone endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/phone.intelligence.