Whatspie

https://docs.whatspie.com/docs/
Admin
Whatspie is an enterprise-grade WhatsApp Business API platform that enables developers to integrate...
Tokens:66,608
Snippets:321
Trust Score:5.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Message Formatting Examples

Source: https://docs.whatspie.com/docs/messaging/send-text

Examples demonstrating how to apply WhatsApp text formatting styles in API requests.

```bash
# Bold text example  
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210",
    "type": "chat",
    "message": "This is *bold text* in WhatsApp",
    "simulate_typing": 1
  }'
  
# Mixed formatting  
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "device": "6281234567890", 
    "receiver": "6289876543210",
    "type": "chat",
    "message": "*Bold* _italic_ ~strike~ `code` text combined!",
    "simulate_typing": 1
  }'
```

--------------------------------

### Create Device

Source: https://docs.whatspie.com/docs/device-management

Endpoint and request example for creating a new WhatsApp device.

```text
POST https://api.whatspie.com/devices
```

```bash
curl -L -X POST 'https://api.whatspie.com/devices' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json; charset=utf-8' \
  -H 'Authorization: Bearer <TOKEN>' \
  --data-raw '{
    "package": "STARTUP240K",
    "name": "Customer Service"
  }'
```

```json
{
  "code": 400,
  "message": "Invalid package type"
}
```

--------------------------------

### Send Product Catalog List

Source: https://docs.whatspie.com/docs/messaging/send-list

Example request for sending a product catalog with categorized sections and selectable items.

```bash
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210",
    "type": "list",
    "params": {
      "title": "📱 TechStore Catalog",
      "text": "Browse our latest collection of tech products with amazing deals and warranties!",
      "footer": "💳 Easy payments • 🚚 Fast shipping",
      "buttonText": "🛒 Browse Products",
      "sections": [
        {
          "title": "📱 Smartphones",
          "rows": [
            {
              "title": "iPhone 15 Pro",
              "rowId": "iphone_15_pro",
              "description": "Latest Apple flagship - $999"
            },
            {
              "title": "Samsung Galaxy S24",
              "rowId": "galaxy_s24",
              "description": "Android powerhouse - $849"
            }
          ]
        },
        {
          "title": "💻 Laptops", 
          "rows": [
            {
              "title": "MacBook Air M3",
              "rowId": "macbook_air_m3",
              "description": "Ultra-portable performance - $1299"
            },
            {
              "title": "Dell XPS 13",
              "rowId": "dell_xps_13",
              "description": "Windows ultrabook - $999"
            }
          ]
        }
      ]
    },
    "simulate_typing": 1
  }'
```

--------------------------------

### Customer Feedback Template

Source: https://docs.whatspie.com/docs/messaging/send-template

Example object for a customer satisfaction survey using rating buttons.

```javascript
const feedbackTemplate = {  
  text: `⭐ *Rate Your Experience*  
  
How satisfied are you with our service today?  
  
Your feedback helps us serve you better!`,  
    
  footer: 'Takes less than 30 seconds',  
    
  buttons: [  
    {  
      buttonId: 'rating_5',  
      buttonText: { displayText: '⭐⭐⭐⭐⭐ Amazing' },  
      type: 1  
    },  
    {  
      buttonId: 'rating_4',  
      buttonText: { displayText: '⭐⭐⭐⭐ Great' },  
      type: 1  
    },  
    {  
      buttonId: 'rating_3',  
      buttonText: { displayText: '⭐⭐⭐ Good' },  
      type: 1  
    }  
  ]  
};  
```

--------------------------------

### Send Restaurant Menu List

Source: https://docs.whatspie.com/docs/messaging/send-list

Example request for sending a restaurant menu with categorized sections and selectable items.

```bash
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210",
    "type": "list",
    "params": {
      "title": "🍕 Tony'\''s Pizza Menu",
      "text": "Choose from our delicious menu! All items are freshly prepared with the finest ingredients. 🔥",
      "footer": "🚚 Free delivery on orders over $25",
      "buttonText": "📋 View Menu",
      "sections": [
        {
          "title": "🍕 Pizzas",
          "rows": [
            {
              "title": "Margherita Pizza",
              "rowId": "pizza_margherita",
              "description": "Fresh tomatoes, mozzarella, basil - $12"
            },
            {
              "title": "Pepperoni Pizza", 
              "rowId": "pizza_pepperoni",
              "description": "Pepperoni, mozzarella, tomato sauce - $15"
            }
          ]
        },
        {
          "title": "🥗 Salads",
          "rows": [
            {
              "title": "Caesar Salad",
              "rowId": "salad_caesar",
              "description": "Crispy lettuce, parmesan, croutons - $8"
            },
            {
              "title": "Greek Salad",
              "rowId": "salad_greek", 
              "description": "Tomatoes, olives, feta, cucumber - $9"
            }
          ]
        }
      ]
    },
    "simulate_typing": 1
  }'
```

