Agendar mensagem
Registre um agendamento de texto para execução posterior no CRM.
/functions/v1/erp-whatsapp-bridgeschedule-messageBearer AuthKeyCabeçalhos obrigatóriosAuthKey + JSON
AuthorizationBearer SUA_AUTHKEYContent-Typeapplication/jsonCorpo da requisiçãoJSON
Envie os campos abaixo junto com a ação da operação.
_actionstringObrigatórioIdentifica a operação neste endpoint. Use "schedule-message".
instance_idstringOpcional*UUID da instância retornado pela API. Informe este campo ou appkey; não use o ID do dispositivo no seu banco.
appkeystringOpcional*Nome da instância retornado em instance_name. Alternativa ao instance_id.
phonestringObrigatório*Destino com DDI + DDD + número, apenas dígitos. Para vários destinos, use para ou to como array em vez de phone.
textstringObrigatório*Texto da mensagem. Aliases aceitos: mensagem e message.
scheduled_atstringObrigatório*Data/hora local de Brasília no formato YYYY-MM-DD HH:mm:ss. O parser atual trata esse formato como UTC−03:00, mesmo se receber um sufixo de fuso; converta previamente.
titlestringOpcional*Nome do agendamento. Padrão: Lembrete ERP.
recurrencestringOpcional*Recorrência. Padrão none.
* Condições e alternativas estão descritas em cada campo. Quando necessário, selecione a instância por instance_id ou appkey. Um array de destinos pode substituir phone nos envios.
Comportamento e cuidados
- Informe instance_id ou appkey. Nos exemplos sempre selecionamos explicitamente uma instância da empresa autenticada.
- A instância explícita precisa estar conectada na criação. A empresa deve ter acesso ao recurso. Este endpoint agenda texto; não agenda mídia nem botões.
- Guarde schedule_id/hash e consulte schedule-status-bulk. pending confirma o cadastro, não o envio. A execução depende do agendador ativo e de uma sessão disponível.
- Não repita a criação automaticamente após timeout. Em recorrências, acompanhe next_schedule_id e effective_status.
Tratamento de falhas
Confira o HTTP e os campos da resposta. Em falhas, preserve code e request_id para diagnóstico. HTTP 200 e success=true nem sempre significam envio completo ou exclusão confirmada.