> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Agendar Chamada

> Agenda uma chamada, criando um link e enviando um cartão de evento com o link, o título e o horário de início

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** não

## Descrição

Agenda uma **chamada de WhatsApp** para o futuro. Cria um link de chamada e envia, no chat do número informado, um cartão de evento de chamada agendada contendo esse link, o título (`name`) e o horário de início (`startTime`). O destinatário vê o cartão do evento e pode abrir o link para entrar quando chegar a hora. Use o campo `video` para escolher entre um link de áudio (padrão) ou de vídeo.

<Note>
  `startTime` (e `endTime`, quando informado) usam **timestamp Unix em segundos**, não em milissegundos, e `startTime` precisa estar no futuro.
</Note>

## Exemplos

### Agendamento simples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/call/schedule/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number": "5511999999999",
      "name": "Reunião de equipe",
      "startTime": 1751500000
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/call/schedule/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number: "5511999999999",
      name: "Reunião de equipe",
      startTime: 1751500000
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/call/schedule/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number": "5511999999999",
          "name": "Reunião de equipe",
          "startTime": 1751500000
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number": "5511999999999",
          "name": "Reunião de equipe",
          "startTime": 1751500000
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/call/schedule/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Com descrição, término e lembrete

`description` adiciona uma pauta ao evento, `endTime` marca o horário de término e `reminderOffsetSec` define quantos segundos antes do início um lembrete é exibido ao destinatário.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/call/schedule/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number": "5511999999999",
      "name": "Reunião de equipe",
      "description": "Alinhamento semanal do time",
      "startTime": 1751500000,
      "endTime": 1751503600,
      "video": true,
      "reminderOffsetSec": 900
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/call/schedule/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number: "5511999999999",
      name: "Reunião de equipe",
      description: "Alinhamento semanal do time",
      startTime: 1751500000,
      endTime: 1751503600,
      video: true,
      reminderOffsetSec: 900
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/call/schedule/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number": "5511999999999",
          "name": "Reunião de equipe",
          "description": "Alinhamento semanal do time",
          "startTime": 1751500000,
          "endTime": 1751503600,
          "video": True,
          "reminderOffsetSec": 900
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number": "5511999999999",
          "name": "Reunião de equipe",
          "description": "Alinhamento semanal do time",
          "startTime": 1751500000,
          "endTime": 1751503600,
          "video": true,
          "reminderOffsetSec": 900
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/call/schedule/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

```json 200 OK theme={null}
{
  "success":   true,
  "messageId": "3EB08FCF27E532F1D3D3",
  "token":     "AbCdEfGhIjKlMnOp",
  "url":       "https://call.whatsapp.com/audio/AbCdEfGhIjKlMnOp",
  "startTime": 1751500000
}
```

<Note>
  `messageId` identifica a mensagem de evento enviada ao destinatário. `token` e `url` são do link de chamada já criado, útil caso seja necessário reenviá-lo manualmente. `startTime` confirma o horário de início registrado.
</Note>

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `$Instance_Name`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="number" type="string" required>
  Destino: telefone (`5511999999999`) ou JID (`5511999999999@s.whatsapp.net`).
</ParamField>

<ParamField body="name" type="string" required>
  Título do evento, exibido no cartão da chamada agendada.
</ParamField>

<ParamField body="startTime" type="integer" required>
  Data e hora de início da chamada, em **timestamp Unix (segundos)**. Precisa estar no futuro.
</ParamField>

<ParamField body="description" type="string">
  Descrição ou pauta do evento.
</ParamField>

<ParamField body="endTime" type="integer" default="0">
  Data e hora de término, em **timestamp Unix (segundos)**. Omitido ou `0` indica que não há término definido. Quando informado, precisa ser maior que `startTime`.
</ParamField>

<ParamField body="video" type="boolean" default="false">
  Quando `true`, gera um link de chamada de **vídeo** em vez de áudio.
</ParamField>

<ParamField body="reminderOffsetSec" type="integer">
  Quantos segundos antes do início um lembrete deve ser exibido ao destinatário.
</ParamField>

## Erros

| HTTP | Mensagem                                         |
| ---- | ------------------------------------------------ |
| 400  | `Instance name is required`                      |
| 400  | `Invalid request body: <detalhe>`                |
| 400  | `Number is required`                             |
| 400  | `startTime must be in the future (Unix seconds)` |
| 400  | `endTime must be after startTime`                |
| 404  | `instance not found`                             |
| 500  | `<motivo da falha>`                              |

Envelope de erro:

```json theme={null}
{
  "success": false,
  "error": { "message": "startTime must be in the future (Unix seconds)" }
}
```