--------------------------------

### Handle Message Response

Source: https://docs.whatspie.com/docs/intro

Example of a successful JSON response after sending a message.

```json
{
    "status": 200,
    "message": "OK",
    "data": {
        "id": 36259782,
        "from_number": "62895383079050",
        "to_number": "6285603051722",
        "type": "chat",
        "msg_type": "outgoing",
        "body": "Hi!",
        "status": "PENDING",
        "wa_id": null,
        "retry": 0,
        "failed_reason": null,
        "file_url": null,
        "file_name": null,
        "file_caption": null,
        "file_size": null,
        "file_mime": null,
        "params": {
            "text": "Hi!"
        },
        "is_group": false,
        "created_at": "2025-08-22T03:36:02.179279985Z",
        "updated_at": "2025-08-22T03:36:02.179280065Z"
    }
}  

```

--------------------------------

### Usage Example with Error Handling

Source: https://docs.whatspie.com/docs/messaging/send-text

Demonstrates how to use the `sendMessageWithRetry` function and the `WhatspieErrorHandler` to send a message and log any errors encountered.

```javascript
try {
  const result = await sendMessageWithRetry(
    'YOUR_API_TOKEN',
    '6281234567890',
    '6289876543210',
    'Hello with error handling!'
  );
  console.log('Message sent successfully:', result.data.id);
} catch (error) {
  const errorMessage = WhatspieErrorHandler.handleError(error);
  console.error('Failed to send message:', errorMessage);
}
```

--------------------------------

### Send Formatted Text Message

Source: https://docs.whatspie.com/docs/messaging/send-text

Example of sending a text message with WhatsApp formatting and typing simulation enabled.

```bash
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210",
    "type": "chat",
    "params": {
      "text": "*Bold Text* _Italic Text_ ~Strikethrough~ `Monospace`\n\nNew paragraph with emojis! 🎉✨"
    },
    "simulate_typing": 1
  }'
```

--------------------------------

### Groups List Request with Custom Headers using cURL

Source: https://docs.whatspie.com/docs/groups/list-groups

This example shows how to make a GET request to the /groups endpoint with additional custom headers like 'User-Agent'.

```curl
curl -L -X GET 'https://api.whatspie.com/groups' \
  -H 'Accept: application/json; charset=utf-8' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'User-Agent: MyApp/1.0'
```

--------------------------------

### GET /devices

Source: https://docs.whatspie.com/docs/device-management

Retrieve a list of all WhatsApp devices associated with the authenticated account.

```APIDOC
## GET /devices

### Description
Get all devices associated with your account.

### Method
GET

### Endpoint
https://api.whatspie.com/devices

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code
- **message** (string) - Status message
- **data** (array) - List of device objects
```

--------------------------------

### API Response Examples

Source: https://docs.whatspie.com/docs/groups/send-group-messages

Standard JSON response formats for successful requests and common error scenarios.

```json
{
  "code": 200,
  "message": "Message sent successfully",
  "data": {
    "id": "msg_group_12345",
    "status": "pending",
    "type": "chat",
    "device": "6281234567890",
    "receiver": "120363022368688477@g.us",
    "message": "Team Update: Project milestone completed!",
    "simulate_typing": 1,
    "timestamp": "2024-12-20T10:30:00Z"
  }
}
```

```json
{
  "code": 404,
  "message": "Group not found",
  "error": "The specified group ID does not exist or you don't have access to it"
}
```

```json
{
  "code": 403,
  "message": "Access denied",
  "error": "Your device is not a member of this group"
}
```

--------------------------------

### Event RSVP Template

Source: https://docs.whatspie.com/docs/messaging/send-template

Example object for an event invitation with interactive RSVP buttons.

```javascript
const eventRSVPTemplate = {  
  text: `🎉 *Tech Meetup Invitation*  
  
