curl --request POST \
  --url https://api.zappfy.io/send/text \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "number": "5511999999999",
  "text": "Olá! Como posso ajudar?"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "messageid": "<string>",
  "chatid": "<string>",
  "fromMe": false,
  "isGroup": false,
  "messageTimestamp": 0,
  "edited": "",
  "quoted": "",
  "reaction": "",
  "sender": "",
  "senderName": "",
  "source": "",
  "status": "",
  "text": "",
  "vote": "",
  "buttonOrListid": "",
  "convertOptions": "",
  "fileURL": "",
  "content": "<string>",
  "owner": "",
  "track_source": "",
  "track_id": "",
  "created": "(strftime('%Y-%m-%d %H:%M:%f', 'now'))",
  "updated": "(strftime('%Y-%m-%d %H:%M:%f', 'now'))",
  "ai_metadata": {
    "agent_id": "<string>",
    "request": {
      "messages": "<array>",
      "tools": "<array>",
      "options": {
        "model": "<string>",
        "temperature": 123,
        "maxTokens": 123,
        "topP": 123,
        "frequencyPenalty": 123,
        "presencePenalty": 123
      }
    },
    "response": {
      "choices": "<array>",
      "toolResults": "<array>",
      "error": "<string>"
    }
  },
  "response": {
    "status": "success",
    "message": "Message sent successfully"
  }
}

Enviar Mensagem

Enviar mensagem de texto

Envia uma mensagem de texto para um contato ou grupo.

Recursos Específicos

Preview de links com suporte a personalização automática ou customizada
Formatação básica do texto
Substituição automática de placeholders dinâmicos

Campos Comuns

Este endpoint suporta todos os campos opcionais comuns documentados na tag “Enviar Mensagem”, incluindo: delay, readchat, readmessages, replyid, mentions, forward, track_source, track_id, placeholders e envio para grupos.

Preview de Links

Preview Automático

{
  "number": "5511999999999",
  "text": "Confira: https://exemplo.com",
  "linkPreview": true
}

Preview Personalizado

{
  "number": "5511999999999",
  "text": "Confira nosso site! https://exemplo.com",
  "linkPreview": true,
  "linkPreviewTitle": "Título Personalizado",
  "linkPreviewDescription": "Uma descrição personalizada do link",
  "linkPreviewImage": "https://exemplo.com/imagem.jpg",
  "linkPreviewLarge": true
}

POST

send

text

curl --request POST \
  --url https://api.zappfy.io/send/text \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "number": "5511999999999",
  "text": "Olá! Como posso ajudar?"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "messageid": "<string>",
  "chatid": "<string>",
  "fromMe": false,
  "isGroup": false,
  "messageTimestamp": 0,
  "edited": "",
  "quoted": "",
  "reaction": "",
  "sender": "",
  "senderName": "",
  "source": "",
  "status": "",
  "text": "",
  "vote": "",
  "buttonOrListid": "",
  "convertOptions": "",
  "fileURL": "",
  "content": "<string>",
  "owner": "",
  "track_source": "",
  "track_id": "",
  "created": "(strftime('%Y-%m-%d %H:%M:%f', 'now'))",
  "updated": "(strftime('%Y-%m-%d %H:%M:%f', 'now'))",
  "ai_metadata": {
    "agent_id": "<string>",
    "request": {
      "messages": "<array>",
      "tools": "<array>",
      "options": {
        "model": "<string>",
        "temperature": 123,
        "maxTokens": 123,
        "topP": 123,
        "frequencyPenalty": 123,
        "presencePenalty": 123
      }
    },
    "response": {
      "choices": "<array>",
      "toolResults": "<array>",
      "error": "<string>"
    }
  },
  "response": {
    "status": "success",
    "message": "Message sent successfully"
  }
}

Autorizações

token

string

header

obrigatório

Corpo

application/json

number

string

obrigatório

Número do destinatário (formato internacional)

Exemplo:

"5511999999999"

text

string

obrigatório

Texto da mensagem (aceita placeholders)

Exemplo:

"Olá {{name}}! Como posso ajudar?"

linkPreview

boolean

Ativa/desativa preview de links. Se true, procura automaticamente um link no texto para gerar preview.

