Info do Contato
O comando Info do Contato retorna informações detalhadas de um contato específico, incluindo nome, foto de perfil e status na plataforma.Requisição
POST /api/v1/message/SendCommand
{
"channelId": "uuid-do-canal",
"content": {
"type": "CONTACT_INFO",
"commandType": "CONTACT_INFO",
"phoneNumber": "5511999887766"
}
}
Campos
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
phoneNumber | string | Sim | Número do telefone com código do país (sem +, sem espacos) |
Resposta da API
{
"packageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Webhook de resposta
O resultado é entregue via webhook do tipoCONTACT_INFO_RESPONSE:
{
"packageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"channelId": "uuid-do-canal",
"content": {
"type": "CONTACT_INFO_RESPONSE",
"displayName": "João da Silva",
"fullName": "João da Silva Santos",
"enabledOnPlatform": true,
"jid": "5511999887766@s.whatsapp.net",
"lid": "123456789012345@lid",
"phoneNumber": "5511999887766",
"profilePictureDownload": "https://pps.whatsapp.net/v/t61.24694-24/...",
"profilePictureType": "preview",
"pushName": "João Silva",
"message": null
}
}
Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
displayName | string | Nome de exibição do contato |
fullName | string | Nome completo do contato |
enabledOnPlatform | boolean | Indica se o número está registrado no WhatsApp |
jid | string | Identificador único do contato no WhatsApp (JID) |
lid | string | Identificador LID (LinkedID) do contato no WhatsApp |
phoneNumber | string | Número de telefone resolvido do contato |
profilePictureDownload | string | URL para download da foto de perfil |
profilePictureType | string | Tipo da foto de perfil retornada (ex.: preview ou full) |
pushName | string | Nome definido pelo proprio contato no WhatsApp |
message | string | Mensagem auxiliar (ex.: erro) quando o número não pode ser resolvido |
O campo
profilePictureDownload contém uma URL temporária. Faça o download da imagem
assim que receber o webhook, pois a URL pode expirar.Exemplo completo
curl -X POST https://api-dev.messagefy.io/api/v1/message/SendCommand \
-H "Content-Type: application/json" \
-H "X-API-KEY: sua-api-key" \
-d '{
"channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"content": {
"type": "CONTACT_INFO",
"commandType": "CONTACT_INFO",
"phoneNumber": "5511999887766"
}
}'
import requests
response = requests.post(
"https://api-dev.messagefy.io/api/v1/message/SendCommand",
headers={
"Content-Type": "application/json",
"X-API-KEY": "sua-api-key"
},
json={
"channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"content": {
"type": "CONTACT_INFO",
"commandType": "CONTACT_INFO",
"phoneNumber": "5511999887766"
}
}
)
print(response.json())
const response = await fetch(
"https://api-dev.messagefy.io/api/v1/message/SendCommand",
{
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-KEY": "sua-api-key",
},
body: JSON.stringify({
channelId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
content: {
type: "CONTACT_INFO",
commandType: "CONTACT_INFO",
phoneNumber: "5511999887766",
},
}),
}
);
const data = await response.json();
console.log(data);
Use o campo
enabledOnPlatform para verificar se um número está registrado no WhatsApp
antes de tentar enviar mensagens.