POST
/
messages
/
interactive
/
send-cta

Sends a message with a URL button (Call to Action). This is supported on WhatsApp and Z-API channels.

Request Body

  • agentId: The ID of the agent.
  • conversationId: The ID of the conversation.
  • header_text: (Optional) Header text.
  • body_text: Main message body.
  • footer_text: (Optional) Footer text.
  • button_display_text: Label for the URL button.
  • button_url: The URL to open (must be a valid URL).

Example

{
  "agentId": "agent-123",
  "conversationId": "conv-456",
  "body_text": "Visit our website for more information.",
  "button_display_text": "Open Website",
  "button_url": "https://chatvolt.com"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agentId
string
required

The ID of the agent.

conversationId
string
required

The ID of the conversation.

header_text
string

Optional header text.

body_text
string
required

Main message body.

footer_text
string

Optional footer text.

button_display_text
string
required

Label for the URL button.

button_url
string
required

The URL to open.