AGagentphone
contacts

Get Contact Capabilities

Changed on

Check which messaging channels a phone number supports, without sending a message.

Runs a live check (typically 1-2 seconds), so the result reflects the number right now. Capabilities can still change by the time you send. Requires at least one active iMessage-capable or RCS number on the account; each flag is null when your account holds no line that could act on it (rcs reachability is checked against YOUR agents, so it can differ per account while an agent is pre-launch).

get/v1/contacts/capabilities

Request

  • Base URL
    https://api.agentphone.ai
  • URL
    https://api.agentphone.ai/v1/contacts/capabilities
  • Auth
    HTTP bearer

Query parameters

phone_numberstring required

Phone number to check (E.164 preferred; URL-encode + as %2B)

Response

Successful Response

phoneNumberstring required
checkedAtstring date-time required

Changes

  • 784718edd537Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      response property capabilities/imessage list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property capabilities/sms list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the optional property / to the response with the status