API ReferenceRCS Agents

Generate RCS Link

Generate a link for initiating an RCS conversation with your agent. Users can click these links to start conversations with your RCS agent directly from websites, emails, or other applications.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
agentIdstringRequiredformat: "^agent_.*"

The RCS agent ID (must be prefixed with ‘agent_’)

testModebooleanOptionalDefaults to false
Link to the test agent or the production agent if false
phoneNumberstringOptionalformat: "^\+[1-9]\d{1,14}$"

Fallback phone number (E.164 format) to use if the phone number does not support RCS. If not provided, no url will be generated.

bodystringOptional<=1000 characters

Optional message body to pre-fill after the user clicks the link

Response

Response containing the generated RCS service id and/or url. You can always create a link with the service id that is returned using the format: ``` sms://{PHONE_NUMBER}?service_id={SERVICE_ID}&body={URL_ENCODED_BODY} ```
serviceIdstring
The service ID used for the link
urlstringformat: "uri"
The generated RCS link URL. If no phone number is provided, no url will be generated.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
501
Not Implemented Error