Validate RCS Message | Pinnacle

Validate RCS message content without sending it.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

Rich TextobjectRequired

Message containing longer text content with optional quick reply buttons.

Rich MediaobjectRequired

Message containing a media file and/or text with optional quick reply buttons.

See supported media types.

Message containing a media file and/or text with optional quick reply buttons.<br> See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).

Rich CardsobjectRequired

Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added.

See supported file types.

Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br> See [supported file types](https://app.pinnacle.sh/supported-file-types?type=RCS-CARD).

Response

Returns validation results.

totaldouble

Total price of this message. Calculated by multiplying the number of messages by the unit cost.

unitdouble

Cost per message.

segmentsinteger

Total number of segments used across the message.

unsupportedFileslist of strings

List of unsupported media file names or URLs.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.messages.rcs.validate({
8	quickReplies: [
9	{
10	type: "openUrl",
11	payload: "https://www.pinnacle.sh/",
12	title: "Open Url",
13	},
14	],
15	text: "Check out our website for more information!",
16	});
17	}
18	main();

1	{
2	"total": 0.035,
3	"unit": 0.035,
4	"segments": 1,
5	"unsupportedFiles": []
6	}

Authentication

Request

Response

Errors