Pular para o conteúdo 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 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"
  }'

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

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

​
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

​
instance
string
obrigatório
Nome da instância (ex.: $Instance_Name).

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

​
number
string
obrigatório
Destino: telefone (5511999999999) ou JID (@s.whatsapp.net, @lid, @g.us, @newsletter).
​
imageUrl
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.
​
delay
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.
​
replyTo
string
ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.
​
replyPrivate
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.
​
source
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

HTTPStatus internoMensagem
400—Instance name is required
400—Invalid request body: <detalhe>
400—Number is required
400—ImageURL is required
400invalid_numberInvalid phone number format: <detalhe>
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
Envelope de erro: 
{
  "success": false,
  "error": { "message": "ImageURL is required" }
}