Comportamento:

Se apenas linkPreview=true: gera preview automático do primeiro link encontrado no texto
Se fornecidos campos personalizados (title, description, image): usa os valores fornecidos
Se campos personalizados parciais: combina com dados automáticos do link como fallback

Exemplo:

true

linkPreviewTitle

string

Define um título personalizado para o preview do link

Exemplo:

"Título Personalizado"

linkPreviewDescription

string

Define uma descrição personalizada para o preview do link

Exemplo:

"Descrição personalizada do link"

linkPreviewImage

string

URL ou Base64 da imagem para usar no preview do link

Exemplo:

"https://exemplo.com/imagem.jpg"

linkPreviewLarge

boolean

Se true, gera um preview grande com upload da imagem. Se false, gera um preview pequeno sem upload

Exemplo:

true

replyid

string

ID da mensagem para responder

Exemplo:

"3EB0538DA65A59F6D8A251"

mentions

string

Números para mencionar (separados por vírgula)

Exemplo:

"5511999999999,5511888888888"

readchat

boolean

Marca conversa como lida após envio

Exemplo:

true

readmessages

boolean

Marca últimas mensagens recebidas como lidas

Exemplo:

true

delay

integer

Atraso em milissegundos antes do envio, durante o atraso apacerá 'Digitando...'

Exemplo:

1000

forward

boolean

Marca a mensagem como encaminhada no WhatsApp

Exemplo:

true

track_source

string

Origem do rastreamento da mensagem

Exemplo:

"chatwoot"

track_id

string

ID para rastreamento da mensagem (aceita valores duplicados)

Exemplo:

"msg_123456789"

Resposta

Mensagem enviada com sucesso

Representa uma mensagem trocada no sistema

string<uuid>

ID único interno da mensagem (formato r + 7 caracteres hex aleatórios)

messageid

string

ID original da mensagem no provedor

chatid

string

ID da conversa relacionada

fromMe

boolean

padrão:false

Indica se a mensagem foi enviada pelo usuário

isGroup

boolean

padrão:false

Indica se é uma mensagem de grupo

messageType

enum<string>

Tipo de conteúdo da mensagem

Opções disponíveis:

text,

image,

video,

document,

audio,

location,

button,

list,

reaction

messageTimestamp

integer

padrão:0

Timestamp original da mensagem em milissegundos

edited

string

padrão:""

Histórico de edições da mensagem

quoted

string

padrão:""

ID da mensagem citada/respondida

reaction

string

padrão:""

ID da mensagem reagida

sender

string

padrão:""

ID do remetente da mensagem

senderName

string

padrão:""

Nome exibido do remetente

source

enum<string>

padrão:""

Plataforma de origem da mensagem

Opções disponíveis:

ios,

web,

android

status

enum<string>

padrão:""

Status do ciclo de vida da mensagem

Opções disponíveis:

pending,

sent,

delivered,

read,

failed,

deleted

text

string

padrão:""

Texto original da mensagem

vote

string

padrão:""

Dados de votação de enquete e listas

buttonOrListid

string

padrão:""

ID do botão ou item de lista selecionado

convertOptions

string

padrão:""

Conversão de opções de da mensagem, lista, enquete e botões

fileURL

string<uri>

padrão:""

URL para download de arquivos de mídia

content

string

Conteúdo completo da mensagem em formato JSON

owner

string

padrão:""

Dono da mensagem

track_source

string

padrão:""

Origem do rastreamento da mensagem

track_id

string

padrão:""

ID para rastreamento da mensagem (aceita valores duplicados)

created

string<date-time>

padrão:(strftime('%Y-%m-%d %H:%M:%f', 'now'))

Data de criação no sistema (formato SQLite YYYY-MM-DD HH:MM:SS.FFF)

updated

string<date-time>

padrão:(strftime('%Y-%m-%d %H:%M:%f', 'now'))

Data da última atualização (formato SQLite YYYY-MM-DD HH:MM:SS.FFF)

ai_metadata

object

Metadados do processamento por IA

Show child attributes

response

object

Show child attributes

Altera a imagem do perfil do WhatsApp Enviar mídia (imagem, vídeo, áudio ou documento)