Get RCS Capabilities API Reference

Serverhttps://api.pinnacle.sh/

Check RCS capabilities for one or more phone numbers.

This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported on specific phone numbers before sending RCS messages to them.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for checking RCS capabilities of phone numbers

phoneNumbersarray<string>

List of phone numbers to check RCS capabilities for (E.164 format).

Limit: 1 min

Items

1 <= items

Each item

Match

^\+[1-9]\d{1,14}$

Example

"+12345678901"

agentIdstringOptional

Optional RCS agent ID (prefixed with 'agent_') to check capabilities of a number from a specific agent.

Match

^agent_.*

Example

"agent_pinnacle"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.rcs.getCapabilities({
    phoneNumbers: ["+12345678901", "+19876543210"]
});

Responses

{  "+12345678901": {    "cards": {      "standalone": true,      "carousel": true    },    "actions": {      "openUrl": true,      "call": true,      "trigger": true,      "requestUserLocation": true,      "scheduleEvent": false,      "sendLocation": false    }  },  "+19876543210": null}

Get RCS Capabilities

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

500application/json

501application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`