Skip to main content
The Conversations resource lets you access conversation data, retrieve messages, send responses, and manage user credits.

Overview

List Conversations

Retrieve conversations with optional filters.

Filter Parameters

Response Type

Get Conversation

Retrieve a single conversation.

Get Messages

Retrieve all messages in a conversation.

Message Type

Send Message

Send a text message to a conversation (as the agent).

Input

This sends a message as the agent, not as a user. Use this for manual interventions or human handoff scenarios.

Send Template Message

Send a WhatsApp-approved template message.

Input

Template messages must be pre-approved by WhatsApp. Create templates in your WhatsApp Business Manager or via the API before using them.

Trigger Bot

Trigger the agent to respond with a custom prompt.
This causes the agent to generate a response based on the prompt, without requiring a user message.

Use Cases

  • Proactive outreach after events
  • Scheduled check-ins
  • Follow-up messages
  • System-triggered notifications

Use Cases

  • Grant credits after purchase
  • Bonus credits for promotions
  • Manual adjustments

Working with Message Types

Text Messages

Image Messages

CTA Button Clicks

Track button engagement:

Complete Example

Agents

Manage the agents behind conversations.

WhatsApp Accounts

Manage phone numbers and templates.