> ## 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.

# Enviar Contato

> Envia um ou múltiplos contatos como vCard

**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.

<CodeGroup>
  ```bash cURL theme={null}
  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"
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/contact/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number: "5511999999999",
      vcard: [
        {
          fullName: "João Silva",
          phone:    "5511888888888"
        }
      ]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/contact/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number": "5511999999999",
          "vcard": [
              {
                  "fullName": "João Silva",
                  "phone":    "5511888888888"
              }
          ]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number": "5511999999999",
          "vcard": [
              {
                  "fullName": "João Silva",
                  "phone":    "5511888888888"
              }
          ]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/contact/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### 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.

<CodeGroup>
  ```bash cURL theme={null}
  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"
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/contact/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number: "5511999999999",
      vcard: [
        { fullName: "João Silva",   phone: "5511888888888" },
        { fullName: "Maria Souza",  phone: "5511777777777" },
        { fullName: "Carlos Lima",  phone: "5511666666666" }
      ]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/contact/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number": "5511999999999",
          "vcard": [
              {"fullName": "João Silva",  "phone": "5511888888888"},
              {"fullName": "Maria Souza", "phone": "5511777777777"},
              {"fullName": "Carlos Lima", "phone": "5511666666666"}
          ]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number": "5511999999999",
          "vcard": [
              { "fullName": "João Silva",  "phone": "5511888888888" },
              { "fullName": "Maria Souza", "phone": "5511777777777" },
              { "fullName": "Carlos Lima", "phone": "5511666666666" }
          ]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/contact/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### 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.

<CodeGroup>
  ```bash cURL theme={null}
  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"
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/contact/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number: "5511999999999",
      vcard: [
        {
          fullName:     "João Silva",
          phone:        "5511888888888",
          organization: "Example S.A.",
          email:        "joao@example.com",
          url:          "https://example.com"
        }
      ]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/contact/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number": "5511999999999",
          "vcard": [
              {
                  "fullName":     "João Silva",
                  "phone":        "5511888888888",
                  "organization": "Example S.A.",
                  "email":        "joao@example.com",
                  "url":          "https://example.com"
              }
          ]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number": "5511999999999",
          "vcard": [
              {
                  "fullName":     "João Silva",
                  "phone":        "5511888888888",
                  "organization": "Example S.A.",
                  "email":        "joao@example.com",
                  "url":          "https://example.com"
              }
          ]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/contact/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## 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"`.

```json 200 OK theme={null}
{
  "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"
    }
  }
}
```

<Note>
  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).
</Note>

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `$Instance_Name`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="number" type="string" required>
  Destino: telefone (`5511999999999`) ou JID (`@s.whatsapp.net`, `@lid`, `@g.us`, `@newsletter`).
</ParamField>

<ParamField body="vcard" type="VCard[]" required>
  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.
</ParamField>

<ParamField body="vcard[].fullName" type="string" required>
  Nome completo do contato. Aparece como rótulo principal do card.
</ParamField>

<ParamField body="vcard[].phone" type="string" required>
  Número de telefone do contato (com código do país, ex.: `5511888888888`).
</ParamField>

<ParamField body="vcard[].organization" type="string">
  Organização/empresa do contato (opcional).
</ParamField>

<ParamField body="vcard[].email" type="string">
  E-mail do contato (opcional).
</ParamField>

<ParamField body="vcard[].url" type="string">
  URL/website do contato (opcional).
</ParamField>

<ParamField body="delay" type="int" default="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.
</ParamField>

<ParamField body="replyTo" type="string">
  ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.
</ParamField>

<ParamField body="replyPrivate" type="boolean" default="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`.
</ParamField>

<ParamField body="source" type="string" default="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"`.
</ParamField>

## Notas

<Note>
  * **`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`.
</Note>

## Erros

| HTTP | Status interno   | Mensagem                                         |
| ---- | ---------------- | ------------------------------------------------ |
| 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` |
| 400  | `invalid_number` | `Invalid phone number format: <detalhe>`         |
| 500  | `send_failed`    | `Failed to send message: <reason>`               |
| 404  | ,                | `Instance not found`                             |
| 503  | `disconnected`   | `Instance is not connected to WhatsApp`          |

Envelope de erro:

```json theme={null}
{
  "success": false,
  "error": { "message": "At least one contact (vcard) is required" }
}
```