Programar Llamada

POST

api

call

schedule

:instance

Programar Llamada

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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: no

Descripción

Programa una llamada de WhatsApp para el futuro. Crea un enlace de llamada y envía, en el chat del número indicado, una tarjeta de evento de llamada programada que contiene ese enlace, el título (name) y la hora de inicio (startTime). El destinatario ve la tarjeta del evento y puede abrir el enlace para unirse cuando llegue la hora. Usa el campo video para elegir entre un enlace de audio (por defecto) o de video.

startTime (y endTime, cuando se indica) usan timestamp Unix en segundos, no en milisegundos, y startTime debe estar en el futuro.

Ejemplos

Programación simple

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ón de equipo",
    "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ón de equipo",
    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ón de equipo",
        "startTime": 1751500000
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "name": "Reunión de equipo",
        "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)
}

Con descripción, término y recordatorio

description agrega una agenda al evento, endTime marca la hora de término y reminderOffsetSec define cuántos segundos antes del inicio se muestra un recordatorio al destinatario.

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ón de equipo",
    "description": "Alineación semanal del equipo",
    "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ón de equipo",
    description: "Alineación semanal del equipo",
    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ón de equipo",
        "description": "Alineación semanal del equipo",
        "startTime": 1751500000,
        "endTime": 1751503600,
        "video": True,
        "reminderOffsetSec": 900
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "name": "Reunión de equipo",
        "description": "Alineación semanal del equipo",
        "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)
}

Respuesta exitosa

200 OK

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

messageId identifica el mensaje de evento enviado al destinatario. token y url corresponden al enlace de llamada ya creado, útil si es necesario reenviarlo manualmente. startTime confirma la hora de inicio registrada.

Parámetros de ruta

string

requerido

Nombre de la instancia (p. ej., $Instance_Name).

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json

Cuerpo de la solicitud

string

requerido

Destino: teléfono (5511999999999) o JID (5511999999999@s.whatsapp.net).

string

requerido

Título del evento, mostrado en la tarjeta de la llamada programada.

integer

requerido

Fecha y hora de inicio de la llamada, como timestamp Unix (segundos). Debe estar en el futuro.

string

Descripción o agenda del evento.

integer

predeterminado:"0"

Fecha y hora de término, como timestamp Unix (segundos). Omitido o 0 indica que no hay término definido. Cuando se indica, debe ser mayor que startTime.

boolean

predeterminado:"false"

Cuando es true, genera un enlace de llamada de video en lugar de audio.

integer

Cuántos segundos antes del inicio se debe mostrar un recordatorio al destinatario.

Errores

HTTP	Mensaje
400	`Instance name is required`
400	`Invalid request body: <detail>`
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 del fallo>`

Envoltorio de error:

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Programar Llamada

Descripción

Ejemplos

Programación simple

Con descripción, término y recordatorio

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Errores

​Descripción

​Ejemplos

​Programación simple

​Con descripción, término y recordatorio

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Errores

Descripción

Ejemplos

Programación simple

Con descripción, término y recordatorio

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Errores