Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Texto da mensagem
"Como posso ajudar?"
ID da mensagem a ser respondida
"48592f2a95hn298e5c872b1"
Data e hora agendadas para o envio da mensagem
Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ
Valor boleano para indicar se a mensagem é uma mensagem interna (anotação)
true
Response
ID da mensagem
"68597f2a95fb0298e5c128b5"
ID da conversa
"34523f427033710f15389a18c"
Data de envio da da mensagem
"2025-06-25T18:03:37.292Z"
Data em que a mensagem foi editada
"2025-11-07T22:05:15.754Z"
Data em que a mensagm foi excluída
"2025-08-12T22:10:09.541Z"
Texto da mensagem
"Bom dia!"
Valor booleano que indica se a mensagem foi recebida pelo destinatário
true
Anexos da mensagem, como imagem, documento, áudio.
[
  {
    "id": "685c39fcc2523944ecd171f7",
    "createdAt": "2025-06-25T18:03:40.172Z",
    "updatedAt": "2025-06-25T18:03:40.172Z",
    "deletedAt": "2025-06-25T18:03:40.172Z",
    "fileName": "my-product-175087",
    "mimeType": "image/jpeg",
    "url": "https://dc-qqqq2222pb.s3.amazonaws.com/d129a692-e5ab-42b3-b0e4-90ad9a12b068/f514f655-4897-416e-b5c1-bbc19aac0805",
    "type": "IMAGE",
    "size": "7642"
  }
]Cartão de contato enviado pelo Whatsapp
Informações da mensagem de localização
Status da mensagem
"RECEIVED"
Informações do contato
ID do atendente
[
  {
    "userId": "t9kn9mqPakdGG535GQK3hod8wzM2",
    "id": "6807e48c25ece34f9f1ba7dd",
    "name": "Joao Silva",
    "email": "joaosilva@gmail.com",
    "phone": "55 47 991331190",
    "imageURL": "https://dc-qqqq1111pb.s3.amazonaws.com/profiles/koQGLa8p68fNZiiSmE1tec2LHtc2_2025-05-24T00%3A27%3A23.486Z"
  }
]Código de erro da mensagem
"402"
Mensagem retornada no erro
"O token utilizado está expirado"
Presente somente em mensagems enviadas pelo Cloud api
"Boa tarde!"
Presente somente em mensagems enviadas pelo Cloud api
"Obrigado"
Botões presente na mensagem
[
  {
    "id": "3d99cda4-62dc-4b9f-9c6c-124f1966b26a ",
    "name": "Opção um",
    "description": "Opcao para contatar o suporte",
    "url": "www.google.com.br"
  }
]Mensagem que foi respondida
Mensagem de anexo que foi respondido
Valor boleano que indica se a mensagem foi editada ou não
true
Valor boleano que indica se a mensagem foi deletada ou não
true
Valor boleano que indica se a mensagem é encaminhada ou não
false
Dados da mensagem encaminhada
Valor boleano que indica se a mensagem é uma mensagem agendada ou não
true
Data e hora agendadas para o envio da mensagem
"2025-11-07T22:05:15.754Z"
Assinatura do atendente na mensagem
"Joao da Silva"
Valor boleano que indica se a mensagem é uma mensagem interna, sendo uma anotação
true