Send Link

​

Endpoint

POST /send/link

​

Headers

​

Request Body

​

Response

​

Code Examples

curl -X POST http://localhost:3000/send/link \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{
    "phone": "[email protected]",
    "link": "https://google.com"
  }'

​

Response Example

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

​

Link Preview Generation

​

What Gets Displayed

1. Page Title: From <title> or og:title meta tag
2. Description: From og:description or meta description
3. Thumbnail Image: From og:image meta tag
4. Site Name: From og:site_name meta tag
5. URL: The actual link URL

​

Preview Generation Process

1. API sends link to WhatsApp
2. WhatsApp fetches the page metadata
3. Preview card is generated automatically
4. Message displays with rich preview

​

Use Cases

​

Content Sharing

curl -X POST http://localhost:3000/send/link \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{
    "phone": "[email protected]",
    "link": "https://blog.example.com/latest-post",
    "caption": "Our latest blog post is live! 🚀"
  }'

​

E-Commerce

curl -X POST http://localhost:3000/send/link \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{
    "phone": "[email protected]",
    "link": "https://shop.example.com/summer-collection",
    "caption": "Summer Sale! Up to 50% off ☀️🛍️"
  }'

​

Event Promotion

curl -X POST http://localhost:3000/send/link \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{
    "phone": "[email protected]",
    "link": "https://events.example.com/annual-conference",
    "caption": "Registration now open! Early bird pricing ends soon 🎫"
  }'

​

Documentation & Resources

curl -X POST http://localhost:3000/send/link \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{
    "phone": "[email protected]",
    "link": "https://docs.example.com/getting-started",
    "caption": "Getting Started Guide 📚"
  }'

​

Video Content

curl -X POST http://localhost:3000/send/link \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{
    "phone": "[email protected]",
    "link": "https://www.youtube.com/watch?v=example",
    "caption": "Tutorial: How to use our API 🎥"
  }'

​

Social Media

curl -X POST http://localhost:3000/send/link \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{
    "phone": "[email protected]",
    "link": "https://twitter.com/example/status/123456",
    "caption": "Check out our latest announcement on Twitter!"
  }'

​

Optimizing Link Previews

​

Essential Meta Tags

<!-- Page Title -->
<meta property="og:title" content="Your Page Title" />

<!-- Description -->
<meta property="og:description" content="A compelling description of your page" />

<!-- Image -->
<meta property="og:image" content="https://example.com/image.jpg" />

<!-- URL -->
<meta property="og:url" content="https://example.com/page" />

<!-- Site Name -->
<meta property="og:site_name" content="Your Site Name" />

<!-- Type -->
<meta property="og:type" content="website" />

​

Image Recommendations

• Minimum: 200x200 pixels
• Recommended: 1200x630 pixels (Facebook/WhatsApp standard)
• Aspect ratio: 1.91:1 preferred

• JPEG or PNG
• Under 1MB file size
• High quality, clear image

• Clear, recognizable imagery
• Avoid text-heavy images
• High contrast for mobile viewing

​

Best Practices

1. Always Include Protocol
   // ✅ Correct
   {"link": "https://example.com"}
   
   // ❌ Incorrect
   {"link": "example.com"}
   
2. Use HTTPS When Possible
   • More secure
   • Better preview generation
   • Builds trust with recipients
3. Add Compelling Captions
   • Provide context for the link
   • Use emojis to grab attention
   • Include call-to-action
   • Keep it concise but informative
4. Test Link Previews
   • Send test messages to verify preview appearance
   • Check on both mobile and desktop
   • Ensure images load correctly
   • Verify title and description are accurate
5. Short Links
   • Use URL shorteners for long URLs
   • Track clicks with shortened links
   • Make links more shareable
   • Examples: bit.ly, tinyurl.com
6. Track Engagement
   • Use UTM parameters for analytics
   • Create unique tracking links
   • Monitor click-through rates
   • Example: ?utm_source=whatsapp&utm_medium=api

​

Link Types

​

Website Links

curl -X POST http://localhost:3000/send/link \
  -d '{"phone": "...", "link": "https://www.example.com"}'

​

Deep Links (Mobile Apps)

# App store links work too
curl -X POST http://localhost:3000/send/link \
  -d '{"phone": "...", "link": "https://apps.apple.com/app/id123456"}'

​

File Downloads

# Direct download links
curl -X POST http://localhost:3000/send/link \
  -d '{"phone": "...", "link": "https://example.com/files/document.pdf"}'

​

Video Platforms

# YouTube, Vimeo, etc.
curl -X POST http://localhost:3000/send/link \
  -d '{"phone": "...", "link": "https://vimeo.com/123456789"}'

​

Maps & Locations

# Google Maps links
curl -X POST http://localhost:3000/send/link \
  -d '{"phone": "...", "link": "https://goo.gl/maps/example"}'

​

UTM Tracking Example

curl -X POST http://localhost:3000/send/link \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{
    "phone": "[email protected]",
    "link": "https://example.com/product?utm_source=whatsapp&utm_medium=api&utm_campaign=summer_sale",
    "caption": "Exclusive offer just for you!"
  }'

• utm_source=whatsapp - Traffic source
• utm_medium=api - Marketing medium
• utm_campaign=summer_sale - Campaign name
• utm_content=variant_a - Content variation (optional)
• utm_term=keyword - Keywords (optional)

​

Preview Troubleshooting

​

No Preview Shows

1. Check Open Graph tags - Verify page has og:title, og:description, og:image
2. HTTPS Required - Some sites require HTTPS for previews
3. Page Accessible - Ensure page is publicly accessible
4. WhatsApp Cache - WhatsApp may cache old previews
5. Robots.txt - Check if page allows crawler access

​

Wrong Image Shows

1. Update og:image tag - Specify correct image URL
2. Image Size - Ensure image meets minimum dimensions
3. Image Format - Use JPEG or PNG
4. Clear Cache - Wait for WhatsApp to refresh cache

​

Preview Takes Long Time

1. Page Load Speed - Optimize page performance
2. Image Size - Compress large images
3. Server Response - Improve server response time
4. CDN Usage - Use CDN for faster image delivery

​

Limitations

1. Preview Caching: WhatsApp caches link previews; updates may not appear immediately
2. External Dependency: Preview quality depends on target website’s metadata
3. Loading Time: Large images may cause slow preview generation
4. Blocked Sites: Some domains may be blocked or restricted
5. No Custom Preview: Cannot override WhatsApp’s automatic preview generation

​

Error Responses

​

Related Endpoints

• Send Text - Send plain text messages
• Send Image - Send images directly
• Send File - Send documents
• Send Location - Share location coordinates