Get message

Get message. See the OpenAPI-defined parameters, request body, and responses below.

GET /Message/{id}

Get message. See the OpenAPI-defined parameters, request body, and responses below.

OpenAPI description: Este endpoint retorna os detalhes de uma mensagem especificada pelo identificador.

Authentication

Authentication required. Send your user API key in the X-API-Key header.

Parameters

Name	Location	Type	Required	Description	Constraints
`id`	`path`	`integer · int32`	Yes	—	—

Request body

This operation does not accept a request body.

Example request

curl --request GET \
  --url 'https://api.zild.ai/Message/{id}' \
  --header 'X-API-Key: YOUR_USER_API_KEY'

Responses

Status	Description	Response body
`200`	Sucesso ao retornar a mensagem	`application/json` · `MessageDto`

Example response (200):

{
  "id": 0,
  "createdAt": "2026-09-22T18:00:00Z",
  "from": "string",
  "to": "string",
  "content": "string",
  "conversationId": 0,
  "sentiment": "string",
  "offset": "string",
  "isNPS": true,
  "contentSid": "string",
  "messageType": 0,
  "conversationTemplateId": 0,
  "mediaUrl": "string",
  "mediaFileName": "string",
  "tenantId": 0,
  "userId": 0,
  "contentVariables": "string",
  "messageSid": "string",
  "messageStatus": 0,
  "sent": true,
  "delivered": true,
  "read": true,
  "errorCode": "string",
  "errorMessage": "string",
  "isReadByUser": true,
  "documentId": 0
}

Data models

MessageDto

Property	Type	Required	Description	Constraints
`id`	`integer · int32`	No	—	—
`createdAt`	`string · date-time`	No	—	—
`from`	`string`	No	—	nullable
`to`	`string`	No	—	nullable
`content`	`string`	No	—	nullable
`conversationId`	`integer · int32`	No	—	—
`sentiment`	`string`	No	—	nullable
`offset`	`string`	No	—	nullable
`isNPS`	`boolean`	No	—	—
`contentSid`	`string`	No	—	nullable
`messageType`	`MessageType`	No	—	—
`conversationTemplateId`	`integer · int32`	No	—	—
`mediaUrl`	`string`	No	—	nullable
`mediaFileName`	`string`	No	—	nullable
`tenantId`	`integer · int32`	No	—	—
`userId`	`integer · int32`	No	—	—
`contentVariables`	`string`	No	—	nullable
`messageSid`	`string`	No	—	nullable
`messageStatus`	`MessageStatus`	No	—	—
`sent`	`boolean`	No	—	—
`delivered`	`boolean`	No	—	—
`read`	`boolean`	No	—	—
`errorCode`	`string`	No	—	nullable
`errorMessage`	`string`	No	—	nullable
`isReadByUser`	`boolean`	No	—	—
`documentId`	`integer · int32`	No	—	nullable

MessageStatus

0 = Queued; 1 = Sending; 2 = Sent; 3 = Delivered; 4 = Receiving; 5 = Received; 6 = Accepted; 7 = Scheduled; 8 = Read; 9 = Undelivered; 10 = Canceled; 11 = Failed

integer

MessageType

0 = Text; 1 = Image; 2 = File; 3 = Audio; 4 = Video; 5 = Internal; 6 = TemplateMarketing; 7 = TemplateUtility; 8 = Location; 9 = Contact

integer