Pular para o conteúdo principal
POST
/
api
/
message
/
contact
/
:instance
Enviar Contato
curl --request POST \
  --url https://api.example.com/api/message/contact/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "vcard": [
    {}
  ],
  "vcard[].fullName": "<string>",
  "vcard[].phone": "<string>",
  "vcard[].organization": "<string>",
  "vcard[].email": "<string>",
  "vcard[].url": "<string>",
  "delay": 123,
  "replyTo": "<string>",
  "replyPrivate": true,
  "source": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: não

​
Descrição

Envia um ou mais contatos como vCard. O destinatário recebe um card clicável que pode adicionar o contato direto à agenda. O campo vcard aceita um array de objetos VCard (envio múltiplo) ou um único objeto (compatibilidade retroativa, o servidor aceita ambos os formatos). Suporta replyTo, replyPrivate, delay (em segundos) e source. Não suporta menções.

​
Exemplos

​
Contato único

Envia um vCard com o mínimo necessário (fullName e phone). O destinatário recebe um único card clicável com o contato “João Silva” pronto para ser adicionado à agenda. 
curl -X POST "https://ryzeapi.cloud/api/message/contact/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "vcard": [
      {
        "fullName": "João Silva",
        "phone":    "5511888888888"
      }
    ]
  }'

​
Múltiplos contatos

Passa três contatos no array vcard. O servidor envia tudo como um ContactsArrayMessage único, o destinatário visualiza um card agrupado e escolhe quais nomes deseja adicionar à agenda. 
curl -X POST "https://ryzeapi.cloud/api/message/contact/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "vcard": [
      {
        "fullName": "João Silva",
        "phone":    "5511888888888"
      },
      {
        "fullName": "Maria Souza",
        "phone":    "5511777777777"
      },
      {
        "fullName": "Carlos Lima",
        "phone":    "5511666666666"
      }
    ]
  }'

​
Contato com organização, e-mail e site

Inclui os campos opcionais organization, email e url no vCard. O card resultante exibe a empresa, o e-mail de contato e o site abaixo do nome, ideal para apresentar contatos comerciais completos. 
curl -X POST "https://ryzeapi.cloud/api/message/contact/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "vcard": [
      {
        "fullName":     "João Silva",
        "phone":        "5511888888888",
        "organization": "Example S.A.",
        "email":        "joao@example.com",
        "url":          "https://example.com"
      }
    ]
  }'

​
Resposta de sucesso

O array vcard da resposta ecoa exatamente o que você enviou (com todos os contatos). Quando há mais de um contato, a message vira "X contacts sent successfully in one message".
200 OK
{
  "success": true,
  "message": "Contact sent successfully",
  "status":  "sent",
  "data": {
    "messageId":   "3EB08FCF27E532F1B0F5",
    "direction":   "sent",
    "messageType": "contact",
    "vcard": [
      {
        "fullName":     "João Silva",
        "phone":        "5511888888888",
        "organization": "Example S.A.",
        "email":        "joao@example.com",
        "url":          "https://example.com"
      }
    ],
    "source":    "api",
    "timestamp": "2026-04-30T14:30:00Z",
    "chat": {
      "jid":     "5511999999999@s.whatsapp.net",
      "isGroup": false
    },
    "sender": {
      "jid":      "5511777777777@s.whatsapp.net",
      "instance": "minha-instancia"
    }
  }
}
Quando o vcard contém apenas um item, o servidor envia como ContactMessage. Para múltiplos itens, é enviado como ContactsArrayMessage (uma única mensagem agrupando vários cards).

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância (ex.: $Instance_Name).

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

​
number
string
obrigatório
Destino: telefone (5511999999999) ou JID (@s.whatsapp.net, @lid, @g.us, @newsletter).
​
vcard
VCard[]
obrigatório
Array de contatos a enviar. Cada item segue a estrutura abaixo. O handler também aceita um único objeto VCard (sem array) por compatibilidade retroativa, convertendo internamente para um array de um item. Pelo menos um contato é obrigatório.
​
vcard[].fullName
string
obrigatório
Nome completo do contato. Aparece como rótulo principal do card.
​
vcard[].phone
string
obrigatório
Número de telefone do contato (com código do país, ex.: 5511888888888).
​
vcard[].organization
string
Organização/empresa do contato (opcional).
​
vcard[].email
string
E-mail do contato (opcional).
​
vcard[].url
string
URL/website do contato (opcional).
​
delay
int
padrão:"0"
Tempo em segundos para aguardar antes de enviar. Durante o intervalo, o servidor envia o indicador de “digitando…” ao destinatário e dispara o “paused” antes do envio real.
​
replyTo
string
ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.
​
replyPrivate
boolean
padrão:"false"
Quando true e replyTo aponta para uma mensagem originária de um grupo, a resposta é redirecionada para o privado do autor original (mantendo a citação). Ignorado se a mensagem original não for de grupo. Advisory: este campo está definido na struct mas o handler de contatos faz parsing manual do JSON e não está extraindo o replyPrivate do payload, então atualmente é tratado como false.
​
source
string
padrão:"api"
Identificador de origem para rastreabilidade (ex.: crm, bot-suporte, n8n). Salvo no registro da mensagem no banco e propagado para webhooks. Quando omitido, assume "api".

​
Notas

  • delay é em segundos, não milissegundos.
  • O campo vcard aceita tanto array quanto objeto único. Recomendado usar sempre array ([ {...} ]) para evitar ambiguidade.
  • Cada contato exige fullName e phone preenchidos. organization, email e url são opcionais.
  • Para envios múltiplos, o WhatsApp agrupa os contatos em um único card no chat, o destinatário pode escolher quais adicionar.
  • Mensagens de contato não suportam mention nem mentionAll.
  • Para números BR (começando com 55), o serviço tenta automaticamente variações com e sem o 9º dígito.
  • Cada contato no array passa por validação individual; se o item N falha, a resposta é 400 Contact full name is required for contact N ou 400 Contact phone number is required for contact N.

​
Erros

HTTPStatus internoMensagem
400—Instance name is required
400—Invalid JSON format: <detalhe>
400—Failed to read request body: <detalhe>
400—Number is required
400—At least one contact (vcard) is required
400—Contact full name is required for contact N
400—Contact phone number is required for contact N
400invalid_numberInvalid phone number format: <detalhe>
500send_failedFailed to send message: <reason>
404—Instance not found
503disconnectedInstance is not connected to WhatsApp
Envelope de erro: 
{
  "success": false,
  "error": { "message": "At least one contact (vcard) is required" }
}