Cria e dispara uma nova campanha de mensagens via WhatsApp
Campo | Tipo | Obrigatório | Descrição | Exemplo |
---|---|---|---|---|
agentId | string | Sim | ID do agente que fará o disparo | ”agent_123” |
name | string | Não | Nome da campanha. Se não informado, será usado um nome padrão | ”Campanha de Marketing” |
useAgentContacts | boolean | Não | CUIDADO! Essa opção dispara para todos os contatos que conversaram com o agente. Padrão: false | false |
manualPhoneNumbers | string[] | Não | Array de números de telefone para disparo manual | [“+5511999999999”] |
preferredProvider | string | Não | Provedor preferido para o disparo. Opções: “official”, “evolution”, “evolution-qr”, “z-api" | "evolution” |
message | string | Sim | Conteúdo da mensagem a ser enviada | ”Olá, esta é uma mensagem de teste” |
autoDispatch | boolean | Sim | Define se a campanha será disparada automaticamente ou apenas criada | true |
200
: Sucesso400
: Erro de validação ou dados inválidos401
: Não autorizado (token inválido ou ausente)403
: Proibido (sem permissão)404
: Agente não encontrado500
: Erro interno do servidorpreferredProvider
especificado não estiver disponível, será usado o primeiro provedor conectado ao agenteuseAgentContacts
for true, os contatos do agente serão incluídos no disparoautoDispatch
for false, a campanha será criada com status “DRAFT”autoDispatch
for true, a campanha será iniciada imediatamenteBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Sucesso
The response is of type object
.