Saltar al contenido principal
POST
/
api
/
message
/
sticker
/
:instance
Enviar sticker
curl --request POST \
  --url https://api.example.com/api/message/sticker/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "imageUrl": "<string>",
  "delay": 123,
  "replyTo": "<string>",
  "replyPrivate": true,
  "source": "<string>"
}
'

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.

Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: no

​
Descripción

Envía un sticker (sticker) a partir de una imageUrl. El servidor descarga la imagen (PNG, JPEG o GIF) y la convierte automáticamente al formato esperado por WhatsApp: WebP, 512×512, con el fondo preservado cuando aplica. Soporta replyTo, replyPrivate, delay (en segundos) y source para trazabilidad.

​
Ejemplos

​
Mínimo (URL pública)

Envía un sticker apuntando solo a una URL pública de imagen (PNG/JPEG/GIF). El servidor la descarga y convierte automáticamente a WebP 512×512 antes de entregar. 
curl -X POST "https://ryzeapi.cloud/api/message/sticker/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "imageUrl": "https://example.com/sticker.png"
  }'

​
Desde base64 (data URL)

imageUrl acepta una URL data: con base64 inline. El servidor la decodifica y sigue el mismo flujo de conversión a WebP 512×512. 
curl -X POST "https://ryzeapi.cloud/api/message/sticker/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "imageUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  }'

​
Como respuesta a un mensaje

Envía el sticker citando un mensaje anterior vía replyTo. Combinación típica para reacciones visuales (“reaction stickers”) en respuesta directa a algo dicho antes en la conversación. 
curl -X POST "https://ryzeapi.cloud/api/message/sticker/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "imageUrl": "https://example.com/reaction.png",
    "replyTo":  "3EB08FCF27E532F1B0F5"
  }'

​
Respuesta exitosa

El messageType siempre es sticker y mediaMimeType es fijo en image/webp (la imagen original fue convertida por el servidor). No hay content en el payload, los stickers no transportan subtítulo.
200 OK
{
  "success": true,
  "message": "Sticker sent successfully",
  "status":  "sent",
  "data": {
    "messageId":     "3EB08FCF27E532F1B0F5",
    "direction":     "sent",
    "messageType":   "sticker",
    "source":        "api",
    "timestamp":     "2026-04-30T14:30:00Z",
    "chat": {
      "jid":     "5511999999999@s.whatsapp.net",
      "isGroup": false
    },
    "sender": {
      "jid":      "5511777777777@s.whatsapp.net",
      "instance": "minha-instancia"
    }
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia (p. ej., $Instance_Name).

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.
​
Content-Type
string
requerido
application/json

​
Cuerpo de la solicitud

​
number
string
requerido
Destino: teléfono (5511999999999) o JID (@s.whatsapp.net, @lid, @g.us, @newsletter).
​
imageUrl
string
requerido
URL pública de la imagen (PNG, JPEG o GIF) o una URL data: con base64 inline. El servidor la descarga/decodifica y convierte automáticamente a WebP 512×512.
​
delay
int
predeterminado:"0"
Tiempo en segundos a esperar antes de enviar. Durante el intervalo, el servidor envía el indicador “escribiendo…” al destinatario y dispara “pausado” antes del envío real.
​
replyTo
string
ID del mensaje a citar (respuesta). El mensaje original debe pertenecer a la misma instancia y haber sido guardado en la base de datos.
​
replyPrivate
boolean
predeterminado:"false"
Cuando es true y replyTo apunta a un mensaje originado en un grupo, la respuesta se redirige al chat privado del autor original (manteniendo la cita). Ignorado si el mensaje original no es de un grupo.
​
source
string
predeterminado:"api"
Identificador de origen para trazabilidad (p. ej., crm, bot-suporte, n8n). Guardado en el registro del mensaje en la base de datos y propagado a los webhooks. Cuando se omite, el default es "api".

​
Notas

  • delay es en segundos, no milisegundos.
  • El servidor convierte automáticamente PNG/JPEG/GIF a WebP 512×512 antes de enviar. No es necesario enviar un WebP preformateado.
  • Los GIF animados son aceptados, pero la animación puede preservarse solo parcialmente dependiendo del encoder; para stickers animados confiables, envía un WebP animado ya en el formato correcto vía imageUrl.
  • Los stickers no soportan menciones ni mentionAll (limitación de WhatsApp para mensajes de tipo sticker).
  • La imageUrl debe ser accesible públicamente, o una URL data: en base64.
  • Para números BR (que comienzan con 55), el servicio prueba automáticamente variaciones con y sin el 9° dígito.

​
Errores

HTTPStatus internoMensaje
400—Instance name is required
400—Invalid request body: <detail>
400—Number is required
400—ImageURL is required
400invalid_numberInvalid phone number format: <detail>
400image_download_failedFailed to download image: <reason>
500image_conversion_failedFailed to convert image to sticker (WebP 512x512)
500sticker_upload_failedFailed to upload sticker to WhatsApp servers
500send_failedFailed to send message: <reason>
404—Instance not found
503disconnectedInstance is not connected to WhatsApp
Envoltorio de error: 
{
  "success": false,
  "error": { "message": "ImageURL is required" }
}