Skip to main content
POST
/
api
/
sendContactVcard
cURL
curl --request POST \
  --url https://{host}/api/sendContactVcard \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "chatId": "5511999999999@c.us",
  "contacts": [
    {
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:Jane Doe\nORG:Company Name;\nTEL;type=CELL;type=VOICE;waid=911111111111:+91 11111 11111\nEND:VCARD"
    }
  ],
  "reply_to": null,
  "session": "my-session"
}'
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Descrição

Este endpoint permite enviar um ou mais contatos no formato vCard para contatos individuais ou grupos no WhatsApp. Os contatos são enviados com nome de exibição e informações no padrão vCard.

​
Body

{
  "sessionId": "my-session",
  "jid": "5511999999999@s.whatsapp.net",
  "contacts": [
    {
      "displayName": "João Silva",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:João Silva\nTEL;type=CELL;type=VOICE;waid=5511988887777:+55 11 98888-7777\nEND:VCARD"
    }
  ]
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
sessionIdstring✅ SimID da sessão autenticada que enviará os contatos
jidstring✅ SimIdentificador do destinatário (JID do WhatsApp). Formato: 5511999999999@s.whatsapp.net para contatos ou 120363XXXXX@g.us para grupos
contactsarray✅ SimArray de objetos de contato
contacts[].displayNamestring✅ SimNome de exibição do contato
contacts[].vcardstring✅ SimDados do contato no formato vCard (versão 3.0)
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Códigos de Status

  • 200 - Contato(s) enviado(s) com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Sessão não autorizada
  • 404 - Sessão não encontrada

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/sendContactVcard \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "my-session",
    "jid": "5511999999999@s.whatsapp.net",
    "contacts": [
      {
        "displayName": "João Silva",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:João Silva\nTEL;type=CELL;type=VOICE;waid=5511988887777:+55 11 98888-7777\nEND:VCARD"
      }
    ]
  }'

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Body

application/json
​
chatId
string
required

Identificador do chat (JID do WhatsApp)

Example:

"5511999999999@c.us"

​
contacts
object[]
required

Array de contatos no formato vCard

  • Option 1
  • Option 2
​
session
string
required

Nome da sessão (instanceName)

Example:

"my-session"

​
reply_to
string

ID da mensagem à qual você deseja responder

Example:

null