📅 December 25, 2024  
⏰ 6:00 PM - 9:00 PM    
📍 Innovation Hub Downtown  
🎯 Topic: "AI in 2024"`,  
    
  footer: '🍕 Food & drinks provided',  
    
  buttons: [  
    {  
      buttonId: 'rsvp_yes',  
      buttonText: { displayText: '✅ I\'ll be there!' },  
      type: 1  
    },  
    {  
      buttonId: 'rsvp_no',  
      buttonText: { displayText: '❌ Can\'t make it' },  
      type: 1  
    },  
    {  
      buttonId: 'rsvp_maybe',  
      buttonText: { displayText: '🤔 Maybe' },  
      type: 1  
    }  
  ]  
};  
```

--------------------------------

### Send File Messages via cURL

Source: https://docs.whatspie.com/docs/messaging/send-file

Examples for sending different types of files using the Whatspie API.

```bash
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210",
    "type": "file",
    "params": {
      "document": {
        "url": "https://example.com/documents/report.pdf"
      },
      "fileName": "Monthly_Sales_Report_Q4_2024.pdf",
      "mimetype": "application/pdf"
    },
    "simulate_typing": 1
  }'
```

```bash
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210",
    "type": "file",
    "params": {
      "document": {
        "url": "https://cdn.example.com/files/presentation.pptx"
      },
      "fileName": "Product_Launch_Presentation_Q1.pptx",
      "mimetype": "application/vnd.openxmlformats-officedocument.presentationml.presentation"
    },
    "simulate_typing": 1
  }'
```

```bash
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210", 
    "type": "file",
    "file_url": "https://docs.example.com/api/documentation.pdf",
    "message": "📚 API Documentation v2.1\n\nLatest version with new endpoints and examples.",
    "simulate_typing": 1
  }'
```

--------------------------------

### Hotel Booking List Configuration

Source: https://docs.whatspie.com/docs/messaging/send-list

Example structure for a WhatsApp list representing hotel booking options. Includes title, text, footer, button text, and sections with rows.

```javascript
const hotelBookingList = {  
  title: '🏨 Hotel Reservations',  
  text: 'Find the perfect stay for your trip. All hotels include free WiFi and breakfast.',  
  footer: '📞 24/7 customer support available',  
  buttonText: '🛏️ View Hotels',  
  sections: [  
    {  
      title: '⭐⭐⭐⭐⭐ Luxury',  
      rows: [  
        {  
          title: 'Grand Palace Hotel',  
          rowId: 'hotel_grand_palace',  
          description: 'City center • Pool & Spa • $299/night'  
        }  
      ]  
    },  
    {  
      title: '⭐⭐⭐⭐ Premium',  
      rows: [  
        {  
          title: 'Business Inn',  
          rowId: 'hotel_business_inn',   
          description: 'Near airport • Meeting rooms • $159/night'  
        }  
      ]  
    }  
  ]  
};  
```

--------------------------------

### GET /devices/{id}

Source: https://docs.whatspie.com/docs/device-management

Retrieve detailed information about a specific WhatsApp device by its ID.

```APIDOC
## GET /devices/{id}

### Description
Get detailed information about a specific device.

### Method
GET

### Endpoint
https://api.whatspie.com/devices/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the device

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code
- **data** (object) - Device details

#### Error Response (404)
- **code** (integer) - 404
- **message** (string) - Device not found
```

--------------------------------

### Group Information Response Format

Source: https://docs.whatspie.com/docs/groups/send-group-messages

Example JSON response structure returned when querying group details.

```json
{
  "code": 200,
  "data": {
    "id": 495,
    "name": "Project Team",
    "description": "Development team coordination",
    "participant_count": 8,
    "created_at": "2024-11-15T09:00:00Z",
    "is_admin": false,
    "can_send_messages": true
  }
}
```

--------------------------------

### GET /devices/{id}/qr

Source: https://docs.whatspie.com/docs/device-management

Generate or retrieve the QR code for connecting a specific WhatsApp device.

```APIDOC
## GET /devices/{id}/qr

### Description
Generate or retrieve the QR code for device connection.

### Method
GET

### Endpoint
https://api.whatspie.com/devices/{id}/qr

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the device

#### Query Parameters
- **response_type** (string) - Required - Must be set to "url"

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code
- **data** (object) - Contains the qr code string
```

--------------------------------

### Send Basic Video Message

Source: https://docs.whatspie.com/docs/messaging/send-video

Use this example to send a video message with a simple caption. Ensure your API token is valid and the video URL is accessible.

