Phone
- : Access to the public API
OAuth2 client credentials flow for API access
Payload to submit a new phone quality job.
Important: For proper normalization and country detection, either:
- Provide a phone number with international code (e.g., "+33672557378"), OR
- Provide the phone number along with
countryorcountry_code
If none of these conditions are met, the system may not be able to properly detect the country and apply the related normalization.
The phone number. Should include international code (e.g., '+33672557378') for automatic country detection. If not provided, 'country' or 'country_code' must be specified.
+33672557378The country name of the phone number (e.g., 'France'). Required if phone number does not include international code (+XX).
FranceThe 2-letter ISO country code of the phone number.Required if phone number does not include international code (+XX).
FRJob submitted to assess_phone_v16
Response after submitting a new phone quality job.
The job ID. Required if status <= 300.
21014abc65004d2781d2e0ef4c9fbb46The message to return
Job submitted to assess_phone_v16The status of the process
SUCCESSPossible values: The status code to return
202Invalid phone format or missing required fields
Authentication failed - invalid or missing OAuth 2.0 token
Payment Required
Internal server error
Service unavailable
- : Access to the public API
OAuth2 client credentials flow for API access
The unique identifier of the phone job
{"summary":"Sample job ID","value":"21014abc65004d2781d2e0ef4c9fbb46"}Job succeeded.
Job is still running.
Response after retrieving the status and result of an phone quality job.
A human-readable message describing the current state or outcome of the job.
Job succeeded.The status of the process
SUCCESSPossible values: The HTTP status code representing the job's current state.
200The result of the phone quality job
{"area":"France","carrier":"Orange France","data_type":"phone","normalized_value":"+33672557378","phone_type":"MOBILE","scores":{"accuracy":-1,"completeness":1,"consistency":1,"validity":1},"timezone":"Europe/Paris","zone":"FR"}The total time taken to process the job, in seconds.
0.123Input validation failed.
Authentication failed - invalid or missing OAuth 2.0 token
Failed to retrieve job.
Job timed out.
Last updated
Was this helpful?