Agendar Chamada

POST

api

call

schedule

:instance

Agendar Chamada

curl --request POST \
  --url https://api.example.com/api/call/schedule/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "name": "<string>",
  "startTime": 123,
  "description": "<string>",
  "endTime": 123,
  "video": true,
  "reminderOffsetSec": 123
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    number: '<string>',
    name: '<string>',
    startTime: 123,
    description: '<string>',
    endTime: 123,
    video: true,
    reminderOffsetSec: 123
  })
};

fetch('https://api.example.com/api/call/schedule/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/call/schedule/:instance"

payload = {
    "number": "<string>",
    "name": "<string>",
    "startTime": 123,
    "description": "<string>",
    "endTime": 123,
    "video": True,
    "reminderOffsetSec": 123
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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.

startTime (e endTime, quando informado) usam timestamp Unix em segundos, não em milissegundos, e startTime precisa estar no futuro.

Exemplos

Agendamento simples

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
  }'

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
  })
});

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
    }
)

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)
}

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.

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
  }'

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
  })
});

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
    }
)

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)
}

Resposta de sucesso

200 OK

{
  "success":   true,
  "messageId": "3EB08FCF27E532F1D3D3",
  "token":     "AbCdEfGhIjKlMnOp",
  "url":       "https://call.whatsapp.com/audio/AbCdEfGhIjKlMnOp",
  "startTime": 1751500000
}

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.

Parâmetros de rota

string

obrigatório

Nome da instância (ex.: $Instance_Name).

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

string

obrigatório

Destino: telefone (5511999999999) ou JID (5511999999999@s.whatsapp.net).

string

obrigatório

Título do evento, exibido no cartão da chamada agendada.

integer

obrigatório

Data e hora de início da chamada, em timestamp Unix (segundos). Precisa estar no futuro.

string

Descrição ou pauta do evento.

integer

padrão:"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.

boolean

padrão:"false"

Quando true, gera um link de chamada de vídeo em vez de áudio.

integer

Quantos segundos antes do início um lembrete deve ser exibido ao destinatário.

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:

{
  "success": false,
  "error": { "message": "startTime must be in the future (Unix seconds)" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Agendar Chamada

Descrição

Exemplos

Agendamento simples

Com descrição, término e lembrete

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Erros

​Descrição

​Exemplos

​Agendamento simples

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

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Erros

Descrição

Exemplos

Agendamento simples

Com descrição, término e lembrete

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Erros