v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB
Whatsapp

Inserir mensagem

Este endpoint permite a inserção de mensagens do WhatsApp associadas a um lead. Ele suporta tanto mensagens de texto quanto de mídia, possibilitando agrupar conversas por meio de um session_id + Dados utilizados na inserção: + Campos obrigatórios: + Observações:

post/WhatsAppAdd

Request body

session_idstring

ID único para agrupar as mensagens dentro de uma mesma conversa. Deve ser gerado e controlado pelo cliente.

idstring

ID da mensagem no WhatsApp, único para cada mensagem.

salesRepEmailstring

E-mail do SDR associado à mensagem.

phonestring

Número de WhatsApp do lead, incluindo o código DDI.

directionstring

Indica a direção da mensagem - in para mensagens enviadas pelo lead ao SDR, ou out para mensagens enviadas pelo SDR ao lead.

messagestring

O conteúdo da mensagem, obrigatório para mensagens de texto (type = 1). Para outros tipos de mídia, este campo é opcional, pois um subtítulo pode ser recebido da mídia.

file_urlstring

URL do arquivo de mídia, usado apenas quando o tipo de mensagem (type) for diferente de texto.

typestring

Define o tipo de mensagem - 1 para texto e 2 para mídia.

messageDatestring date-time

Data e hora em que a mensagem foi enviada ou recebida, no formato ISO 8601.

Example request

{
  "session_id": "f84f1223-73d5-445b-a678-eb29e7e835a8",
  "id": "1234",
  "salesRepEmail": "teste@teste.com.br",
  "phone": "5548999999999",
  "direction": "in",
  "message": "oi",
  "file_url": "https://link-al-sitio.com",
  "type": "2",
  "messageDate": "2024-01-15T14:30:00.000Z"
}

Response

Operação realizada com sucesso

session_idstring

ID único para agrupar as mensagens dentro de uma mesma conversa. Deve ser gerado e controlado pelo cliente.

idstring

ID da mensagem no WhatsApp, único para cada mensagem.

salesRepEmailstring

E-mail do SDR associado à mensagem.

phonestring

Número de WhatsApp do lead, incluindo o código DDI.

directionstring

Indica a direção da mensagem - in para mensagens enviadas pelo lead ao SDR, ou out para mensagens enviadas pelo SDR ao lead.

messagestring

O conteúdo da mensagem, obrigatório para mensagens de texto (type = 1). Para outros tipos de mídia, este campo é opcional, pois um subtítulo pode ser recebido da mídia.

file_urlstring

URL do arquivo de mídia, usado apenas quando o tipo de mensagem (type) for diferente de texto.

typestring

Define o tipo de mensagem - 1 para texto e 2 para mídia.

messageDatestring date-time

Data e hora em que a mensagem foi enviada ou recebida, no formato ISO 8601.

Example response

{
  "session_id": "f84f1223-73d5-445b-a678-eb29e7e835a8",
  "id": "1234",
  "salesRepEmail": "teste@teste.com.br",
  "phone": "5548999999999",
  "direction": "in",
  "message": "oi",
  "file_url": "https://link-al-sitio.com",
  "type": "2",
  "messageDate": "2024-01-15T14:30:00.000Z"
}