Read Message

GET

https://api.fortresstech.io/v1/messages/:messageId

GET

/v1/messages/:messageId

$ curl https://api.fortresstech.io/v1/messages/messageId

1 {
2   "id": "id",
3   "conversationId": "conversationId",
4   "type": "OUTBOUND",
5   "content": "content",
6   "messageStatus": "messageStatus",
7   "messageStatusReason": "messageStatusReason",
8   "messageSid": "messageSid",
9   "customerStatus": "customerStatus",
10   "idempotencyId": "idempotencyId",
11   "isAutomated": true,
12   "needsHelp": true,
13   "needsHelpDetails": {
14     "reason": "reason",
15     "flaggedByType": "agent",
16     "flaggedById": "flaggedById",
17     "flaggedAt": "2024-01-15T09:30:00Z",
18     "resolvedByType": "agent",
19     "resolvedById": "resolvedById",
20     "resolvedAt": "2024-01-15T09:30:00Z"
21   },
22   "subject": "subject",
23   "emailAddress": "emailAddress",
24   "attachments": [
25     {
26       "key": "key",
27       "bucket": "bucket",
28       "type": "type",
29       "url": "url"
30     }
31   ],
32   "metadata": {
33     "key": "value"
34   },
35   "organizationId": "organizationId",
36   "customerId": "customerId",
37   "prospectId": "prospectId",
38   "userId": "userId",
39   "createdAt": "2024-01-15T09:30:00Z",
40   "updatedAt": "2024-01-15T09:30:00Z"
41 }

Available by Request

Read a single message, including its current delivery status and any attachments.

Attachment url values are generated per request and expire 15 minutes after the response is issued. Fetch the attachment promptly or re-read the message to obtain a fresh URL.

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

Field selection is not available on this endpoint. The fields query parameter is ignored.

<Badge>Available by Request</Badge> Read a single message, including its current delivery status and any attachments. Attachment `url` values are generated per request and expire 15 minutes after the response is issued. Fetch the attachment promptly or re-read the message to obtain a fresh URL. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note> <Note> Field selection is not available on this endpoint. The `fields` query parameter is ignored. </Note>

Path parameters

messageIdstringRequired

The id of the message

Response

Expected response to a valid request

Errors

404

Read Message Request Not Found Error