Enviar Contato - Oxenty API

curl -X POST "https://api.oxenty.api.br/api/messages/vcard" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "to": "5511999999999",
    "displayName": "João Silva",
    "phoneNumber": "+5511988887777",
    "organization": "Oxenty"
  }'

const result = await client.messages.sendVCard({
  sessionId: '550e8400-e29b-41d4-a716-446655440000',
  to: '5511999999999',
  displayName: 'João Silva',
  phoneNumber: '+5511988887777',
  organization: 'Oxenty',
});

{
  "messageId": "3EB0A1B2C3D4E5F6",
  "status": "sent"
}

POST

api

messages

vcard

curl -X POST "https://api.oxenty.api.br/api/messages/vcard" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "to": "5511999999999",
    "displayName": "João Silva",
    "phoneNumber": "+5511988887777",
    "organization": "Oxenty"
  }'

const result = await client.messages.sendVCard({
  sessionId: '550e8400-e29b-41d4-a716-446655440000',
  to: '5511999999999',
  displayName: 'João Silva',
  phoneNumber: '+5511988887777',
  organization: 'Oxenty',
});

{
  "messageId": "3EB0A1B2C3D4E5F6",
  "status": "sent"
}

Envia um cartão de contato para um número WhatsApp.

Request Body

sessionId

string

required

ID da sessão WhatsApp.

string

required

Número do destinatário ou JID de grupo.

displayName

string

required

Nome de exibição do contato.

phoneNumber

string

required

Número de telefone do contato.

organization

string

Organização/empresa do contato (opcional).

Resposta

messageId

string

ID único da mensagem enviada.

curl -X POST "https://api.oxenty.api.br/api/messages/vcard" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "to": "5511999999999",
    "displayName": "João Silva",
    "phoneNumber": "+5511988887777",
    "organization": "Oxenty"
  }'

const result = await client.messages.sendVCard({
  sessionId: '550e8400-e29b-41d4-a716-446655440000',
  to: '5511999999999',
  displayName: 'João Silva',
  phoneNumber: '+5511988887777',
  organization: 'Oxenty',
});

{
  "messageId": "3EB0A1B2C3D4E5F6",
  "status": "sent"
}

Enviar Múltiplos Contatos

Envia múltiplos cartões de contato em uma única mensagem.

curl -X POST "https://api.oxenty.api.br/api/messages/vcards" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "to": "5511999999999",
    "displayName": "Contatos Oxenty",
    "contacts": [
      { "displayName": "João Silva", "phoneNumber": "+5511988887777" },
      { "displayName": "Maria Santos", "phoneNumber": "+5511977776666" }
    ]
  }'

Enviar Lista Enviar PIX

​Request Body

​Resposta

​Enviar Múltiplos Contatos

Request Body

Resposta

Enviar Múltiplos Contatos