```curl
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210",
    "type": "file",
    "params": {
      "document": {
        "url": "https://example.com/videos/demo.mp4"
      },
      "mimetype": "video/mp4",
      "caption": "Check out this amazing video! 🎥✨"
    },
    "simulate_typing": 1
  }'
```

--------------------------------

### Effective Row Descriptions (JavaScript)

Source: https://docs.whatspie.com/docs/messaging/send-list

Provides examples of creating effective row descriptions within a list message in JavaScript. Demonstrates how to include key information concisely and what to avoid.

```javascript
function createEffectiveRows() {
  return [
    // ✅ Good - includes key information
    {
      title: 'Premium Burger',
      rowId: 'burger_premium',
      description: 'Angus beef, bacon, cheese - $15.99'
    },
      
    // ✅ Good - concise but informative    
    {
      title: 'Yoga Class',
      rowId: 'yoga_beginner',
      description: 'Beginner level • 60 min • Morning slot'
    },
      
    // ❌ Avoid - too long
    {
      title: 'Special Deluxe Ultimate Supreme Pizza',
      rowId: 'pizza_special',
      description: 'This amazing pizza contains the finest ingredients sourced from local farms including...'
    },
      
    // ❌ Avoid - no useful information
    {
      title: 'Item 1',
      rowId: 'item1',
      description: 'Available now'
    }
  ];
}

```

--------------------------------

### E-commerce Order Confirmation Template

Source: https://docs.whatspie.com/docs/messaging/send-template

Example object for an order confirmation message including tracking and support buttons.

```javascript
const orderConfirmationTemplate = {  
  text: `🛒 *Order Confirmed!*   
  
Order #12345  
📦 3 items • Total: $89.99  
🚚 Estimated delivery: 2-3 days`,  
    
  footer: 'Thank you for shopping with us!',  
    
  templateButtons: [  
    {  
      index: 1,  
      urlButton: {  
        displayText: '📱 Track Order',  
        url: 'https://shop.example.com/track/12345'  
      }  
    },  
    {  
      index: 2,  
      callButton: {  
        displayText: '📞 Contact Support',  
        phoneNumber: '+1234567890'  
      }  
    }  
  ]  
};  
```

--------------------------------

### Optimal vs. Poor List Structure (JavaScript)

Source: https://docs.whatspie.com/docs/messaging/send-list

Compares good and poor examples of structuring a list message in JavaScript. Highlights the importance of clear titles, concise text, and well-organized sections.

```javascript
// ✅ Good - Well organized with clear sections
const goodListStructure = {
  title: '🎯 Clear Main Title',
  text: 'Concise description that explains what the list contains.',
  footer: 'Brief footer text',
  buttonText: '📋 Action Button', // Clear action
  sections: [
    {
      title: '📱 Category 1', // Use emojis for clarity
      rows: [
        {
          title: 'Item Name',
          rowId: 'unique_id_1',
          description: 'Short, helpful description'
        }
      ]
    }
  ]
};

// ❌ Avoid - Too many sections, unclear titles
const poorListStructure = {
  title: 'List of Various Things', // Too vague
  text: 'Here are some items you can choose from...', // Not informative
  buttonText: 'Click', // Not descriptive
  sections: [
    // Too many sections make it overwhelming
    { title: 'Section 1', rows: [...] },
    { title: 'Section 2', rows: [...] },
    { title: 'Section 3', rows: [...] },
    { title: 'Section 4', rows: [...] },
    { title: 'Section 5', rows: [...] }
  ]
};

```

--------------------------------

### Add Group Members via cURL

Source: https://docs.whatspie.com/docs/groups/add-members

Examples of adding single, multiple, or international members to a group using cURL.

```bash
curl -L -X POST 'https://api.whatspie.com/api/groups/2/members/add' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  --data-raw '{
    "participants": [
      "6287830605729"
    ]
  }'
```

```bash
curl -L -X POST 'https://api.whatspie.com/api/groups/2/members/add' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  --data-raw '{
    "participants": [
      "6287830605729",
      "6281234567890",
      "6289876543210",
      "6285544332211"
    ]
  }'
```

```bash
curl -L -X POST 'https://api.whatspie.com/api/groups/2/members/add' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  --data-raw '{
    "participants": [
      "6287830605729",
      "60123456789",
      "65123456789",
      "91123456789",
      "1234567890"
    ]
  }'
```

--------------------------------

### Send Simple Button Template

Source: https://docs.whatspie.com/docs/messaging/send-template

This example demonstrates sending a template message with simple reply buttons. Each button has a unique ID and display text. The 'type' for these buttons is set to 1.

