Enviar Sticker

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

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    number: '<string>',
    imageUrl: '<string>',
    delay: 123,
    replyTo: '<string>',
    replyPrivate: true,
    source: '<string>'
  })
};

fetch('https://api.example.com/api/message/sticker/: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/sticker/:instance"

payload = {
    "number": "<string>",
    "imageUrl": "<string>",
    "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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: não

Descrição

Envia uma figurinha (sticker) a partir de uma imageUrl. O servidor faz o download da imagem (PNG, JPEG ou GIF) e converte automaticamente para o formato esperado pelo WhatsApp: WebP, 512×512, com fundo preservado quando aplicável. Suporta replyTo, replyPrivate, delay (em segundos) e source para rastreabilidade.

Exemplos

Mínimo (URL pública)

Envia uma figurinha apontando apenas para uma URL pública de imagem (PNG/JPEG/GIF). O servidor faz o download e converte automaticamente para 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://exemplo.com/figurinha.png"
  }'

await fetch(`https://ryzeapi.cloud/api/message/sticker/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:   "5511999999999",
    imageUrl: "https://exemplo.com/figurinha.png"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/sticker/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":   "5511999999999",
        "imageUrl": "https://exemplo.com/figurinha.png"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number":   "5511999999999",
        "imageUrl": "https://exemplo.com/figurinha.png"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/sticker/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

A partir de base64 (data URL)

imageUrl aceita data: URL com base64 inline. O servidor decodifica e segue o mesmo fluxo de conversão para 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..."
  }'

await fetch(`https://ryzeapi.cloud/api/message/sticker/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:   "5511999999999",
    imageUrl: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/sticker/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":   "5511999999999",
        "imageUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number":   "5511999999999",
        "imageUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/sticker/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Como resposta a uma mensagem

Envia a figurinha citando uma mensagem anterior via replyTo. Combinação típica para reações visuais (“reaction stickers”) em resposta direta a algo dito antes na conversa.

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://exemplo.com/reaction.png",
    "replyTo":  "3EB08FCF27E532F1B0F5"
  }'

await fetch(`https://ryzeapi.cloud/api/message/sticker/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:   "5511999999999",
    imageUrl: "https://exemplo.com/reaction.png",
    replyTo:  "3EB08FCF27E532F1B0F5"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/sticker/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":   "5511999999999",
        "imageUrl": "https://exemplo.com/reaction.png",
        "replyTo":  "3EB08FCF27E532F1B0F5"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number":   "5511999999999",
        "imageUrl": "https://exemplo.com/reaction.png",
        "replyTo":  "3EB08FCF27E532F1B0F5"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/sticker/"+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

O messageType é sempre sticker e o mediaMimeType fixo em image/webp (a imagem original foi convertida pelo servidor). Não há content no payload, stickers não carregam legenda.

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 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 (@s.whatsapp.net, @lid, @g.us, @newsletter).

string

obrigatório

URL pública da imagem (PNG, JPEG ou GIF) ou data: URL com base64 inline. O servidor faz o download/decode e converte automaticamente para WebP 512×512.

int

padrão:"0"

Tempo em segundos para aguardar antes de enviar. Durante o intervalo, o servidor envia o indicador de “digitando…” ao destinatário e dispara o “paused” antes do envio real.

string

ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.

boolean

padrão:"false"

Quando true e replyTo aponta para uma mensagem originária de um grupo, a resposta é redirecionada para o privado do autor original (mantendo a citação). Ignorado se a mensagem original não for de grupo.

string

padrão:"api"

Identificador de origem para rastreabilidade (ex.: crm, bot-suporte, n8n). Salvo no registro da mensagem no banco e propagado para webhooks. Quando omitido, assume "api".

Notas

delay é em segundos, não milissegundos.
O servidor converte automaticamente PNG/JPEG/GIF para WebP 512×512 antes do envio. Não é necessário enviar um WebP pré-formatado.
GIFs animados são aceitos, mas a animação pode ser preservada apenas parcialmente dependendo do encoder; para stickers animados confiáveis, envie um WebP animado já no formato correto via imageUrl.
Stickers não suportam menções nem mentionAll (limitação do WhatsApp para mensagens do tipo sticker).
A imageUrl precisa ser publicamente acessível, ou ser um data: URL base64.
Para números BR (começando com 55), o serviço tenta automaticamente variações com e sem o 9º dígito.

Erros

HTTP	Status interno	Mensagem
400	,	`Instance name is required`
400	,	`Invalid request body: <detalhe>`
400	,	`Number is required`
400	,	`ImageURL is required`
400	`invalid_number`	`Invalid phone number format: <detalhe>`
400	`image_download_failed`	`Failed to download image: <reason>`
500	`image_conversion_failed`	`Failed to convert image to sticker (WebP 512x512)`
500	`sticker_upload_failed`	`Failed to upload sticker to WhatsApp servers`
500	`send_failed`	`Failed to send message: <reason>`
404	,	`Instance not found`
503	`disconnected`	`Instance is not connected to WhatsApp`

Envelope de erro:

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

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

Mínimo (URL pública)

A partir de base64 (data URL)

Como resposta a uma mensagem

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

​Descrição

​Exemplos

​Mínimo (URL pública)

​A partir de base64 (data URL)

​Como resposta a uma mensagem

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Notas

​Erros

Descrição

Exemplos

Mínimo (URL pública)

A partir de base64 (data URL)

Como resposta a uma mensagem

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros