v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Create reminder with WhatsApp

Através deste endpoint é possível enviar o link de assinatura para um telefone via WhatsApp, o envio é feito pelo número e assistente virtual do sistema de forma automática, sem gerar custos adicionais no seu plano. É importante que passe o número no seguinte formato, e que o mesmo possua WhatsApp ativo: Brasil: DDD + 9 + NÚMERO DE TELEFONE (Ex: 11988443377) Internacional: DDI + NÚMERO DE TELEFONE O envio da mensagem gera um registro que pode ser visualizado no front-end, na área "Minhas solicitações", assim como é possível ver o status da mensagem.

post/api/reminders/whatsapp

Request body

signing_keystring required

Chave da solicitação que deve ser lembrada.

phonestring required

Número de telefone com WhatsApp.

messagestring

Mensagem para seu cliente sobre a solicitação, caso não informe será enviada uma mensagem padrão do sistema.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Lembrete por WhatsApp enviado com sucesso!"
}