Validate Phone Number

From docs
Jump to: navigation, search

Mobile_API »Validate Dial Number

Base URL

https://apimobile.callproof.com

Endpoint

/api/validate-dial-number/{phone_number}

Purpose

Validates a phone number for dialing. If the number already exists for the user’s company, returns the matching contact/phone details. If it does not exist, creates an “unknown” contact for that number and returns the new contact/phone details, including recent notes and image when available.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
phone_number string Yes Phone number to validate for dialing

Query Parameters

None.

Request Body

None.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/validate-dial-number/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/validate-dial-number/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Returns contact and phone details for the validated number.

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
data object Dial validation payload
uri string Requested resource URI

data

Field Type Description
contact_phone_id integer Unique identifier of the contact phone record
contact_id integer Unique identifier of the contact
contact_person_name string Name of the linked person, when available
phone_type_id integer Phone type identifier
phone_number string Validated phone number
company_id integer Company identifier
company_name string Company name
contact_company_name string Contact company name
ext string Phone extension, when available
country_code string Dialing/country code
country_iso_code string Country ISO code
contact_type_id integer Contact type identifier
contact_type_name string Contact type name
unknown boolean Whether the contact/phone is marked as unknown
image string Contact/person image path or URL, when available
notes string Latest notes for the contact/number, when available

Error Responses

Status Code Meaning
400 Bad Request – the dial number could not be validated
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – Phone/contact details could not be resolved (for example, "Contact Phone Id is Invalid"), or another processing error.
  • 401 – Authentication failed or the access token is missing/expired.