Messaging · RCS

Check RCS capability

Checks an RCS capability.

GEThttps://api.pozy.ai/v1/rcs/capabilities
getRcsCapabilities

Guide: RCS

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

NameTypeNotes
agentIdrequiredstring
numbersrequiredstring

Example

curl -X GET "https://api.pozy.ai/v1/rcs/capabilities?agentId=6b99fbd950277956c14bd44d&numbers=string" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • capabilitiesarray of object
    • phoneNumberstring
    • rcsCapableboolean
    • featuresarray of string
200 response
{
  "capabilities": [
    {
      "phoneNumber": "+14155550123",
      "rcsCapable": true,
      "features": [
        "string"
      ]
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in RCS