Messages API — Send and Retrieve Conversation Messages

The Messages API lets you retrieve message history from a conversation and send new messages programmatically. Use it to build chatbots, send automated follow-ups, or read conversation transcripts.

List messages in a conversation

Retrieve all messages in a conversation, ordered oldest to newest.

GET /conversations/{conversation_id}/messages

Path parameters

string

required

The ID of the conversation.

Query parameters

integer

Page number. Default: 1.

integer

Messages per page. Default: 50. Max: 100.

Example request

curl "https://api.sahut.id/v1/conversations/conv_01HX2B9K3M5N7P/messages" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "data": [
    {
      "id": "msg_01HX5E2N6P8R0S",
      "type": "incoming",
      "content": "Halo, saya ingin tanya tentang harga produk X",
      "sender": {
        "type": "contact",
        "id": "ct_01HX3C0L4N6P8Q",
        "name": "Budi Santoso"
      },
      "attachments": [],
      "created_at": "2024-03-15T08:30:00Z"
    },
    {
      "id": "msg_01HX5F3O7Q9S1T",
      "type": "outgoing",
      "content": "Halo Budi! Untuk harga produk X, saat ini adalah Rp 150.000 per unit.",
      "sender": {
        "type": "agent",
        "id": "usr_01HX0Z7I1K3L5M",
        "name": "Sari Dewi"
      },
      "attachments": [],
      "created_at": "2024-03-15T08:35:00Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  }
}

Message fields

string

Unique message ID.

string

incoming (from customer) or outgoing (from agent/bot) or activity (system event).

string

Text content of the message.

object

Who sent the message. Includes type (contact, agent, or bot), id, and name.

array

List of attached files. Each attachment has url, content_type, and file_name.

Send a message

Send a new message in a conversation. The message is delivered through the conversation’s channel.

POST /conversations/{conversation_id}/messages

Path parameters

string

required

The ID of the conversation to send a message in.

Request body

string

Text content of the message. Required unless sending a template message.

string

ID of a WhatsApp Message Template to send. Use for outbound WhatsApp messages to customers who haven’t messaged in the last 24 hours.

object

Key-value pairs for template variable substitution (e.g., {"name": "Budi", "order_id": "12345"}).

boolean

Set to true to send as an internal note (not visible to the customer). Default: false.

Example: send a text message

curl -X POST \
  https://api.sahut.id/v1/conversations/conv_01HX2B9K3M5N7P/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Terima kasih telah menghubungi kami. Pesanan Anda sudah kami proses."
  }'

Example: send a WhatsApp template message

curl -X POST \
  https://api.sahut.id/v1/conversations/conv_01HX2B9K3M5N7P/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "tmpl_order_confirmation",
    "template_variables": {
      "customer_name": "Budi",
      "order_id": "ORD-12345",
      "total": "Rp 450.000"
    }
  }'

Template messages require a pre-approved WhatsApp Message Template. Create and submit templates for approval in your Meta Business Manager account.

Overview

Endpoints

Messages API — Send and Retrieve Conversation Messages

List messages in a conversation

Path parameters

Query parameters

Example request

Example response

Message fields

Send a message

Path parameters

Request body

Example: send a text message

Example: send a WhatsApp template message

​List messages in a conversation

​Path parameters

​Query parameters

​Example request

​Example response

​Message fields

​Send a message

​Path parameters

​Request body

​Example: send a text message

​Example: send a WhatsApp template message

List messages in a conversation

Path parameters

Query parameters

Example request

Example response

Message fields

Send a message

Path parameters

Request body

Example: send a text message

Example: send a WhatsApp template message