Consultar mensagem

200OK

• idstring (uuid)obrigatório

  ID da mensagem.

• ticket_idstring (uuid) | nullobrigatório

  Tíquete da mensagem (null em disparos sem tíquete).

• contact_idstring (uuid) | nullobrigatório

  Contato da conversa.

• channel_idstring (uuid)obrigatório

  Canal por onde passou.

• automation_idstring (uuid) | nullobrigatório

  Automação que disparou a mensagem, se houver.

• template_idstring (uuid) | nullobrigatório

  Modelo usado, se houver.

• fromMeboolean | nullobrigatório

  true = enviada pela conta; false = recebida do contato.

• typestringobrigatório

  Tipo da mensagem.

  textimagevideoaudiodocumentlocationcontactsstickerinteractiveunsupportedtemplatebutton

• statusstringobrigatório

  Status de envio. Mensagens recebidas ficam como `received`.

  receivedpendingprocessingsendingcompletedcanceledpausederror

• bodystring | nullobrigatório

  Texto da mensagem.

• captionstring | nullobrigatório

  Legenda da mídia.

• filestring | nullobrigatório

  URL do arquivo de mídia.

• mime_typestring | nullobrigatório

  MIME type da mídia.

• latitudestring | nullobrigatório

  Latitude (mensagens de localização), como texto.

• longitudestring | nullobrigatório

  Longitude (mensagens de localização), como texto.

• vcardanyobrigatório

  Contatos compartilhados (JSON livre, pode ser null).

• contextanyobrigatório

  Contexto da mensagem (ex.: mensagem respondida) (JSON livre, pode ser null).

• reactionsanyobrigatório

  Reações recebidas (JSON livre, pode ser null).

• editedboolean | nullobrigatório

  Se a mensagem foi editada.

• errorstring | nullobrigatório

  Motivo do erro de envio.

• ex_idstring | nullobrigatório

  ID da mensagem no provedor (ex.: wamid da Meta).

• sent_atstring (date-time) | nullobrigatório

  Enviada ao provedor.

• delivery_atstring (date-time) | nullobrigatório

  Entregue.

• read_atstring (date-time) | nullobrigatório

  Lida.

• replied_atstring (date-time) | nullobrigatório

  Respondida pelo contato.

• error_atstring (date-time) | nullobrigatório

  Quando falhou.

• schedule_atstring (date-time) | nullobrigatório

  Agendada para.

• created_atstring (date-time)obrigatório

  Criação.

• usersobject | nullobrigatório

  Atendente que enviou (mensagens manuais).

• users.idstring (uuid)obrigatório

  ID do usuário.

• users.namestringobrigatório

  Nome.

• users.lastNamestring | nullobrigatório

  Sobrenome.

• contactsobject | nullobrigatório

  Contato da conversa.

• contacts.idstring (uuid)obrigatório

  ID do contato.

• contacts.first_namestring | nullobrigatório

  Nome.

• contacts.last_namestring | nullobrigatório

  Sobrenome.

• contacts.mobilephonestring | nullobrigatório

  Telefone só com dígitos, com DDI.

• messageParticipantobject | nullobrigatório

  Participante que escreveu, em conversas de grupo.

• messageParticipant.idstring (uuid)obrigatório

  ID do contato.

• messageParticipant.first_namestring | nullobrigatório

  Nome.

• messageParticipant.last_namestring | nullobrigatório

  Sobrenome.

• messageParticipant.mobilephonestring | nullobrigatório

  Telefone só com dígitos, com DDI.

• templatesobject | nullobrigatório

  Modelo usado.

• templates.idstring (uuid)obrigatório

  ID.

• templates.namestring | nullobrigatório

  Nome.

• automationsobject | nullobrigatório

  Automação de origem.

• automations.idstring (uuid)obrigatório

  ID.

• automations.namestring | nullobrigatório

  Nome.

403Acesso negado: usuário do token sem a permissão da rota (`permission_denied`) ou token não ligado a um usuário ativo (`token_without_user`) — para token de integração da conta isso só é aplicado quando `access.enforced` é true (veja GET /v1/me); token pessoal e JWT de sessão são sempre verificados; `account_id` na query diferente da conta do token; conta do tipo INFRA.

404Registro não existe, é de outra conta, foi excluído ou está fora do escopo de canais do usuário.

498Token ausente, inválido, de outra finalidade (ex.: token do canal chat) ou revogado. Note o status não padrão 498.