API ReferenceMessages

Validate RCS Message

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.
OR
Rich MediaobjectRequired

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

See supported media types.

OR
Rich CardsobjectRequired

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

See supported file types.

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.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error