Skip to content

Messages

View message history for your organization.

List messages

GET /v1/messages

Retrieve a paginated list of messages (SMS, email, etc.).

Required scope: messages:read

Query parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
limitintegerResults per page (default: 20, max: 100)
channelstringFilter by channel: sms, email, whatsapp

Example

bash
curl "https://api.replicer.ai/v1/messages?channel=sms&limit=10" \
  -H "Authorization: Bearer rpl_live_your_key"

Response 200 OK

json
{
  "data": [
    {
      "id": "clx-msg-001",
      "channel": "sms",
      "direction": "OUTBOUND",
      "status": "delivered",
      "fromAddress": "+0987654321",
      "toAddress": "+1234567890",
      "subject": null,
      "body": "Hi John, confirming your appointment tomorrow at 2 PM.",
      "externalId": "ext-sms-abc",
      "errorMessage": null,
      "createdAt": "2026-04-05T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 30,
    "totalPages": 3
  },
  "requestId": "req-abc123"
}

Message fields

FieldTypeDescription
idstringUnique message ID
channelstringDelivery channel (sms, email, whatsapp)
directionstringINBOUND or OUTBOUND
statusstringDelivery status
fromAddressstringSender address/number
toAddressstringRecipient address/number
subjectstring | nullEmail subject (null for SMS)
bodystringMessage content
externalIdstring | nullExternal provider message ID
errorMessagestring | nullError details if delivery failed
createdAtstringISO 8601 timestamp

Send SMS

POST /v1/messages/sms

Coming soon

This endpoint is planned but not yet available. It currently returns 503 Not Implemented.

Required scope: messages:write

A dedicated Go messaging worker is being developed. Once available, this endpoint will allow you to send SMS messages programmatically.

Replicer API Documentation