List Messages

[
  {
    "id": "id",
    "conversationId": "conversationId",
    "type": "OUTBOUND",
    "content": "content",
    "messageStatus": "messageStatus",
    "messageStatusReason": "messageStatusReason",
    "messageSid": "messageSid",
    "customerStatus": "customerStatus",
    "idempotencyId": "idempotencyId",
    "isAutomated": true,
    "needsHelp": true,
    "needsHelpDetails": {
      "reason": "reason",
      "flaggedByType": "agent",
      "flaggedById": "flaggedById",
      "flaggedAt": "2024-01-15T09:30:00Z",
      "resolvedByType": "agent",
      "resolvedById": "resolvedById",
      "resolvedAt": "2024-01-15T09:30:00Z"
    },
    "subject": "subject",
    "emailAddress": "emailAddress",
    "attachments": [
      {}
    ],
    "metadata": {
      "key": "value"
    },
    "organizationId": "organizationId",
    "customerId": "customerId",
    "prospectId": "prospectId",
    "userId": "userId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z"
  }
]

Available by Request

List messages, narrowed by conversation or by one of the identifiers assigned when the message was created. Supply exactly one of conversationId, idempotencyId, or messageSid.

Use idempotencyId to confirm whether a send you issued was recorded, and messageSid to resolve a carrier identifier from a delivery receipt back to the Fortress message. To read a message whose Fortress id you already hold, use GET /messages/{messageId} instead.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Filtering, sorting, field selection, and pagination are not available on this endpoint. The fields, sort, filter, page, and limit query parameters are ignored.

<Badge>Available by Request</Badge> List messages, narrowed by conversation or by one of the identifiers assigned when the message was created. Supply exactly one of `conversationId`, `idempotencyId`, or `messageSid`. Use `idempotencyId` to confirm whether a send you issued was recorded, and `messageSid` to resolve a carrier identifier from a delivery receipt back to the Fortress message. To read a message whose Fortress `id` you already hold, use `GET /messages/{messageId}` instead. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note> <Note> Filtering, sorting, field selection, and pagination are not available on this endpoint. The `fields`, `sort`, `filter`, `page`, and `limit` query parameters are ignored. </Note>

Query parameters

conversationIdstringOptional

Return every message on this conversation, oldest first.

idempotencyIdstringOptional

Return the message created with this idempotency key.

messageSidstringOptional

Return the messages matching this carrier-assigned identifier.

Response

Expected response to a valid request. Returns an empty array when nothing matches.

Errors

400

List Messages Request Bad Request Error

Available by Request

List messages, narrowed by conversation or by one of the identifiers assigned when the message was created. Supply exactly one of conversationId, idempotencyId, or messageSid.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Filtering, sorting, field selection, and pagination are not available on this endpoint. The fields, sort, filter, page, and limit query parameters are ignored.