v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-02172186551.1 KB

List messages

List messages previously sent by this project.

get/v1/messages

Query parameters

status'queued' | 'sending' | 'sent' | 'delivered' | 'failed' | 'received'

Filter by status. Not all stored statuses are filterable.

tostring
channel'sms' | 'sms_oneway' | 'whatsapp' | 'email' | 'telegram' | 'instagram' | 'messenger' | 'voice'

Filter by delivery channel.

limitinteger
cursorstring

Response

List of messages.

nextCursorstring nullable

Example response

{
  "items": [
    {
      "id": "jd7x2k3m4n5p6q7r8s9t0",
      "to": "+56912345678",
      "from": "+13125551212",
      "senderId": "sender_12345",
      "content": {
        "mediaUrl": "https://example.com/image.jpg",
        "mimeType": "image/jpeg",
        "filename": "invoice.pdf",
        "ctaDisplayText": "See Dates",
        "ctaUrl": "https://example.com/schedule",
        "footerText": "Dates subject to change.",
        "templateVariables": {
          "1": "John",
          "2": "ORD-12345"
        },
        "templateButtonVariables": {
          "0": "abc-report-token"
        },
        "templateHeaderVariables": {
          "1": "Jorge y Laura"
        }
      },
      "conversationId": "js723987cyghwqxxaxcf590qd18axd95"
    }
  ]
}