Mensagem de Sticker

O tipo STICKER permite enviar figurinhas (adesivos) para o destinatário. Figurinhas são imagens que aparecem em tamanho maior na conversa, sem legenda.

Payload

{
  "channelId": "uuid-do-canal",
  "content": {
    "type": "STICKER",
    "to": {
      "type": "WHATSAPP",
      "number": "5511999999999"
    },
    "base64": "UklGRlYAAABXRUJQVlA4IE...",
    "filename": "figurinha.webp",
    "mimetype": "image/webp"
  }
}

Campos

string

required

Deve ser "STICKER".

Address

required

Endereço do destinatário. Veja formatos de endereço.

string

Conteúdo da figurinha codificado em Base64. Use este campo ou um dos campos de URL (downloadUrl / externalDownloadUrl).

string

URL pública para download da figurinha. Use este campo ou base64.

string

URL externa alternativa para download da figurinha. Assim como downloadUrl, dispensa o envio de base64.

string

Identificador de uma mídia já existente no storage da plataforma. Quando informado, dispensa base64 e as URLs de download.

string

URL de download no provedor de origem. Preenchido pela plataforma no recebimento; normalmente não é usado no envio.

string

required

Nome do arquivo da figurinha. Obrigatório para mensagens de mídia — a ausência retorna 400.

string

Tipo MIME da figurinha. Para WhatsApp, deve ser image/webp.

Para o WhatsApp, figurinhas devem estar no formato WebP. Imagens em outros formatos (PNG, JPEG) não serão exibidas corretamente como stickers. Além disso, as dimensões recomendadas são 512x512 pixels.

Requisitos para WhatsApp

Requisito	Valor
Formato	WebP (`.webp`)
Dimensões	512x512 pixels
Tamanho máximo	~100 KB (estático), ~500 KB (animado)
MIME Type	`image/webp`
Fundo	Transparente recomendado

Exemplos

Sticker via Base64

curl -X POST https://api-dev.messagefy.io/api/v1/message/SendMessage \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: sua-api-key-aqui" \
  -d '{
    "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": {
      "type": "STICKER",
      "to": {
        "type": "WHATSAPP",
        "number": "5511999999999"
      },
      "base64": "UklGRlYAAABXRUJQVlA4IEoAAADQAQCdASoI...",
      "filename": "saudacao.webp",
      "mimetype": "image/webp"
    }
  }'

import requests
import base64

with open("saudacao.webp", "rb") as f:
    sticker_base64 = base64.b64encode(f.read()).decode("utf-8")

response = requests.post(
    "https://api-dev.messagefy.io/api/v1/message/SendMessage",
    headers={
        "Content-Type": "application/json",
        "X-API-KEY": "sua-api-key-aqui"
    },
    json={
        "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "content": {
            "type": "STICKER",
            "to": {
                "type": "WHATSAPP",
                "number": "5511999999999"
            },
            "base64": sticker_base64,
            "filename": "saudacao.webp",
            "mimetype": "image/webp"
        }
    }
)
print(response.json())

import { readFileSync } from "fs";

const stickerBase64 = readFileSync("saudacao.webp").toString("base64");

const response = await fetch(
  "https://api-dev.messagefy.io/api/v1/message/SendMessage",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "X-API-KEY": "sua-api-key-aqui",
    },
    body: JSON.stringify({
      channelId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      content: {
        type: "STICKER",
        to: {
          type: "WHATSAPP",
          number: "5511999999999",
        },
        base64: stickerBase64,
        filename: "saudacao.webp",
        mimetype: "image/webp",
      },
    }),
  }
);
const data = await response.json();
console.log(data);

Sticker via URL

{
  "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "content": {
    "type": "STICKER",
    "to": {
      "type": "WHATSAPP",
      "number": "5511999999999"
    },
    "downloadUrl": "https://cdn.suaempresa.com/stickers/obrigado.webp",
    "filename": "obrigado.webp",
    "mimetype": "image/webp"
  }
}

Você pode converter imagens PNG/JPEG para WebP usando ferramentas como cwebp (do Google) ou bibliotecas como sharp (Node.js) e Pillow (Python). Exemplo com cwebp: cwebp -resize 512 512 imagem.png -o sticker.webp

Resposta

