Enviar evento

POST

api

message

event

:instance

Enviar evento

curl --request POST \
  --url https://api.example.com/api/message/event/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "name": "<string>",
  "startAt": "<string>",
  "endAt": "<string>",
  "description": "<string>",
  "location": {},
  "joinLink": "<string>",
  "isScheduleCall": true,
  "hasReminder": true,
  "reminderOffsetSec": 123,
  "extraGuestsAllowed": true,
  "isCanceled": true,
  "delay": 123,
  "replyTo": "<string>",
  "replyPrivate": true,
  "source": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    number: '<string>',
    name: '<string>',
    startAt: '<string>',
    endAt: '<string>',
    description: '<string>',
    location: {},
    joinLink: '<string>',
    isScheduleCall: true,
    hasReminder: true,
    reminderOffsetSec: 123,
    extraGuestsAllowed: true,
    isCanceled: true,
    delay: 123,
    replyTo: '<string>',
    replyPrivate: true,
    source: '<string>'
  })
};

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

import requests

url = "https://api.example.com/api/message/event/:instance"

payload = {
    "number": "<string>",
    "name": "<string>",
    "startAt": "<string>",
    "endAt": "<string>",
    "description": "<string>",
    "location": {},
    "joinLink": "<string>",
    "isScheduleCall": True,
    "hasReminder": True,
    "reminderOffsetSec": 123,
    "extraGuestsAllowed": True,
    "isCanceled": True,
    "delay": 123,
    "replyTo": "<string>",
    "replyPrivate": True,
    "source": "<string>"
}
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

Envía un mensaje de evento (tarjeta de reunión/agenda) a un contacto 1-a-1 o, más comúnmente, a un grupo (@g.us). Los campos startAt y endAt aceptan fechas en formato ISO 8601 (RFC3339) con zona horaria (p. ej., 2026-04-28T14:00:00-03:00) y se convierten a Unix (segundos) internamente. El evento puede incluir opcionalmente description, location, joinLink, un recordatorio (hasReminder + reminderOffsetSec) y flags como isScheduleCall y extraGuestsAllowed. Soporta delay, replyTo y replyPrivate.

Ejemplos

Reunión con ubicación y recordatorio

Crea un evento en un grupo con inicio y fin, una ubicación y un recordatorio 15 minutos antes (reminderOffsetSec: 900).

curl -X POST "https://ryzeapi.cloud/api/message/event/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":      "120363312345678901@g.us",
    "name":        "Reunión del equipo",
    "description": "Planificación del trimestre",
    "startAt":     "2026-04-28T14:00:00-03:00",
    "endAt":       "2026-04-28T16:00:00-03:00",
    "location":    { "name": "Sala 3, Sede", "address": "Av. Paulista, 1000" },
    "hasReminder":       true,
    "reminderOffsetSec": 900
  }'

