Send Sticker

​

Endpoint

POST /send/sticker

​

Headers

​

Request Body (multipart/form-data)

​

Response

​

Code Examples

curl -X POST http://localhost:3000/send/sticker \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "sticker=@/path/to/funny-emoji.png"

​

Response Example

{
  "code": "SUCCESS",
  "message": "Success",
  "results": {
    "message_id": "3EB0B430B6F8F1D0E053AC120E0A9E5C",
    "status": "Sticker sent successfully"
  }
}

​

Sticker Requirements

​

Image Format

• JPEG (.jpg, .jpeg)
• PNG (.png) - Supports transparency
• WebP (.webp) - Native WhatsApp format
• GIF (.gif) - Animated stickers

• All stickers are automatically converted to WebP format
• Static stickers: WebP (lossy or lossless)
• Animated stickers: Animated WebP

​

Dimensions

• Images are resized to 512x512 pixels
• Aspect ratio is maintained (with padding if needed)
• Transparent background is preserved for PNG
• White background added for non-transparent images

​

File Size

• Maximum file size: 100KB (after conversion)
• Recommended: Under 50KB for optimal performance
• Animated stickers: May be larger due to multiple frames

​

Design Guidelines

1. Transparency: PNG images with transparent backgrounds work best
2. Simple Designs: Clear, bold designs are more effective
3. Centered Subject: Keep the main subject centered
4. High Contrast: Ensure sticker stands out on any background
5. No Text: Minimize text; stickers should be universally understandable

​

Animated Stickers

curl -X POST http://localhost:3000/send/sticker \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "sticker=@/path/to/animated.gif"

• Format: GIF (will be converted to animated WebP)
• Dimensions: 512x512 pixels
• Frame Rate: Max 30 FPS
• Duration: Max 3 seconds
• File Size: Under 500KB (after conversion)

​

Use Cases

​

Express Emotions

curl -X POST http://localhost:3000/send/sticker \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "sticker=@stickers/emotions/happy.png"

​

Brand Communication

curl -X POST http://localhost:3000/send/sticker \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "sticker_url=https://cdn.brand.com/stickers/logo-celebration.png"

​

Automated Responses

# Thank you sticker for completed orders
curl -X POST http://localhost:3000/send/sticker \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "sticker=@responses/thank-you.png"

​

Interactive Messaging

curl -X POST http://localhost:3000/send/sticker \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "sticker=@stickers/interactive/thumbs-up.png"

​

Automatic Conversion Process

​

Static Stickers

1. Input: JPG/PNG/WebP image
2. Resize: Scale to 512x512 pixels
3. Convert: Transform to WebP format
4. Optimize: Compress to meet size requirements
5. Send: Upload to WhatsApp

​

Animated Stickers

1. Input: GIF file
2. Extract: Get all frames
3. Resize: Scale each frame to 512x512
4. Convert: Transform to animated WebP
5. Optimize: Reduce file size if needed
6. Send: Upload to WhatsApp

​

Best Practices

1. Use Transparent Backgrounds
   • PNG with transparency looks best
   • Integrates seamlessly into any chat theme
   • More professional appearance
2. Optimize Before Upload
   • Pre-resize images to 512x512 if possible
   • Reduce color palette for smaller file sizes
   • Remove unnecessary metadata
3. Create Sticker Packs
   • Organize related stickers
   • Maintain consistent style across pack
   • Use descriptive file naming
4. Test on Different Backgrounds
   • Ensure sticker is visible on light and dark themes
   • Check contrast and readability
   • Verify transparency works correctly
5. Animated Sticker Tips
   • Keep animations simple and short
   • Limit to 2-3 seconds maximum
   • Use fewer frames for smaller file size
   • Test animation speed on mobile devices
6. Cultural Sensitivity
   • Consider cultural meanings of gestures/symbols
   • Avoid potentially offensive content
   • Test with diverse audiences

​

Creating Custom Stickers

​

Design Tools

• Photoshop: Professional sticker creation
• GIMP: Free alternative to Photoshop
• Figma: Web-based design tool
• Inkscape: Vector graphics editor
• Canva: Simple online design tool

​

Design Checklist

• Image is 512x512 pixels
• Background is transparent (PNG)
• Subject is centered
• High contrast for visibility
• File size under 100KB
• No copyrighted content
• Tested on light and dark themes

​

Troubleshooting

​

Sticker Not Sending

1. Check file format is supported
2. Verify file size is under 100KB
3. Ensure image is not corrupted
4. Try with a simpler image first
5. Check device connection status

​

Conversion Fails

1. Verify image format is valid
2. Check image is not corrupted
3. Ensure image has valid dimensions
4. Try re-saving the image
5. Convert to PNG format before upload

​

Quality Issues

1. Use higher resolution source images
2. Avoid JPEG artifacts (use PNG)
3. Simplify complex designs
4. Reduce number of colors
5. Ensure proper transparency settings

​

Animated Sticker Issues

1. Reduce number of frames
2. Decrease animation duration
3. Simplify animation movements
4. Lower frame rate (15-20 FPS)
5. Optimize GIF before upload

​

Error Responses

​

Related Endpoints

• Send Image - Send regular images with captions
• Send Text - Send text messages
• Send Video - Send video messages
• React to Message - Add emoji reactions