POST Create reminder with WhatsApp

Changed on

Através deste endpoint é possível enviar o link de assinatura para um telefone via WhatsApp, pelo número e assistente virtual da plataforma. Em planos com saldo de créditos, cada envio desconta 1 crédito.

Informe o número no formato DDD + 9 + número (ex.: 11988443377), com WhatsApp ativo. O envio gera um registro visível em "Minhas solicitações" e em GET /api/requests/{signing_key}/whats-sent.

A resposta traz deliveries com o provedor usado (plugmessage ou api_oficial) e o resultado. Quando nenhum provedor aceita o envio, a resposta é 502.

post/api/reminders/whatsapp

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/reminders/whatsapp
  • Auth
    API key in header Authorization

Request body

signing_keystring required

Chave da solicitação que deve ser lembrada.

phonestring required

Número com WhatsApp: DDD + 9 + número, só dígitos (9 a 20 caracteres).

messagestring

Mensagem para o signatário; se omitida, a plataforma usa o texto padrão.

options_listboolean

Quando true, envia uma lista interativa (Aceitar / Recusar / Não receber mais mensagens) em vez do link simples. Disponível no provedor plugmessage.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "O lembrete foi enviado com sucesso!"
}

Changes

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status