Introspect phone number

Validate a phone number and check if a WhatsApp conversation window is open.

POST /v1/introspect/phone

Introspect phone number

cURL

curl --request POST \
  --url https://api.zavu.dev/v1/introspect/phone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "[phone]"
}
'

200

{
  "phoneNumber": "<string>",
  "countryCode": "CL",
  "validNumber": true,
  "nationalFormat": "[phone]",
  "carrier": {
    "name": "Verizon Wireless"
  },
  "availableChannels": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

phoneNumber · string · required

Example:

"[phone]"

Response

200

application/json

Phone number introspection result.

phoneNumber · string · required

countryCode · string · required

Example:

"CL"

validNumber · boolean · required

nationalFormat · string

Phone number in national format.

Example:

"[phone]"

lineType · enum<string>

Type of phone line.

Available options: mobile, landline, voip, toll_free, unknown

carrier · object

Carrier information for the phone number.

Show child attributes

availableChannels · string[]

List of available messaging channels for this phone number.