Skip to main content
POST
/
send
/
contact
Send contact card (vCard)
curl --request POST \
  --url https://api.wppfy.com/send/contact \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "number": "5511999999999",
  "fullName": "John Doe",
  "phoneNumber": "5511999999999,5511888888888",
  "organization": "Company XYZ",
  "email": "john@company.com",
  "url": "https://company.com/john",
  "replyid": "3EB0538DA65A59F6D8A251",
  "mentions": "5511999999999,5511888888888",
  "readchat": true,
  "readmessages": true,
  "delay": 1000,
  "forward": true,
  "track_source": "chatwoot",
  "track_id": "msg_123456789"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "messageid": "<string>",
  "chatid": "<string>",
  "fromMe": false,
  "isGroup": false,
  "messageType": "text",
  "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": "Contact card sent successfully"
  }
}

Authorizations

token
string
header
required

Body

application/json
number
string
required

Recipient number (international format)

Example:

"5511999999999"

fullName
string
required

Contact's full name

Example:

"John Doe"

phoneNumber
string
required

Phone numbers (comma separated)

Example:

"5511999999999,5511888888888"

organization
string

Organization/Company name

Example:

"Company XYZ"

email
string

Email address

Example:

"john@company.com"

url
string

Personal or company URL

Example:

"https://company.com/john"

replyid
string

ID of the message to reply to

Example:

"3EB0538DA65A59F6D8A251"

mentions
string

Numbers to mention (comma separated)

Example:

"5511999999999,5511888888888"

readchat
boolean

Marks chat as read after sending

Example:

true

readmessages
boolean

Marks latest received messages as read

Example:

true

delay
integer

Delay in milliseconds before sending; during delay 'Typing...' will appear

Example:

1000

forward
boolean

Marks the message as forwarded on WhatsApp

Example:

true

track_source
string

Message tracking source

Example:

"chatwoot"

track_id
string

ID for message tracking (accepts duplicate values)

Example:

"msg_123456789"

Response

Contact card sent successfully

Representa uma mensagem trocada no sistema

id
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
default:false

Indica se a mensagem foi enviada pelo usuário

isGroup
boolean
default:false

Indica se é uma mensagem de grupo

messageType
enum<string>

Tipo de conteúdo da mensagem

Available options:
text,
image,
video,
document,
audio,
location,
button,
list,
reaction
messageTimestamp
integer
default:0

Timestamp original da mensagem em milissegundos

edited
string
default:""

Histórico de edições da mensagem

quoted
string
default:""

ID da mensagem citada/respondida

reaction
string
default:""

ID da mensagem reagida

sender
string
default:""

ID do remetente da mensagem

senderName
string
default:""

Nome exibido do remetente

source
enum<string>
default:""

Plataforma de origem da mensagem

Available options:
ios,
web,
android
status
enum<string>
default:""

Status do ciclo de vida da mensagem

Available options:
pending,
sent,
delivered,
read,
failed,
deleted
text
string
default:""

Texto original da mensagem

vote
string
default:""

Dados de votação de enquete e listas

buttonOrListid
string
default:""

ID do botão ou item de lista selecionado

convertOptions
string
default:""

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

fileURL
string<uri>
default:""

URL para download de arquivos de mídia

content
string

Conteúdo completo da mensagem em formato JSON

owner
string
default:""

Dono da mensagem

track_source
string
default:""

Origem do rastreamento da mensagem

track_id
string
default:""

ID para rastreamento da mensagem (aceita valores duplicados)

created
string<date-time>
default:(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>
default:(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

response
object