Lista de Contatos
O tipoCONTACTS_MESSAGE permite enviar múltiplos cartões de contato (vCards) em uma única mensagem. Ideal para compartilhar equipes, listas de atendentes ou contatos de filiais.
Payload
{
"channelId": "uuid-do-canal",
"content": {
"type": "CONTACTS_MESSAGE",
"to": {
"type": "WHATSAPP",
"number": "5511999999999"
},
"contacts": [
{
"displayName": "Vendas - Ana",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Ana;;;\nFN:Ana - Vendas\nORG:MinhaEmpresa\nTEL;type=CELL;waid=5511911112222:+55 11 91111-2222\nEND:VCARD"
},
{
"displayName": "Suporte - Pedro",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Pedro;;;\nFN:Pedro - Suporte\nORG:MinhaEmpresa\nTEL;type=CELL;waid=5511933334444:+55 11 93333-4444\nEND:VCARD"
}
]
}
}
Campos
string
required
Deve ser
"CONTACTS_MESSAGE".Address
required
Endereço do destinatário. Veja formatos de endereço.
array
required
Lista de contatos a enviar. Cada item contém
displayName e vCard.string
required
Nome de exibição do contato no cartão.
string
required
Conteúdo do cartão de contato no formato vCard 3.0.
Exemplos
Equipe de atendimento
curl -X POST https://api-dev.messagefy.io/api/v1/message/SendMessage \
-H "Content-Type: application/json" \
-H "X-API-KEY: sua-api-key-aqui" \
-d '{
"channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"content": {
"type": "CONTACTS_MESSAGE",
"to": {
"type": "WHATSAPP",
"number": "5511999999999"
},
"contacts": [
{
"displayName": "Comercial - Juliana",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Juliana;;;\nFN:Juliana - Comercial\nORG:MessageFy\nTEL;type=CELL;waid=5511900001111:+55 11 90000-1111\nEMAIL:juliana@messagefy.io\nEND:VCARD"
},
{
"displayName": "Suporte Tecnico - Rafael",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Rafael;;;\nFN:Rafael - Suporte Tecnico\nORG:MessageFy\nTEL;type=CELL;waid=5511900002222:+55 11 90000-2222\nEMAIL:rafael@messagefy.io\nEND:VCARD"
},
{
"displayName": "Financeiro - Carla",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Carla;;;\nFN:Carla - Financeiro\nORG:MessageFy\nTEL;type=CELL;waid=5511900003333:+55 11 90000-3333\nEMAIL:carla@messagefy.io\nEND:VCARD"
}
]
}
}'
import requests
contacts = [
{
"displayName": "Comercial - Juliana",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Juliana;;;\nFN:Juliana - Comercial\nORG:MessageFy\nTEL;type=CELL;waid=5511900001111:+55 11 90000-1111\nEMAIL:juliana@messagefy.io\nEND:VCARD"
},
{
"displayName": "Suporte Tecnico - Rafael",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Rafael;;;\nFN:Rafael - Suporte Tecnico\nORG:MessageFy\nTEL;type=CELL;waid=5511900002222:+55 11 90000-2222\nEMAIL:rafael@messagefy.io\nEND:VCARD"
},
{
"displayName": "Financeiro - Carla",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Carla;;;\nFN:Carla - Financeiro\nORG:MessageFy\nTEL;type=CELL;waid=5511900003333:+55 11 90000-3333\nEMAIL:carla@messagefy.io\nEND:VCARD"
}
]
response = requests.post(
"https://api-dev.messagefy.io/api/v1/message/SendMessage",
headers={
"Content-Type": "application/json",
"X-API-KEY": "sua-api-key-aqui"
},
json={
"channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"content": {
"type": "CONTACTS_MESSAGE",
"to": {
"type": "WHATSAPP",
"number": "5511999999999"
},
"contacts": contacts
}
}
)
print(response.json())
const contacts = [
{
displayName: "Comercial - Juliana",
vCard:
"BEGIN:VCARD\nVERSION:3.0\nN:;Juliana;;;\nFN:Juliana - Comercial\nORG:MessageFy\nTEL;type=CELL;waid=5511900001111:+55 11 90000-1111\nEMAIL:juliana@messagefy.io\nEND:VCARD",
},
{
displayName: "Suporte Tecnico - Rafael",
vCard:
"BEGIN:VCARD\nVERSION:3.0\nN:;Rafael;;;\nFN:Rafael - Suporte Tecnico\nORG:MessageFy\nTEL;type=CELL;waid=5511900002222:+55 11 90000-2222\nEMAIL:rafael@messagefy.io\nEND:VCARD",
},
{
displayName: "Financeiro - Carla",
vCard:
"BEGIN:VCARD\nVERSION:3.0\nN:;Carla;;;\nFN:Carla - Financeiro\nORG:MessageFy\nTEL;type=CELL;waid=5511900003333:+55 11 90000-3333\nEMAIL:carla@messagefy.io\nEND:VCARD",
},
];
const response = await fetch(
"https://api-dev.messagefy.io/api/v1/message/SendMessage",
{
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-KEY": "sua-api-key-aqui",
},
body: JSON.stringify({
channelId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
content: {
type: "CONTACTS_MESSAGE",
to: {
type: "WHATSAPP",
number: "5511999999999",
},
contacts: contacts,
},
}),
}
);
const data = await response.json();
console.log(data);
Contatos de filiais
{
"channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"content": {
"type": "CONTACTS_MESSAGE",
"to": {
"type": "WHATSAPP",
"number": "5511999999999"
},
"contacts": [
{
"displayName": "Filial Sao Paulo",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Filial SP;;;\nFN:Filial Sao Paulo\nORG:MinhaEmpresa\nTEL;type=WORK:+55 11 3456-7890\nADR;type=WORK:;;Av. Paulista, 1000;Sao Paulo;SP;01310-100;Brasil\nEND:VCARD"
},
{
"displayName": "Filial Rio de Janeiro",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;Filial RJ;;;\nFN:Filial Rio de Janeiro\nORG:MinhaEmpresa\nTEL;type=WORK:+55 21 2345-6789\nADR;type=WORK:;;Av. Rio Branco, 500;Rio de Janeiro;RJ;20040-002;Brasil\nEND:VCARD"
}
]
}
}
Para enviar apenas um contato, use o tipo CONTACT_MESSAGE que tem uma interface mais simples. Use
CONTACTS_MESSAGE quando precisar enviar dois ou mais contatos de uma vez.Resposta
{
"packageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}