Get RCS Capabilities | Pinnacle

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.

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.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

phoneNumberslist of stringsRequired

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

Limit: 1 min

agentIdstringOptionalformat: "^agent_.*"

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

Response

Returns RCS capabilities for each requested phone number.

The response is a map where keys are phone numbers and values are either:

null if the number doesn’t support RCS
An object containing supported cards and actions if RCS is supported

cardsobject

actionsobject

Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

501

Not Implemented Error

API Key authentication via header

This endpoint expects an object.

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

Limit: 1 min

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

Returns RCS capabilities for each requested phone number.

The response is a map where keys are phone numbers and values are either:

null if the number doesn’t support RCS
An object containing supported cards and actions if RCS is supported

Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.rcs.getCapabilities({});
8	}
9	main();

1	{
2	"+12345678901": {
3	"cards": {
4	"standalone": true,
5	"carousel": true
6	},
7	"actions": {
8	"openUrl": true,
9	"call": true,
10	"trigger": true,
11	"requestUserLocation": true,
12	"scheduleEvent": false,
13	"sendLocation": false
14	}
15	},
16	"+19876543210": null
17	}

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.rcs.getCapabilities({});
8	}
9	main();

1	{
2	"+12345678901": {
3	"cards": {
4	"standalone": true,
5	"carousel": true
6	},
7	"actions": {
8	"openUrl": true,
9	"call": true,
10	"trigger": true,
11	"requestUserLocation": true,
12	"scheduleEvent": false,
13	"sendLocation": false
14	}
15	},
16	"+19876543210": null
17	}