```curl
curl -X POST "https://api.whatspie.com/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "device": "6281234567890",
    "receiver": "6289876543210",
    "type": "template",
    "params": {
      "text": "Would you like to proceed with your order?",
      "footer": "Thank you for shopping with us!",
      "buttons": [
        {
          "buttonId": "yes_proceed",
          "buttonText": {
            "displayText": "✅ Yes, Proceed"
          },
          "type": 1
        },
        {
          "buttonId": "no_cancel",
          "buttonText": {
            "displayText": "❌ No, Cancel"
          },
          "type": 1
        }
      ]
    },
    "simulate_typing": 1
  }'
```

--------------------------------

### Support Ticket Categories List Configuration

Source: https://docs.whatspie.com/docs/messaging/send-list

Example structure for a WhatsApp list to categorize support tickets. Features a title, descriptive text, footer, button text, and categorized sections with rows.

```javascript
const supportCategories = {  
  title: '🎫 Create Support Ticket',  
  text: 'Tell us how we can help you. Our support team will respond within 24 hours.',  
  footer: '⚡ Urgent issues: call (555) 123-HELP',  
  buttonText: '📝 Select Issue Type',  
  sections: [  
    {  
      title: '🐛 Technical Issues',  
      rows: [  
        {  
          title: 'Website Not Loading',  
          rowId: 'tech_website_loading',  
          description: 'Pages won\'t load or load slowly'  
        },  
        {  
          title: 'Login Problems',  
          rowId: 'tech_login_issues',  
          description: 'Can\'t sign in to your account'  
        }  
      ]  
    },  
    {  
      title: '💳 Billing & Payments',  
      rows: [  
        {  
          title: 'Payment Failed',  
          rowId: 'billing_payment_failed',  
          description: 'Transaction was declined'  
        },  
        {  
          title: 'Refund Request',  
          rowId: 'billing_refund',  
          description: 'Request a refund for purchase'  
        }  
      ]  
    }  
  ]  
};  
```

--------------------------------

### Send List Message with Node.js

Source: https://docs.whatspie.com/docs/messaging/send-list

Use this function to send list messages. It requires an API token, device number, receiver number, and a list configuration object. Ensure Axios is installed.

```javascript
const axios = require('axios');

async function sendListMessage(token, device, receiver, listConfig) {
  try {
    const response = await axios.post(
      'https://api.whatspie.com/messages',
      {
        device: device,
        receiver: receiver,
        type: 'list',
        params: listConfig,
        simulate_typing: 1
      },
      {
        headers: {
          'Authorization': `Bearer ${token}`,
          'Content-Type': 'application/json',
          'Accept': 'application/json'
        }
      }
    );

    return response.data;
  } catch (error) {
    console.error('Error sending list:', error.response?.data || error.message);
    throw error;
  }
}
```

--------------------------------

### Get QR Code

Source: https://docs.whatspie.com/docs/device-management

Retrieve the QR code for device connection.

```text
GET https://api.whatspie.com/devices/{id}/qr
```

```bash
curl -L -X GET 'https://api.whatspie.com/devices/5/qr?response_type=url' \
  -H 'Accept: application/json; charset=utf-8' \
  -H 'Authorization: Bearer <TOKEN>'
```

```json
{
    "status": 200,
    "message": "OK",
    "data": {
        "qr": "data:image/png;base64,json-image"
    }
}
```

--------------------------------

### Send Product Demonstration Video

Source: https://docs.whatspie.com/docs/messaging/send-video

This function sends a product demonstration video to a customer. The product object should include name, features, price, inStock status, orderUrl, and demoVideoUrl. The video must be MP4 format.

```javascript
async function sendProductDemo(token, customerPhone, product) {
  const caption = `🎥 *${product.name} - Live Demo*  
  
💡 See how it works in action!  
  
