Skip to content

Introspect phone number

View .md
POST

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

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Body

application/json

  • phoneNumberstringrequired

Responses

200Phone number introspection result.
  • phoneNumberstringrequired
  • countryCodestringrequired
  • validNumberbooleanrequired
  • nationalFormatstring

    Phone number in national format.

  • lineTypestring

    Type of phone line.

    One ofmobilelandlinevoiptoll_freeunknown
  • carrierobject

    Carrier information for the phone number.

    2 properties
    • namestringnullable

      Carrier name.

    • typestring

      Type of phone line.

      One ofmobilelandlinevoiptoll_freeunknown
  • availableChannelsstring[]

    List of available messaging channels for this phone number.

400Invalid phone number.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject