Contato

Cartão de contato, que o contato salva com um toque.

• contacts[]: o contato. Por enquanto vai um por mensagem (com mais, responde 400).
  • name: o nome exibido.
  • phones[]: os telefones, com DDI.
  • email, organization e url: opcionais.

Canais

Pedido

POST /messages com "type": "contacts". Testar

{
  "to": "5511999999999",
  "type": "contacts",
  "contacts": [
    {
      "name": "Suporte Loja",
      "phones": [
        "5511977776666",
        "5511955554444"
      ],
      "organization": "Loja",
      "email": "suporte@loja.exemplo"
    }
  ]
}

Na uazapi

POST /send/contact, que continua funcionando. Na uazapi os telefones iam numa string separada por vírgula (phoneNumber); na Orkesio é a lista phones.

{
  "number": "5511999999999",
  "fullName": "Suporte Loja",
  "phoneNumber": "5511977776666,5511955554444",
  "organization": "Loja",
  "email": "suporte@loja.exemplo"
}

{
  "to": "5511999999999",
  "type": "contacts",
  "contacts": [
    {
      "name": "Suporte Loja",
      "phones": [
        "5511977776666",
        "5511955554444"
      ],
      "organization": "Loja",
      "email": "suporte@loja.exemplo"
    }
  ]
}

Resposta

A própria mensagem (OrkesioMessage), no formato do message.sent e da busca. No WhatsApp Web volta na hora com status: queued: por padrão o envio vai pela fila (com options.async: false, espera o envio e volta a mensagem enviada). É o pedido no formato da mensagem: o arquivo, a miniatura e a prévia do link chegam no message.sent. Na API oficial volta depois que a Meta aceita, com status: pending. O resultado chega em message.status (a falha também em message.failed).

{
  "id": "3EB05DCE1D4036FCE241C6",
  "chat_id": "5511999999999@s.whatsapp.net",
  "author": {
    "id": "5511888888888@s.whatsapp.net",
    "phone": "5511888888888"
  },
  "direction": "out",
  "sent_at": "2026-10-17T12:00:00.000Z",
  "category": "unsent",
  "type": "contacts",
  "contacts": [
    {
      "name": "Suporte Loja",
      "phones": [
        {
          "number": "5511977776666"
        },
        {
          "number": "5511955554444"
        }
      ]
    }
  ],
  "sent_by": "api",
  "status": "queued"
}

Na uazapi

O content da uazapi é o proto do WhatsApp; aqui vai resumido (...).

{
  "id": "5511888888888:3EB05DCE1D4036FCE241C6",
  "messageid": "3EB05DCE1D4036FCE241C6",
  "chatid": "5511999999999@s.whatsapp.net",
  "chatlid": "123456789012345@lid",
  "fromMe": true,
  "isGroup": false,
  "groupName": "",
  "sender": "987654321098765@lid",
  "sender_pn": "5511888888888@s.whatsapp.net",
  "sender_lid": "987654321098765@lid",
  "senderName": "",
  "messageType": "ContactMessage",
  "mediaType": "",
  "messageTimestamp": 1792238400000,
  "source": "web",
  "status": "",
  "text": "",
  "content": {
    "displayName": "Suporte Loja",
    "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:Suporte Loja\n...\nEND:VCARD"
  },
  "quoted": "",
  "edited": "",
  "reaction": "",
  "vote": "",
  "buttonOrListid": "",
  "convertOptions": "",
  "pinned": false,
  "owner": "5511888888888",
  "wasSentByApi": true,
  "track_source": "",
  "track_id": "",
  "response": {
    "status": "success",
    "message": "Message sent successfully"
  }
}

{
  "id": "3EB05DCE1D4036FCE241C6",
  "chat_id": "5511999999999@s.whatsapp.net",
  "author": {
    "id": "5511888888888@s.whatsapp.net",
    "phone": "5511888888888"
  },
  "direction": "out",
  "sent_at": "2026-10-17T12:00:00.000Z",
  "category": "unsent",
  "type": "contacts",
  "contacts": [
    {
      "name": "Suporte Loja",
      "phones": [
        {
          "number": "5511977776666"
        },
        {
          "number": "5511955554444"
        }
      ]
    }
  ],
  "sent_by": "api",
  "status": "queued"
}

No webhook

O que chega no seu webhook (ou em GET /events) depois do envio.

message.sent

Quando a mensagem sai. O evento message.sent

{
  "id": "evt_01JAB3K9ZQ7V0M4T8R2X6WYD5H",
  "type": "message.sent",
  "created_at": "2026-10-17T12:00:00.000Z",
  "inbox": {
    "id": "r0269625d29bfbd",
    "name": "loja",
    "phone": "5511888888888",
    "channel": "whatsapp_web"
  },
  "data": {
    "message": {
      "id": "3EB05DCE1D4036FCE241C6",
      "chat_id": "5511999999999@s.whatsapp.net",
      "author": {
        "id": "5511888888888@s.whatsapp.net",
        "phone": "5511888888888"
      },
      "direction": "out",
      "sent_at": "2026-10-17T12:00:00.000Z",
      "category": "conversation",
      "type": "contacts",
      "contacts": [
        {
          "name": "Suporte Loja",
          "phones": [
            {
              "number": "+55 11 97777-6666",
              "wa_id": "5511977776666"
            },
            {
              "number": "+55 11 95555-4444",
              "wa_id": "5511955554444"
            }
          ],
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:Suporte Loja\n...\nEND:VCARD"
        }
      ],
      "sent_by": "api"
    },
    "chat": {
      "id": "5511999999999@s.whatsapp.net",
      "lid": "123456789012345@lid",
      "type": "direct"
    }
  }
}

message.status

sent, delivered, read e played (áudio e voz), um evento por mudança; failed se o envio falhar. O evento message.status

{
  "id": "evt_01JAB3K9ZQ7V0M4T8R2X6WYD6J",
  "type": "message.status",
  "created_at": "2026-10-17T12:00:05.000Z",
  "inbox": {
    "id": "r0269625d29bfbd",
    "name": "loja",
    "phone": "5511888888888",
    "channel": "whatsapp_web"
  },
  "data": {
    "chat": {
      "id": "5511999999999@s.whatsapp.net",
      "lid": "123456789012345@lid",
      "type": "direct"
    },
    "status": "delivered",
    "at": "2026-10-17T12:00:05.000Z",
    "messages": [
      {
        "id": "3EB05DCE1D4036FCE241C6"
      }
    ]
  }
}