Read message

GET/v1/messages/{id}

Path parameters

idstringrequired

Responses

200Successful response

idstring

orgstring

gymstring

threadstring

customerstring

userstring

The team member who sent the message, for messages sent from the inbox.

flowstring

The flow that sent the message, if any.

listMessagestring

The blast that sent the message, if any.

bodystring

subjectstring

Email subject, for email messages.

directionstring

Allowed:incomingoutgoing

statusstring

Allowed:queuedscheduledsendingsentfailed

protocolstring

`http` is used for form submissions.

Allowed:smsemailhttpvoip

providerstring

Allowed:heliostwiliopostmark

providerIdstring

The delivery provider's ID for the message.

segmentsinteger

Billable SMS segments.

mediaobject[]

Show properties

Array of object

contentTypestring

urlstring

linksobject[]

Tracked short links in the message body.

Show properties

Array of object

pathstring

urlstring

scheduleDatestring<date-time>

createdAtstring<date-time>

updatedAtstring<date-time>

403The message belongs to a different inbox

Request

curl -X GET "https://api.sendhelios.com/v1/messages/string"

const response = await fetch("https://api.sendhelios.com/v1/messages/string", {
  method: "GET"
});

import requests

response = requests.get(
    "https://api.sendhelios.com/v1/messages/string",
)

Response

{
  "id": "string",
  "org": "string",
  "gym": "string",
  "thread": "string",
  "customer": "string",
  "user": "string",
  "flow": "string",
  "listMessage": "string",
  "body": "string",
  "subject": "string",
  "direction": "incoming",
  "status": "queued",
  "protocol": "sms",
  "provider": "helios",
  "providerId": "string",
  "segments": 0,
  "media": [
    {
      "contentType": "string",
      "url": "string"
    }
  ],
  "links": [
    {
      "path": "string",
      "url": "string"
    }
  ],
  "scheduleDate": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}