Enviar Contato (vCard)

Enviar um ou múltiplos contatos no formato vCard

POST /api/sendContactVcard

cURL

cURL

curl --request POST \
  --url https://{host}/api/sendContactVcard \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "chatId": "[e-mail]",
  "contacts": [
    {
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:Jane Doe\nORG:Company Name;\nTEL;type=CELL;type=VOICE;waid=911111111111:[phone]\nEND:VCARD"
    }
  ],
  "session": "my-session",
  "reply_to": null
}
'

Resposta de Sucesso

{
  "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": "[e-mail]",
  "contacts": [
    {
      "displayName": "João Silva",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:João Silva\nTEL;type=CELL;type=VOICE;waid=5511988887777:[phone]\nEND:VCARD"
    }
  ]
}

Parâmetros do Body

Propriedade	Tipo	Obrigatório	Descrição
sessionId	string	✅ Sim	ID da sessão autenticada que enviará os contatos
jid	string	✅ Sim	Identificador do destinatário (JID do WhatsApp). Formato: [e-mail] para contatos ou [e-mail] para grupos
contacts	array	✅ Sim	Array de objetos de contato
contacts[].displayName	string	✅ Sim	Nome de exibição do contato
contacts[].vcard	string	✅ Sim	Dados do contato no formato vCard (versão 3.0)

Resposta de Sucesso

{
  "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

curl -X POST https://api.wappfy.com.br/api/sendContactVcard \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "my-session",
    "jid": "[e-mail]",
    "contacts": [
      {
        "displayName": "João Silva",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:João Silva\nTEL;type=CELL;type=VOICE;waid=5511988887777:[phone]\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:

"[e-mail]"

contacts · object[] · required

Array de contatos no formato vCard

Option 1

Option 2

Show child attributes

session · string · required

Nome da sessão (instanceName)

Example:

"my-session"

reply_to · string

ID da mensagem à qual você deseja responder

Example:

null

Response

201 - undefined