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"
],
"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>"
}
'import requests
url = "https://api.wppfy.com/sender/simple"
payload = {
"numbers": ["5511999999999@s.whatsapp.net"],
"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>"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
numbers: ['5511999999999@s.whatsapp.net'],
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>'
})
};
fetch('https://api.wppfy.com/sender/simple', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/sender/simple",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'numbers' => [
'5511999999999@s.whatsapp.net'
],
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/sender/simple"
payload := strings.NewReader("{\n \"numbers\": [\n \"5511999999999@s.whatsapp.net\"\n ],\n \"delayMin\": 10,\n \"delayMax\": 30,\n \"scheduled_for\": 1706198400000,\n \"info\": \"<string>\",\n \"delay\": 123,\n \"mentions\": \"<string>\",\n \"text\": \"<string>\",\n \"linkPreview\": true,\n \"linkPreviewTitle\": \"<string>\",\n \"linkPreviewDescription\": \"<string>\",\n \"linkPreviewImage\": \"<string>\",\n \"linkPreviewLarge\": true,\n \"file\": \"<string>\",\n \"docName\": \"<string>\",\n \"fullName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"organization\": \"<string>\",\n \"email\": \"<string>\",\n \"url\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"footerText\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"listButton\": \"<string>\",\n \"selectableCount\": 123,\n \"choices\": [\n \"<string>\"\n ],\n \"imageButton\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/sender/simple")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"numbers\": [\n \"5511999999999@s.whatsapp.net\"\n ],\n \"delayMin\": 10,\n \"delayMax\": 30,\n \"scheduled_for\": 1706198400000,\n \"info\": \"<string>\",\n \"delay\": 123,\n \"mentions\": \"<string>\",\n \"text\": \"<string>\",\n \"linkPreview\": true,\n \"linkPreviewTitle\": \"<string>\",\n \"linkPreviewDescription\": \"<string>\",\n \"linkPreviewImage\": \"<string>\",\n \"linkPreviewLarge\": true,\n \"file\": \"<string>\",\n \"docName\": \"<string>\",\n \"fullName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"organization\": \"<string>\",\n \"email\": \"<string>\",\n \"url\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"footerText\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"listButton\": \"<string>\",\n \"selectableCount\": 123,\n \"choices\": [\n \"<string>\"\n ],\n \"imageButton\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/sender/simple")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"numbers\": [\n \"5511999999999@s.whatsapp.net\"\n ],\n \"delayMin\": 10,\n \"delayMax\": 30,\n \"scheduled_for\": 1706198400000,\n \"info\": \"<string>\",\n \"delay\": 123,\n \"mentions\": \"<string>\",\n \"text\": \"<string>\",\n \"linkPreview\": true,\n \"linkPreviewTitle\": \"<string>\",\n \"linkPreviewDescription\": \"<string>\",\n \"linkPreviewImage\": \"<string>\",\n \"linkPreviewLarge\": true,\n \"file\": \"<string>\",\n \"docName\": \"<string>\",\n \"fullName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"organization\": \"<string>\",\n \"email\": \"<string>\",\n \"url\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"footerText\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"listButton\": \"<string>\",\n \"selectableCount\": 123,\n \"choices\": [\n \"<string>\"\n ],\n \"imageButton\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"folder_id": "<string>",
"count": 123,
"status": "queued"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Mensagem em massa
Criar nova campanha (Simples)
Cria uma nova campanha de envio com configurações básicas
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"
],
"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>"
}
'import requests
url = "https://api.wppfy.com/sender/simple"
payload = {
"numbers": ["5511999999999@s.whatsapp.net"],
"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>"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
numbers: ['5511999999999@s.whatsapp.net'],
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>'
})
};
fetch('https://api.wppfy.com/sender/simple', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/sender/simple",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'numbers' => [
'5511999999999@s.whatsapp.net'
],
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/sender/simple"
payload := strings.NewReader("{\n \"numbers\": [\n \"5511999999999@s.whatsapp.net\"\n ],\n \"delayMin\": 10,\n \"delayMax\": 30,\n \"scheduled_for\": 1706198400000,\n \"info\": \"<string>\",\n \"delay\": 123,\n \"mentions\": \"<string>\",\n \"text\": \"<string>\",\n \"linkPreview\": true,\n \"linkPreviewTitle\": \"<string>\",\n \"linkPreviewDescription\": \"<string>\",\n \"linkPreviewImage\": \"<string>\",\n \"linkPreviewLarge\": true,\n \"file\": \"<string>\",\n \"docName\": \"<string>\",\n \"fullName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"organization\": \"<string>\",\n \"email\": \"<string>\",\n \"url\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"footerText\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"listButton\": \"<string>\",\n \"selectableCount\": 123,\n \"choices\": [\n \"<string>\"\n ],\n \"imageButton\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/sender/simple")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"numbers\": [\n \"5511999999999@s.whatsapp.net\"\n ],\n \"delayMin\": 10,\n \"delayMax\": 30,\n \"scheduled_for\": 1706198400000,\n \"info\": \"<string>\",\n \"delay\": 123,\n \"mentions\": \"<string>\",\n \"text\": \"<string>\",\n \"linkPreview\": true,\n \"linkPreviewTitle\": \"<string>\",\n \"linkPreviewDescription\": \"<string>\",\n \"linkPreviewImage\": \"<string>\",\n \"linkPreviewLarge\": true,\n \"file\": \"<string>\",\n \"docName\": \"<string>\",\n \"fullName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"organization\": \"<string>\",\n \"email\": \"<string>\",\n \"url\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"footerText\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"listButton\": \"<string>\",\n \"selectableCount\": 123,\n \"choices\": [\n \"<string>\"\n ],\n \"imageButton\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/sender/simple")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"numbers\": [\n \"5511999999999@s.whatsapp.net\"\n ],\n \"delayMin\": 10,\n \"delayMax\": 30,\n \"scheduled_for\": 1706198400000,\n \"info\": \"<string>\",\n \"delay\": 123,\n \"mentions\": \"<string>\",\n \"text\": \"<string>\",\n \"linkPreview\": true,\n \"linkPreviewTitle\": \"<string>\",\n \"linkPreviewDescription\": \"<string>\",\n \"linkPreviewImage\": \"<string>\",\n \"linkPreviewLarge\": true,\n \"file\": \"<string>\",\n \"docName\": \"<string>\",\n \"fullName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"organization\": \"<string>\",\n \"email\": \"<string>\",\n \"url\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"footerText\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"listButton\": \"<string>\",\n \"selectableCount\": 123,\n \"choices\": [\n \"<string>\"\n ],\n \"imageButton\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"folder_id": "<string>",
"count": 123,
"status": "queued"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Autorizações
Corpo
application/json
Lista de números para envio
Exemplo:
["5511999999999@s.whatsapp.net"]
Tipo da mensagem
Opções disponíveis:
text, image, video, audio, document, contact, location, list, button, poll, carousel Delay mínimo entre mensagens em segundos
Intervalo obrigatório:
x >= 1Exemplo:
10
Delay máximo entre mensagens em segundos
Intervalo obrigatório:
x >= 1Exemplo:
30
Timestamp em milissegundos ou minutos a partir de agora para agendamento
Exemplo:
1706198400000
Informações adicionais sobre a campanha
Delay fixo entre mensagens (opcional)
Menções na mensagem em formato JSON
Texto da mensagem
Habilitar preview de links em mensagens de texto. O preview será gerado automaticamente a partir da URL contida no texto.
Título personalizado para o preview do link (opcional)
Descrição personalizada para o preview do link (opcional)
URL ou dados base64 da imagem para o preview do link (opcional)
Se deve usar preview grande ou pequeno (opcional, padrão false)
URL da mídia ou arquivo (quando type é image, video, audio, document, etc.)
Nome do arquivo (quando type é document)
Nome completo (quando type é contact)
Número do telefone (quando type é contact)
Organização (quando type é contact)
Email (quando type é contact)
URL (quando type é contact)
Latitude (quando type é location)
Longitude (quando type é location)
Nome do local (quando type é location)
Endereço (quando type é location)
Texto do rodapé (quando type é list, button, poll ou carousel)
Texto do botão (quando type é list, button, poll ou carousel)
Texto do botão da lista (quando type é list)
Quantidade de opções selecionáveis (quando type é poll)
Lista de opções (quando type é list, button, poll ou carousel). Para carousel, use formato específico com [texto], {imagem} e botões
URL da imagem para o botão (quando type é button)
⌘I