Pular para o conteúdo principal
POST
/
sender
/
simple
Criar nova campanha (Simples)
curl --request POST \
  --url https://api.wppfy.com/sender/simple \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "numbers": [
    "5511999999999@s.whatsapp.net"
  ],
  "type": "text",
  "delayMin": 10,
  "delayMax": 30,
  "scheduled_for": 1706198400000,
  "info": "<string>",
  "delay": 123,
  "mentions": "<string>",
  "text": "<string>",
  "linkPreview": true,
  "linkPreviewTitle": "<string>",
  "linkPreviewDescription": "<string>",
  "linkPreviewImage": "<string>",
  "linkPreviewLarge": true,
  "file": "<string>",
  "docName": "<string>",
  "fullName": "<string>",
  "phoneNumber": "<string>",
  "organization": "<string>",
  "email": "<string>",
  "url": "<string>",
  "latitude": 123,
  "longitude": 123,
  "name": "<string>",
  "address": "<string>",
  "footerText": "<string>",
  "buttonText": "<string>",
  "listButton": "<string>",
  "selectableCount": 123,
  "choices": [
    "<string>"
  ],
  "imageButton": "<string>"
}
'
{
  "folder_id": "<string>",
  "count": 123,
  "status": "queued"
}

Authorizations

​
token
string
header
required

Body

application/json
​
numbers
string[]
required

Lista de números para envio

Example:
["5511999999999@s.whatsapp.net"]
​
type
enum<string>
required

Tipo da mensagem

Opções disponíveis:
text,
image,
video,
audio,
document,
contact,
location,
list,
button,
poll,
carousel
​
delayMin
integer
required

Delay mínimo entre mensagens em segundos

Intervalo obrigatório: x >= 1
Example:

10

​
delayMax
integer
required

Delay máximo entre mensagens em segundos

Intervalo obrigatório: x >= 1
Example:

30

​
scheduled_for
integer
required

Timestamp em milissegundos ou minutos a partir de agora para agendamento

Example:

1706198400000

​
info
string

Informações adicionais sobre a campanha

​
delay
integer

Delay fixo entre mensagens (opcional)

​
mentions
string

Menções na mensagem em formato JSON

​
text
string

Texto da mensagem

​
linkPreview
boolean

Habilitar preview de links em mensagens de texto. O preview será gerado automaticamente a partir da URL contida no texto.

​
linkPreviewTitle
string

Título personalizado para o preview do link (opcional)

​
linkPreviewDescription
string

Descrição personalizada para o preview do link (opcional)

​
linkPreviewImage
string

URL ou dados base64 da imagem para o preview do link (opcional)

​
linkPreviewLarge
boolean

Se deve usar preview grande ou pequeno (opcional, padrão false)

​
file
string

URL da mídia ou arquivo (quando type é image, video, audio, document, etc.)

​
docName
string

Nome do arquivo (quando type é document)

​
fullName
string

Nome completo (quando type é contact)

​
phoneNumber
string

Número do telefone (quando type é contact)

​
organization
string

Organização (quando type é contact)

​
email
string

Email (quando type é contact)

​
url
string

URL (quando type é contact)

​
latitude
number

Latitude (quando type é location)

​
longitude
number

Longitude (quando type é location)

​
name
string

Nome do local (quando type é location)

​
address
string

Endereço (quando type é location)

​
footerText
string

Texto do rodapé (quando type é list, button, poll ou carousel)

​
buttonText
string

Texto do botão (quando type é list, button, poll ou carousel)

​
listButton
string

Texto do botão da lista (quando type é list)

​
selectableCount
integer

Quantidade de opções selecionáveis (quando type é poll)

​
choices
string[]

Lista de opções (quando type é list, button, poll ou carousel). Para carousel, use formato específico com [texto], {imagem} e botões

​
imageButton
string

URL da imagem para o botão (quando type é button)

Response

campanha criada com sucesso

​
folder_id
string

ID único da campanha criada

​
count
integer

Quantidade de mensagens agendadas

​
status
string

Status da operação

Example:

"queued"