Skip to main content
POST
/
api
/
{session}
/
events
Enviar uma mensagem de evento
curl --request POST \
  --url https://{host}/api/{session}/events \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data @- <<EOF
{
  "chatId": "[email protected]",
  "event": {
    "name": "John's Nail Appointment 💅",
    "startTime": 2063137000,
    "description": "It's time for your nail care session! 🌟\\n\\nYou'll be getting a *classic gel manicure* – clean, polished, and long-lasting. 💖\\n\\n📍 *Location:* Luxe Nail Studio\\nWe're on the *2nd floor of the Plaza Mall*, next to the flower shop. Look for the *pink neon sign*!\\n\\nFeel free to arrive *5–10 mins early* so we can get started on time 😊",
    "endTime": null,
    "location": {
      "name": "Luxe Nail Studio 💅"
    },
    "extraGuestsAllowed": false
  },
  "reply_to": null
}
EOF
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Descrição

Este endpoint permite enviar mensagens de evento para contatos individuais ou grupos no WhatsApp. Eventos podem incluir informações sobre nome, descrição, horários, localização e permissão para convidados extras.

​
Parâmetros de URL

​
session
string
required
ID da sessão autenticada que enviará o evento

​
Body

{
  "jid": "[email protected]",
  "event": {
    "name": "Meu Grupo",
    "description": "Descrição",
    "startTime": 0,
    "endTime": 0,
    "location": {
      "name": "Meu Grupo",
      "latitude": -23.5505,
      "longitude": -46.6333
    },
    "extraGuestsAllowed": true
  }
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
jidstring✅ SimIdentificador do destinatário (JID do WhatsApp). Formato: [email protected] para contatos ou [email protected] para grupos
eventobject✅ SimObjeto contendo as informações do evento
event.namestring✅ SimNome do evento
event.descriptionstring❌ NãoDescrição do evento
event.startTimenumber✅ SimTimestamp Unix (em milissegundos) indicando o horário de início do evento
event.endTimenumber❌ NãoTimestamp Unix (em milissegundos) indicando o horário de término do evento
event.locationobject✅ SimInformações sobre a localização do evento
event.location.namestring✅ SimNome ou endereço da localização
event.location.latitudenumber❌ NãoLatitude da localização
event.location.longitudenumber❌ NãoLongitude da localização
event.extraGuestsAllowedboolean✅ SimDefine se convidados extras são permitidos no evento
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Códigos de Status

  • 200 - Evento enviado com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Sessão não autorizada
  • 404 - Sessão não encontrada

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/events \
  -H "Content-Type: application/json" \
  -d '{
    "jid": "[email protected]",
    "event": {
      "name": "Reunião de Equipe",
      "description": "Discussão sobre o projeto Q1",
      "startTime": 1704034800000,
      "endTime": 1704038400000,
      "location": {
        "name": "Sala de Conferências A, Av. Paulista 1000",
        "latitude": -23.561684,
        "longitude": -46.655981
      },
      "extraGuestsAllowed": true
    }
  }'

​
Notas Importantes

  • Os timestamps devem estar em formato Unix (milissegundos)
  • A localização é obrigatória, mas latitude e longitude são opcionais
  • Se extraGuestsAllowed for true, os convidados poderão trazer pessoas adicionais
  • O evento será exibido no WhatsApp com um card especial contendo todas as informações fornecidas

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
session
string
required

Nome da sessão (instanceName)

Body

application/json
​
chatId
string
required
​
event
object
required
​
reply_to
string

ID da mensagem à qual você deseja responder

Example:

null

Response

201 - application/json
​
id
string
required

ID da mensagem

Example:

"[email protected]_AAAAAAAAAAAAAAAAAAAA"

​
timestamp
number
required

Timestamp Unix de quando a mensagem foi criada

Example:

1666943582

​
from
string
required

ID do chat para o qual esta mensagem foi enviada

Example:

"[email protected]"

​
fromMe
boolean
required

Indica se a mensagem foi enviada pelo usuário atual

​
source
enum<string>
required

The device that sent the message - either API or APP. Available in events (webhooks/websockets) only and only "fromMe: true" messages.

Available options:
api,
app
Example:

"api"

​
to
string
required
  • ID for who this message is for.
  • If the message is sent by the current user, it will be the Chat to which the message is being sent.
  • If the message is sent by another user, it will be the ID for the current user.
Example:

"[email protected]"

​
participant
string
required

Para grupos - participante que enviou a mensagem

​
body
string
required

Conteúdo da mensagem

​
hasMedia
boolean
required

Indica se a mensagem possui mídia disponível para download

​
ack
enum<number>
required

Status de confirmação (ACK) da mensagem

Available options:
-1,
0,
1,
2,
3,
4
​
ackName
string
required

Nome do status de confirmação da mensagem

​
media
object

Objeto de mídia da mensagem, se houver e foi baixada

​
author
string

Se a mensagem foi enviada para um grupo, este campo conterá o usuário que enviou a mensagem

​
location
object

Informações de localização contidas na mensagem

​
vCards
string[]

Lista de vCards contidos na mensagem

​
_data
object

Mensagem em formato bruto do WhatsApp. Pode mudar a qualquer momento, use com cautela!

​
replyTo
object