await fetch(`https://ryzeapi.cloud/api/message/event/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:      "120363312345678901@g.us",
    name:        "Reunión del equipo",
    description: "Planificación del trimestre",
    startAt:     "2026-04-28T14:00:00-03:00",
    endAt:       "2026-04-28T16:00:00-03:00",
    location:    { name: "Sala 3, Sede", address: "Av. Paulista, 1000" },
    hasReminder:       true,
    reminderOffsetSec: 900
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/event/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":      "120363312345678901@g.us",
        "name":        "Reunión del equipo",
        "description": "Planificación del trimestre",
        "startAt":     "2026-04-28T14:00:00-03:00",
        "endAt":       "2026-04-28T16:00:00-03:00",
        "location":    {"name": "Sala 3, Sede", "address": "Av. Paulista, 1000"},
        "hasReminder":       True,
        "reminderOffsetSec": 900
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number":      "120363312345678901@g.us",
        "name":        "Reunión del equipo",
        "description": "Planificación del trimestre",
        "startAt":     "2026-04-28T14:00:00-03:00",
        "endAt":       "2026-04-28T16:00:00-03:00",
        "location":    { "name": "Sala 3, Sede", "address": "Av. Paulista, 1000" },
        "hasReminder":       true,
        "reminderOffsetSec": 900
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/event/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Llamada programada con enlace

isScheduleCall: true marca el evento como una llamada y joinLink proporciona el enlace para unirse.

curl -X POST "https://ryzeapi.cloud/api/message/event/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":         "120363312345678901@g.us",
    "name":           "Daily del equipo",
    "startAt":        "2026-05-04T09:00:00-03:00",
    "isScheduleCall": true,
    "joinLink":       "https://meet.example.com/daily"
  }'

await fetch(`https://ryzeapi.cloud/api/message/event/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:         "120363312345678901@g.us",
    name:           "Daily del equipo",
    startAt:        "2026-05-04T09:00:00-03:00",
    isScheduleCall: true,
    joinLink:       "https://meet.example.com/daily"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/event/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":         "120363312345678901@g.us",
        "name":           "Daily del equipo",
        "startAt":        "2026-05-04T09:00:00-03:00",
        "isScheduleCall": True,
        "joinLink":       "https://meet.example.com/daily"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number":         "120363312345678901@g.us",
        "name":           "Daily del equipo",
        "startAt":        "2026-05-04T09:00:00-03:00",
        "isScheduleCall": true,
        "joinLink":       "https://meet.example.com/daily"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/event/"+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

El content retornado es el nombre del evento, usado para indexar el mensaje en el historial. Guarda el messageId para correlacionar respuestas (going/not-going) recibidas vía webhook.

200 OK

{
  "success": true,
  "message": "Event sent successfully",
  "status":  "sent",
  "data": {
    "messageId":   "3EB08FCF27E532F1D3D3",
    "direction":   "sent",
    "messageType": "event",
    "content":     "Reunión del equipo",
    "source":      "api",
    "timestamp":   "2026-04-28T14:30:00Z",
    "chat": {
      "jid":     "120363312345678901@g.us",
      "isGroup": true
    },
    "sender": {
      "jid":      "5511777777777@s.whatsapp.net",
      "instance": "mi-instancia"
    }
  }
}

Las confirmaciones de asistencia de los participantes no llegan sincrónicamente en esta respuesta, fluyen como eventos en el webhook/WebSocket configurado, referenciando el messageId del evento.

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. Los eventos funcionan mejor en grupos (@g.us).

string

requerido

Título del evento mostrado en la tarjeta.

string

requerido

Fecha/hora de inicio en formato ISO 8601 (RFC3339) con zona horaria, p. ej., 2026-04-28T14:00:00-03:00.

string

Fecha/hora de fin en formato ISO 8601 (RFC3339). Opcional.

string

Descripción/detalles del evento.

object

Ubicación del evento. Campos: name, address, latitude, longitude (todos opcionales).

string

Enlace para unirse (usado en llamadas programadas).

boolean

predeterminado:"false"

Marca el evento como una llamada programada.

boolean

predeterminado:"false"

Habilita un recordatorio para el evento.

int

predeterminado:"0"

Antelación del recordatorio, en segundos antes de startAt (p. ej., 900 = 15 min).

boolean

predeterminado:"false"

Permite que los invitados traigan acompañantes.

boolean

predeterminado:"false"

Marca el evento como cancelado.

int

predeterminado:"0"

Tiempo en segundos a esperar antes de enviar. Durante el intervalo, el servidor muestra el indicador “escribiendo…” al destinatario y dispara “pausado” antes del envío real.

string

ID del mensaje a responder. El mensaje original debe pertenecer a la misma instancia y estar guardado en la base de datos.

boolean

predeterminado:"false"

Cuando es true y replyTo apunta a un mensaje originado en un grupo, el evento se redirige al chat privado del autor original (manteniendo la cita).

string

predeterminado:"api"

Identificador de origen para trazabilidad (p. ej., crm, support-bot, n8n). Guardado en el registro del mensaje y propagado a los webhooks.

Notas

startAt/endAt son ISO 8601 (RFC3339) con zona horaria; el servidor los convierte a Unix (segundos).
delay es en segundos (no milisegundos); reminderOffsetSec también es en segundos.
Los eventos se muestran mejor en grupos (@g.us).
Las confirmaciones no regresan en esta llamada, suscríbete a eventos de webhook/WebSocket para recibirlas referenciando el messageId.

Errores

HTTP	Status interno	Mensaje
400	,	`Instance name is required`
400	,	`Invalid request body: <detail>`
400	,	`Number is required`
400	,	`Name is required`
400	,	`startAt is required`
400	`invalid_request`	`Invalid startAt, expected ISO 8601 (RFC3339): <detail>`
400	`invalid_number`	`Invalid phone number format: <detail>`
404	,	`Instance not found`
500	`send_failed`	`Failed to send event: <reason>`
503	`disconnected`	`Instance is not connected to WhatsApp`

Envoltorio de error:

{
  "success": false,
  "error": { "message": "startAt is required" }
}

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplos

Reunión con ubicación y recordatorio

Llamada programada con enlace

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

​Descripción

​Ejemplos

​Reunión con ubicación y recordatorio

​Llamada programada con enlace

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Errores

Descripción

Ejemplos

Reunión con ubicación y recordatorio

Llamada programada con enlace

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores