# Evento

Convite de evento, que o contato confirma (vou, não vou, talvez).

- `text`: o nome do evento.
- `description`: a descrição.
- `start_at` e `end_at`: início e fim, em ISO 8601 (UTC).
- `location`: o lugar (`name` e `address`).
- `join_link`: o link da chamada (HTTPS). Com ele, o evento vira chamada agendada.
- `reminder_minutes`: o lembrete, em minutos antes do início.
- `canceled: true`: cancela o evento.

## Canais

| Canal | Funciona | Observação |
|---|---|---|
| WhatsApp (Web) | Sim |  |
| WhatsApp (API oficial) | Não |  |
| Instagram | Não |  |
| Messenger | Não |  |
| Telegram | Não |  |

## Pedido

`POST /messages` com `"type": "event"`. [Testar](/endpoint/post/messages)

```json
{
  "to": "5511999999999",
  "type": "event",
  "text": "Reunião de apresentação",
  "description": "Demonstração do produto",
  "start_at": "2026-10-17T15:00:00.000Z",
  "end_at": "2026-10-17T16:00:00.000Z",
  "location": {
    "name": "Escritório",
    "address": "Av. Paulista, 1000"
  },
  "reminder_minutes": 15
}
```

### Na uazapi

`POST /send/event`, que continua funcionando. Na uazapi as datas iam em segundos Unix (`startTime`, `endTime`); na Orkesio, em ISO. Com `join_link`, o evento vira chamada agendada (o `isScheduleCall` da uazapi).

```lado-a-lado
{
  "uazapi (POST /send/event)": {
    "number": "5511999999999",
    "name": "Reunião de apresentação",
    "description": "Demonstração do produto",
    "startTime": 1792249200,
    "endTime": 1792252800,
    "location": {
      "name": "Escritório",
      "address": "Av. Paulista, 1000"
    },
    "hasReminder": true,
    "reminderOffsetSec": 900
  },
  "Orkesio (POST /messages)": {
    "to": "5511999999999",
    "type": "event",
    "text": "Reunião de apresentação",
    "description": "Demonstração do produto",
    "start_at": "2026-10-17T15:00:00.000Z",
    "end_at": "2026-10-17T16:00:00.000Z",
    "location": {
      "name": "Escritório",
      "address": "Av. Paulista, 1000"
    },
    "reminder_minutes": 15
  }
}
```

## 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`).

```json
{
  "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": "event",
  "text": "Reunião de apresentação",
  "description": "Demonstração do produto",
  "start_at": "2026-10-17T15:00:00.000Z",
  "end_at": "2026-10-17T16:00:00.000Z",
  "location": {
    "name": "Escritório",
    "address": "Av. Paulista, 1000"
  },
  "sent_by": "api",
  "status": "queued"
}
```

### Na uazapi

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

```lado-a-lado
{
  "uazapi": {
    "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": "EventMessage",
    "mediaType": "",
    "messageTimestamp": 1792238400000,
    "source": "web",
    "status": "",
    "text": "",
    "content": {
      "name": "Reunião de apresentação",
      "description": "Demonstração do produto",
      "startTime": 1792249200,
      "endTime": 1792252800,
      "location": {
        "name": "Escritório"
      }
    },
    "quoted": "",
    "edited": "",
    "reaction": "",
    "vote": "",
    "buttonOrListid": "",
    "convertOptions": "",
    "pinned": false,
    "owner": "5511888888888",
    "wasSentByApi": true,
    "track_source": "",
    "track_id": "",
    "response": {
      "status": "success",
      "message": "Message sent successfully"
    }
  },
  "Orkesio": {
    "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": "event",
    "text": "Reunião de apresentação",
    "description": "Demonstração do produto",
    "start_at": "2026-10-17T15:00:00.000Z",
    "end_at": "2026-10-17T16:00:00.000Z",
    "location": {
      "name": "Escritório",
      "address": "Av. Paulista, 1000"
    },
    "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`](/webhook/message.sent)

```json
{
  "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": "event",
      "text": "Reunião de apresentação",
      "description": "Demonstração do produto",
      "start_at": "2026-10-17T15:00:00.000Z",
      "location": {
        "name": "Escritório",
        "address": "Av. Paulista, 1000"
      },
      "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`](/webhook/message.status)

```json
{
  "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"
      }
    ]
  }
}
```

## Quando o contato responde

### message.received

O contato respondeu **Vou** ao convite (`going`; também `not_going` e `maybe`). `event.id` é o convite. [O evento `message.received`](/webhook/message.received)

```json
{
  "id": "evt_01JAB3M2K8P4R6T8V0X2Z4B6D8",
  "type": "message.received",
  "created_at": "2026-10-17T12:03:00.000Z",
  "inbox": {
    "id": "r0269625d29bfbd",
    "name": "loja",
    "phone": "5511888888888",
    "channel": "whatsapp_web"
  },
  "data": {
    "message": {
      "id": "AC1FACA14F3FA7A19DB5FB19D7035506",
      "chat_id": "5511999999999@s.whatsapp.net",
      "author": {
        "id": "5511999999999@s.whatsapp.net",
        "phone": "5511999999999",
        "lid": "123456789012345@lid",
        "name": "Maria Souza"
      },
      "direction": "in",
      "sent_at": "2026-10-17T12:03:00.000Z",
      "category": "conversation",
      "type": "event_response",
      "event": {
        "id": "3EB05DCE1D4036FCE241C6"
      },
      "response": "going"
    },
    "chat": {
      "id": "5511999999999@s.whatsapp.net",
      "lid": "123456789012345@lid",
      "type": "direct"
    }
  }
}
```

