Skip to main content
GET
/
leads
/
{leadId}
/
messages
Listar mensagens
curl --request GET \
  --url https://api.cordialy.ai/integrations/v1/leads/{leadId}/messages \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "<string>",
    "media_url": "<string>",
    "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

X-API-Key
string
header
required

Chave de API gerada na plataforma em Integrações → API Keys

Path Parameters

leadId
string<uuid>
required

Query Parameters

from
string<date-time>

Retorna mensagens a partir desta data (ISO 8601)

Response

200 - application/json

Lista de mensagens

id
string<uuid>
lead_id
string<uuid>
role
enum<string>

user = lead, assistant = IA, agent = consultor humano

Available options:
user,
assistant,
agent
content
string

Conteúdo da mensagem

source
enum<string>

whatsapp = mensagem via WhatsApp, call = chamada de voz, api = enviada via API

Available options:
whatsapp,
call,
api
media_type
enum<string> | null
Available options:
image,
video,
audio,
document
media_url
string | null
session_id
string<uuid> | null

Sessão de atendimento associada

created_at
string<date-time>