rcs

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.

post/rcs/link

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/rcs/link
  • Auth: API key in header PINNACLE-API-KEY

Request body

agentIdstring required

The RCS agent ID (must be prefixed with 'agent_')

phoneNumberstring

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

bodystring

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}
urlstring uri

The generated RCS link URL. If no phone number is provided, no url will be generated.

serviceIdstring required

The service ID used for the link

Changes

No recorded changes to this operation across all 1 revision of this API.