Pular para o conteúdo

GET /v1/conversations/messages/search

GET
/v1/conversations/messages/search
curl --request GET \
--url https://seu-endereco-da-api/v1/conversations/messages/search \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler conversas (conversations:read).

q
string
<= 200 characters
cursor
string
<= 200 characters
limit
string
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
conversationId
required
string
contactName
required
string
nullable
text
required
string
nullable
type
required
string
transcription
required

What the audio says; this is what the search matched on an audio message

string
nullable
createdAt
required
string format: date-time
channelId
required
string
channelName
required
string
nullable
channelProvider
required
string
nullable
channelCoexistence
required

The channel runs in coexistence with the WhatsApp Business app

boolean
nullable
sessionId
required

The service session the message fell into

string
nullable
sessionOpenedAt
required
string format: date-time
nullable
nextCursor
required
string
nullable

Example generated

{
"items": [
{
"id": "example",
"conversationId": "example",
"contactName": "example",
"text": "example",
"type": "example",
"transcription": "example",
"createdAt": "2026-04-15T12:00:00Z",
"channelId": "example",
"channelName": "example",
"channelProvider": "example",
"channelCoexistence": true,
"sessionId": "example",
"sessionOpenedAt": "2026-04-15T12:00:00Z"
}
],
"nextCursor": "example"
}