✨ Key Features:  
${product.features.map(f => `• ${f}`).join('
')}
  
💰 Special Price: $${product.price}  
📦 In Stock: ${product.inStock ? 'Yes' : 'No'}  
  
🛒 Order Now: ${product.orderUrl}`;  
  
  const response = await fetch('https://api.whatspie.com/messages', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    },
    body: JSON.stringify({
      device: '6281234567890',
      receiver: customerPhone,
      type: 'file',
      params: {
        document: {
          url: product.demoVideoUrl
        },
        mimetype: 'video/mp4',
        caption: caption
      },
      simulate_typing: 1
    })
  });
  
  return await response.json();
}
```

--------------------------------

### Create Device with Package Selection

Source: https://docs.whatspie.com/docs/device-management

cURL commands to create a new device by specifying a package code and a display name.

```bash
# Create device with Starter package
curl -L -X POST 'https://api.whatspie.com/devices' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "package": "STARTER60K",
    "name": "Basic Bot"
  }'
```

```bash
# Create device with Business package
curl -L -X POST 'https://api.whatspie.com/devices' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "package": "BUSINESS",
    "name": "Enterprise Bot"
  }'
```

--------------------------------

### Get Device Information

Source: https://docs.whatspie.com/docs/device-management

Retrieve detailed information for a specific device by ID.

```text
GET https://api.whatspie.com/devices/{id}
```

```bash
curl -L -X GET 'https://api.whatspie.com/devices/6' \
  -H 'Accept: application/json; charset=utf-8' \
  -H 'Authorization: Bearer <TOKEN>'
```

```json
{
    "status": 200,
    "message": "OK",
    "data": {
        "id": 5,
        "phone": "62895383079050",
        "webhook_url": "https://your-webhook-url.com",
        "status": "ACTIVE",
        "version": "multidevice",
        "paired_status": "PAIRED",
        "created_at": "2020-02-26T07:06:47Z",
        "updated_at": "2025-08-11T21:30:42Z",
        "server": {
            "name": "ASIA (IDN1)",
            "status": "ACTIVE"
        },
        "package": {
            "code": "STARTUP240K",
            "name": "Startup"
        },
        "subscription": {
            "quote_available": "-1",
            "quote_used": "62755"
        }
    }
}
```

```json
{
  "code": 404,
  "message": "Device not found"
}
```

--------------------------------

### POST /devices

Source: https://docs.whatspie.com/docs/device-management

Create a new WhatsApp device with a specific package plan.

```APIDOC
## POST /devices

### Description
Create a new WhatsApp device with a specific package plan.

### Method
POST

### Endpoint
https://api.whatspie.com/devices

### Parameters
#### Request Body
- **package** (string) - Required - Package plan (e.g., "STARTUP240K")
- **name** (string) - Required - Display name for the device

### Request Example
{
  "package": "STARTUP240K",
  "name": "Customer Service"
}

### Response
#### Error Response (400)
- **code** (integer) - Error code
- **message** (string) - Error description
```

--------------------------------

### Group Message Structure

Source: https://docs.whatspie.com/docs/groups/send-group-messages

Example of a well-formatted text message object for group announcements.

```javascript
// Good: Clear, structured group messages  
const groupMessage = {  
  device: "6281234567890",  
  type: "text",  
  params: {  
    text: "📢 *ANNOUNCEMENT* 📢\n\n" +  
          "Subject: Weekly Standup\n" +  
          "📅 When: Monday 10:00 AM\n" +  
          "📍 Where: Conference Room B\n" +  
          "⏱️ Duration: 30 minutes\n\n" +  
          "Please bring your progress updates! 📊"  
  },  
  simulate_typing: 1  
};
```

--------------------------------

### Implementing List Message Dispatch in Python

Source: https://docs.whatspie.com/docs/messaging/send-list

Uses the requests library to send a POST request to the Whatspie API with the required authentication and message parameters.

```python
import requests  
  
def send_list_message(token, device, receiver, list_config):  
    url = "https://api.whatspie.com/messages"  
      
    headers = {  
        'Authorization': f'Bearer {token}',  
        'Content-Type': 'application/json',  
        'Accept': 'application/json'  
    }  
      
    data = {  
        'device': device,  
        'receiver': receiver,  
        'type': 'list',  
        'params': list_config,  
        'simulate_typing': 1  
    }  
      
    response = requests.post(url, headers=headers, json=data)  
      
    if response.status_code == 200:  
        return response.json()  
    else:  
        response.raise_for_status()
```

--------------------------------

### GET /groups/{group_id}

Source: https://docs.whatspie.com/docs/groups/get-group

Retrieve detailed information about a specific WhatsApp group using its ID.

```APIDOC
## GET /groups/{group_id}

### Description
Retrieve detailed information about a specific WhatsApp group using its ID. This endpoint provides comprehensive details including member information, permissions, recent activity, and group settings.

### Method
GET

### Endpoint
`https://api.whatspie.com/groups/{group_id}`

### Parameters
#### Path Parameters
- **group_id** (integer) - Required - The unique identifier of the group.

#### Query Parameters
None

#### Request Body
None

### Request Example
#### Basic Group Info Request
```curl
curl -L -X GET 'https://api.whatspie.com/groups/482' \
  -H 'Accept: application/json; charset=utf-8' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
```

#### With Detailed Response (Including Members)
```curl
curl -L -X GET 'https://api.whatspie.com/groups/482' \
  -H 'Accept: application/json; charset=utf-8' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Include-Members: true'
```

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code.
- **message** (string) - A message indicating the success of the operation.
- **data** (object) - Contains the group information.
  - **id** (string) - The internal ID of the group.
  - **device_id** (string) - The ID of the device associated with the group.
  - **jid** (string) - The WhatsApp JID of the group.
  - **title** (string) - The name of the group.
  - **description** (string) - The description of the group.
  - **image_url** (string) - URL of the group's profile picture.
  - **muted** (boolean) - Indicates if the group is muted for the user.
  - **spam** (boolean) - Indicates if the group is flagged as spam.
  - **group_created_at** (string) - Timestamp when the group was created.
  - **created_at** (string) - Timestamp when the group record was created in the system.
  - **updated_at** (string) - Timestamp when the group record was last updated.
  - **permissions** (object) - Group permissions.
    - **can_send_messages** (boolean) - Whether the user can send messages.
    - **can_add_members** (boolean) - Whether the user can add members.
    - **can_edit_info** (boolean) - Whether the user can edit group info.
    - **can_remove_members** (boolean) - Whether the user can remove members.
    - **allow_send** (boolean) - General setting for sending messages.
    - **only_admins_can_send** (boolean) - If true, only admins can send messages.
    - **only_admins_can_edit** (boolean) - If true, only admins can edit group info.
  - **settings** (object) - Group settings.
    - **disappearing_messages** (object) - Settings for disappearing messages.
      - **enabled** (boolean) - Whether disappearing messages are enabled.
      - **duration** (null) - Duration of disappearing messages (if enabled).
    - **group_invite_link** (string) - The invite link for the group.
    - **invite_link_revoked** (boolean) - Whether the invite link has been revoked.
  - **admins** (array) - List of group administrators.
    - **phone** (string) - Phone number of the admin.
    - **name** (string) - Name of the admin.
    - **is_creator** (boolean) - Whether the admin is the group creator.
  - **participants** (array) - List of group participants.
    - **phone** (string) - Phone number of the participant.
    - **name** (string) - Name of the participant.
    - **is_admin** (boolean) - Whether the participant is an admin.
    - **joined_at** (string) - Timestamp when the participant joined.
    - **last_seen** (string) - Timestamp of the participant's last seen activity.
  - **recent_messages** (array) - List of recent messages in the group.
    - **id** (string) - Unique message ID.
    - **type** (string) - Type of message (e.g., 'text', 'image').
    - **sender** (object) - Information about the message sender.
      - **phone** (string) - Phone number of the sender.
      - **name** (string) - Name of the sender.
    - **content** (string) - The content of the message (for text messages).
    - **image_url** (string) - URL of the image (for image messages).
    - **timestamp** (string) - Timestamp when the message was sent.
    - **mentions** (array) - List of mentioned phone numbers.
  - **statistics** (object) - Group statistics.
    - **total_messages** (integer) - Total number of messages in the group.
    - **messages_today** (integer) - Number of messages sent today.
    - **messages_this_week** (integer) - Number of messages sent this week.
    - **most_active_member** (object) - Information about the most active member.
      - **phone** (string) - Phone number of the most active member.
      - **name** (string) - Name of the most active member.
      - **message_count** (integer) - Number of messages sent by the most active member.
    - **media_messages** (integer) - Number of media messages.
    - **text_messages** (integer) - Number of text messages.

#### Response Example
```json
{
  "code": 200,
  "message": "Group information retrieved successfully",
  "data": {
    "id": "15378",
    "device_id": "5",
    "jid": "120363022368688477@g.us",
    "title": "Project Team Alpha",
    "description": "Development team for Project Alpha - Sprint planning and daily updates",
    "image_url": "https://example.com/group-avatar-482.jpg",
    "muted": false,
    "spam": false,
    "group_created_at": "2024-11-15T09:00:00Z",
    "created_at": "2024-11-15T09:05:00Z",
    "updated_at": "2024-12-20T14:30:00Z",
    "permissions": {
      "can_send_messages": true,
      "can_add_members": true,
      "can_edit_info": true,
      "can_remove_members": true,
      "allow_send": true,
      "only_admins_can_send": false,
      "only_admins_can_edit": false
    },
    "settings": {
      "disappearing_messages": {
        "enabled": false,
        "duration": null
      },
      "group_invite_link": "https://chat.whatsapp.com/ABC123DEF456GHI789",
      "invite_link_revoked": false
    },
    "admins": [
      {
        "phone": "6281234567890",
        "name": "John Smith",
        "is_creator": true
      },
      {
        "phone": "6289876543210",
        "name": "Sarah Johnson",
        "is_creator": false
      }
    ],
    "participants": [
      {
        "phone": "6281234567890",
        "name": "John Smith",
        "is_admin": true,
        "joined_at": "2024-11-15T09:00:00Z",
        "last_seen": "2024-12-20T14:25:00Z"
      },
      {
        "phone": "6289876543210",
        "name": "Sarah Johnson",
        "is_admin": true,
        "joined_at": "2024-11-15T09:05:00Z",
        "last_seen": "2024-12-20T14:20:00Z"
      },
      {
        "phone": "6281122334455",
        "name": "Mike Wilson",
        "is_admin": false,
        "joined_at": "2024-11-16T10:30:00Z",
        "last_seen": "2024-12-20T13:45:00Z"
      },
      {
        "phone": "6285544332211",
        "name": "Lisa Davis",
        "is_admin": false,
        "joined_at": "2024-11-18T14:15:00Z",
        "last_seen": "2024-12-20T12:30:00Z"
      }
    ],
    "recent_messages": [
      {
        "id": "msg_group_789123",
        "type": "text",
        "sender": {
          "phone": "6281234567890",
          "name": "John Smith"
        },
        "content": "Great work on the sprint everyone! 🎉",
        "timestamp": "2024-12-20T14:30:00Z",
        "mentions": []
      },
      {
        "id": "msg_group_789122",
        "type": "image",
        "sender": {
          "phone": "6289876543210",
          "name": "Sarah Johnson"
        },
        "content": "Sprint retrospective results",
        "image_url": "https://example.com/message-image-123.jpg",
        "timestamp": "2024-12-20T14:15:00Z",
        "mentions": []
      },
      {
        "id": "msg_group_789121",
        "type": "text",
        "sender": {
          "phone": "6281122334455",
          "name": "Mike Wilson"
        },
        "content": "The API integration is complete @6281234567890 @6289876543210",
        "timestamp": "2024-12-20T13:45:00Z",
        "mentions": ["6281234567890", "6289876543210"]
      }
    ],
    "statistics": {
      "total_messages": 1247,
      "messages_today": 23,
      "messages_this_week": 156,
      "most_active_member": {
        "phone": "6281234567890",
        "name": "John Smith",
        "message_count": 387
      },
      "media_messages": 89,
      "text_messages": 1158
    }
  }
}
```
```

--------------------------------

### Package Types

Source: https://docs.whatspie.com/docs/device-management

Lists the available package codes that can be used when creating a new device.

```APIDOC
## Package Types

Available package codes for device creation:

| ID | Package Code | Name |
|---|---|---|
| 1 | `BETA` | Beta Tester |
| 2 | `STARTER60K` | Starter |
| 3 | `STARTUP240K` | Startup |
| 4 | `BUSINESS` | Business |
```

--------------------------------

### Send Product Video with Formatted Caption

Source: https://docs.whatspie.com/docs/messaging/send-video

Sends a product video with a detailed caption that includes rich text formatting like bold, italics, strikethrough, and links. Requires an API token and valid video URL.

```javascript
async function sendProductVideo() {
  const caption = `🎥 *PRODUCT DEMO* 🎥  
  
_See our new product in action_  
  
✅ Feature 1: Lightning Fast  
✅ Feature 2: User Friendly  
✅ Feature 3: Secure & Reliable  
  
~~$499~~ *$399* (20% OFF)  
  
Use code: *VIDEO20*  
Valid until: December 31st  
  
Order now: https://shop.example.com`;
  
  const response = await fetch('https://api.whatspie.com/messages', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_TOKEN',
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    },
    body: JSON.stringify({
      device: '6281234567890',
      receiver: '6289876543210',
      type: 'file',
      params: {
        document: {
          url: 'https://example.com/videos/product-demo.mp4'
        },
        mimetype: 'video/mp4',
        caption: caption
      },
      simulate_typing: 1
    })
  });
  
  return await response.json();
}
```
Tokens:
Raw