Listar mensagens do atendimento

Lista mensagens de um atendimento

GEThttps://api-publica.sunchat.com.br/v1/atendimento/{idAtendimento}/mensagens

Retorna as mensagens trocadas no atendimento, paginadas e ordenadas por data de criação (asc). Suporta filtros por tipo, fromMe, excluida, intervalo de data e busca textual em Corpo/AudioTranscrito.

curl --request GET \
  --url 'https://api-publica.sunchat.com.br/v1/atendimento/{idAtendimento}/mensagens?search=&corpo=&audioTranscrito=' \
  --header 'X-Ambiente: SEU_NUMERO_DE_CONTA' \
  --header 'X-Authorization: X-Chave-Api SUA_CHAVE'

Autenticação

X-Ambientestring (header)obrigatório

Número da sua conta no SunchatPlus. Aceita também `X-Canal` com o ID de um canal, que resolve a conta a partir dele.

X-Authorizationstring (header)obrigatório

Chave de API no formato `X-Chave-Api {chave}`. O prefixo faz parte do valor. A chave fica em Minha conta › Integrações.

Parâmetros de caminho

idAtendimentostring<uuid>obrigatório

Parâmetros de consulta

searchstring

corpostring

audioTranscritostring

msgIdstring

replyIdstring

remoteJidstring

tipoenum<integer>

Valores aceitos: - `0` — Chat - `1` — Nota - `2` — Notificacao

Valores: 0, 1, 2

origemenum<integer>

Valores aceitos: - `0` — Normal - `1` — Api - `2` — PesquisaSatisfacao - `3` — Campanha - `4` — EncerramentoAutomatico - `5` — Bot - `6` — RecuperacaoDeCarrinho - `7` — Sincronizacao - `8` — PosicaoNaFila

Valores: 0, 1, 2, 3, 4, 5, 6, 7, 8

statusenum<integer>

Valores aceitos: - `0` — Enviada - `1` — Entregue - `2` — Lida - `3` — Reproduzida - `-1` — Falha

Valores: 0, 1, 2, 3, -1

fromMeboolean

excluidaboolean

editadoboolean

lidoboolean

encaminhadaboolean

comMediaboolean

comTranscricaoboolean

citacaoboolean

mediaTypestring

messageTypestring

idContatostring<uuid>

idUsuariostring<uuid>

idAtendenteIastring<uuid>

idDepartamentostring<uuid>

idMensagemCitadastring<uuid>

dataInicialstring<date-time>

dataFinalstring<date-time>

atualizadoInicialstring<date-time>

atualizadoFinalstring<date-time>

timestampMininteger<int64>

timestampMaxinteger<int64>

duracaoMediaMininteger<int32>

duracaoMediaMaxinteger<int32>

pageinteger<int32>

pageSizeinteger<int32>

sortstring

Resposta 200

Itemsobject[] | null

Idstring<uuid>

IdAtendimentostring<uuid>

Corpostring | null

Tipoenum<integer>

Valores aceitos: - `0` — Chat - `1` — Nota - `2` — Notificacao

Valores: 0, 1, 2

Origemenum<integer>

Valores: 0, 1, 2, 3, 4, 5, 6, 7, 8

Statusenum<integer>

Valores aceitos: - `0` — Enviada - `1` — Entregue - `2` — Lida - `3` — Reproduzida - `-1` — Falha

Valores: 0, 1, 2, 3, -1

FromMeboolean

Excluidaboolean

Editadoboolean

Lidoboolean

MessageTypestring | null

MediaTypestring | null

MediaUrlstring | null

MediaNamestring | null

DuracaoMediainteger<int32> | null

AudioTranscritostring | null

IdContatostring<uuid> | null

NomeContatostring | null

IdUsuariostring<uuid> | null

NomeUsuariostring | null

IdMensagemCitadastring<uuid> | null

DataDaCriacaostring<date-time>

DataDaAtualizacaostring<date-time>

Pageinteger<int32>

PageSizeinteger<int32>

TotalItemsinteger<int64>

TotalPagesinteger<int32>

HasNextboolean

HasPreviousboolean

Resposta 404

Not Found

typestring | null

titlestring | null

statusinteger<int32> | null

detailstring | null

instancestring | null