Listar mensagens por conversa

Este endpoint retorna as mensagens de uma conversa especificada pelo identificador da conversa.

GET /Message

Este endpoint retorna as mensagens de uma conversa especificada pelo identificador da conversa.

Autenticação

Autenticação obrigatória. Envie sua chave de API de usuário no header X-API-Key.

Parâmetros

NomeLocalTipoObrigatórioDescriçãoRestrições
conversationIdqueryinteger · int32Não——

Corpo da requisição

Esta operação não recebe corpo de requisição.

Exemplo de requisição

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

Respostas

StatusDescriçãoCorpo da resposta
200Sucesso ao retornar as mensagensapplication/json · array<MessageDto>

Exemplo de resposta (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
  }
]

Modelos de dados

MessageDto
PropriedadeTipoObrigatórioDescriçãoRestrições
idinteger · int32Não——
createdAtstring · date-timeNão——
fromstringNão—aceita null
tostringNão—aceita null
contentstringNão—aceita null
conversationIdinteger · int32Não——
sentimentstringNão—aceita null
offsetstringNão—aceita null
isNPSbooleanNão——
contentSidstringNão—aceita null
messageTypeMessageTypeNão——
conversationTemplateIdinteger · int32Não——
mediaUrlstringNão—aceita null
mediaFileNamestringNão—aceita null
tenantIdinteger · int32Não——
userIdinteger · int32Não——
contentVariablesstringNão—aceita null
messageSidstringNão—aceita null
messageStatusMessageStatusNão——
sentbooleanNão——
deliveredbooleanNão——
readbooleanNão——
errorCodestringNão—aceita null
errorMessagestringNão—aceita null
isReadByUserbooleanNão——
documentIdinteger · int32Não—aceita null
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