inbox.vcard_preview

Ver o cartão de contato: foto e se tem WhatsApp. Para cada contato do cartão (type: contacts): nome, telefone, se o telefone tem WhatsApp (hasWhatsapp, null se não deu para saber), foto (pictureUrl) e o contactId do Atomiks quando já existe. A consulta ao WhatsApp fica guardada no meta da mensagem por 24 h. Em número que não é por QR code só devolve nome e telefone.

• Endpoint: POST https://app.atomiks.com.br/api/v1/inbox.vcard_preview (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: messages:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: inbox_vcard_preview
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId inbox.vcard_preview)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "messageId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/inbox.vcard_preview \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"messageId":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs inbox.vcard_preview --json '{"messageId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta inbox_vcard_preview com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "phones": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "hasWhatsapp": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "pictureUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "contactId": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "name",
          "phone",
          "phones",
          "hasWhatsapp",
          "pictureUrl",
          "contactId"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "contacts"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).