{
  "packageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Stickers não suportam caption (legenda). Mesmo que o campo exista no payload, ele será ignorado pelo provedor WhatsApp para este tipo de mensagem.

Recebimento

Quando um contato envia uma figurinha para o seu canal, a plataforma entrega um webhook com content.type igual a STICKER. Veja Recebendo Eventos para os detalhes do envelope e da assinatura.

content (STICKER recebido)

string

Sempre "STICKER".

Address

Endereço de quem enviou a figurinha. Para WhatsApp: type, jid, lid, number, name.

Address

Endereço de destino (o seu canal ou o grupo/chat).

string

Identificador da mensagem no provedor.

string

Identificador da mídia no storage da plataforma. Use-o para obter o binário da figurinha.

string

URL para download da figurinha.

string

URL de download diretamente no provedor de origem.

string

URL externa para download da figurinha (ex.: link pré-assinado do storage).

string

Nome do arquivo da figurinha.

string

Tipo MIME da figurinha (normalmente image/webp).

boolean

true quando a figurinha foi enviada pelo próprio canal.

boolean

true quando a figurinha foi recebida em um grupo.

boolean

true quando a figurinha foi encaminhada.

boolean

true quando a figurinha faz parte de um status (story).

boolean

true quando a figurinha veio da sincronização de histórico.

boolean

true se a mensagem foi enviada para uma lista de transmissão (broadcast list).

boolean

true se a mensagem foi enviada para um grupo de avisos da comunidade.

boolean

true se a mensagem foi enviada para o grupo de avisos da comunidade.

true se a mensagem foi enviada para um canal/newsletter.

object

Mensagem citada (quando a figurinha responde a outra mensagem). Contém messageId, participant, body, type, thumbnail e isStatusReply.

string

Data e hora da mensagem no content.

A plataforma não envia um campo downloadHash. O binário da figurinha é obtido pelos campos mediaId, downloadUrl ou externalDownloadUrl.

Exemplo de webhook

{
  "packageId": "019a1234-5678-7abc-def0-123456789abc",
  "channelId": "019a1258-177c-7286-b060-9ee02a0800c7",
  "correlationId": null,
  "content": {
    "type": "STICKER",
    "mediaId": "b7f0d2c1-4a9e-4c3a-9f21-8d5e6a1b2c3d",
    "downloadUrl": "https://storage.messagefy.io/media/b7f0d2c1.webp",
    "externalDownloadUrl": "https://storage.messagefy.io/media/b7f0d2c1.webp?X-Amz-Signature=...",
    "filename": "sticker.webp",
    "mimetype": "image/webp",
    "from": {
      "type": "WHATSAPP",
      "jid": "5511999998888@s.whatsapp.net",
      "number": "5511999998888",
      "name": "Cliente"
    },
    "to": {
      "type": "WHATSAPP",
      "jid": "5511988887777@s.whatsapp.net",
      "number": "5511988887777",
      "name": "Minha Empresa"
    },
    "messageId": "3EB08209536937A66D8435",
    "isFromMe": false,
    "isGroupMessage": false,
    "isForwarded": false,
    "isStatusMessage": false,
    "isHistoryMessage": false,
    "quotedMessage": null,
    "timestamp": "2025-12-01T14:36:00+00:00"
  },
  "timestamp": "2025-12-01T14:36:00.100+00:00",
  "providerMetadata": null,
  "echoMessage": null
}

Início

Contas

API Keys

Canais

WhatsApp Oficial

Tipos de Mensagem

Operações de Mensagem

Sessão e Conexão

Consultas

Interação

Mensagem de Sticker

Mensagem de Sticker

Payload

Campos

Requisitos para WhatsApp

Exemplos

Sticker via Base64

Sticker via URL

Resposta

Recebimento

content (STICKER recebido)

Exemplo de webhook

​Mensagem de Sticker

​Payload

​Campos

​Requisitos para WhatsApp

​Exemplos

​Sticker via Base64

​Sticker via URL

​Resposta

​Recebimento

​content (STICKER recebido)

​Exemplo de webhook

Mensagem de Sticker

Payload

Campos

Requisitos para WhatsApp

Exemplos

Sticker via Base64

Sticker via URL

Resposta

Recebimento

content (STICKER recebido)

Exemplo de webhook