Pular para o conteúdo

GET /v1/conversations/{id}/messages

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

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

id
required
string
cursor
string
after
string
around
string format: uuid
onDate
string
limit
string
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
conversationId
required
string
kind
required
string
direction
required
string
nullable
senderType
required
string
senderUserId
required
string
nullable
type
required
string
text
required
string
nullable
mediaKey
required
string
nullable
mediaMime
required
string
nullable
mediaDownloadFailedAt
required
string format: date-time
nullable
fileName
required
string
nullable
contacts
required
object
location
required
object
replyTo
required
object
reaction
required
string
nullable
groupSenderJid
required

The group member who sent it; null for a private conversation or for a message we sent

string
nullable
groupSenderName
required

The group member who sent it; null for a private conversation or for a message we sent

string
nullable
mentions

The group members tagged in the text: each @token in the text is shown as @name; a token with no known member is left as written

Array<object>
object
token
required

The digits after @ in the text: the member’s lid or phone

string
name
required

The saved contact name, else the member’s WhatsApp name, else the phone

string
channelId
required

The channel this message came in or went out through; it can differ from the conversation’s current channel

string
channelName
required

Still filled in for a channel that was already removed

string
nullable
channelProvider
required
string
nullable
channelCoexistence
required

The channel runs in coexistence with the WhatsApp Business app

boolean
nullable
viaIdentifierId
required

The contact identifier this message came in from or went out to; null for a group or for an older message

string
nullable
mediaUrl
required
string
nullable
templateName
required
string
nullable
templateLanguage
required
string
nullable
templateVariables
required
object
templateComponents
required
object
richContent
required
object
flow
required

Formulário enviado (type flow): body, cta e formName

object
providerMessageId
required
string
nullable
clientMessageId
required
string
nullable
status
required
string
nullable
errorCode
required
string
nullable
errorTitle
required

The title the provider gave when it refused the message

string
nullable
errorReason
required
string
nullable
scheduledMessageId
required
string
nullable
source
required
string
nullable
Allowed values: manual flow ai campaign scheduled system external api import
chargeId
required

The charge a payment message asks the contact to pay

string
nullable
payment

Only on a payment message: the template kind and the charge as it is now (status, value, instruments)

object
transcription
required

What the audio says; only for audio messages

string
nullable
transcriptionStatus
required
string
nullable
Allowed values: pending running done failed
createdAt
required
string format: date-time
receipts

Only present for a group conversation

object
reactions

Only present for a group conversation

Array<object>
object
pollVotes

Only present for a poll message that has at least one vote

Array<object>
object
nextCursor
required
string
nullable
prevCursor
required
string
nullable

Example

{
"items": [
{
"source": "manual",
"transcriptionStatus": "pending"
}
]
}