MIAUZAP

The most purr-fect way to manage your WhatsApp API connections.

Welcome back

Enter your token to access the dashboard

Token used to authenticate your requests to the API.
Admin Mode

Please enter your Global Admin token in the field to manage all instances.

Miauzap Manager
Home Docs
...
Logout
 

Instances Management

Monitor, manage, and provision new WhatsApp connections. Your entire infrastructure at a glance.

Loading instances...
ID Name Connected Logged In Actions

Instance Dashboard

ID: ...
Token: ...
Configuration

S3 Storage

Configure S3-compatible storage for media files.

Config

Language

Select the language used for internal API messages.

Config

Proxy Settings

Configure proxy for WhatsApp connections.

Config

Webhook Events

Configure webhook URL and event subscriptions.

Config

Message History

Configure message history retention logic.

Config

HMAC Key

Configure HMAC key for webhook security.

Config

Chatwoot Integration

Configure Chatwoot CRM integration for WhatsApp.

Config
User

User Info

Search users by phone number.

User

User Avatar

Get user avatar by phone number.

User

Get Contacts

Get all contacts.

User
Chat

Send Text Message

Sends a text message.

Chat

Delete Message

Deletes your sent message.

Chat
Groups

List Groups

View all your WhatsApp groups.

Groups

Create Group

Create a new WhatsApp group.

Groups

Join Group

Join a group using an invite link.

Groups
Developer

API Playground

Test API endpoints and preview messages.

Dev
Messaging
Text Message Image Message Video Message Audio Message Document Message Sticker Message Location Message Contact Message Carousel Message PIX Message
Chat Management
Send Poll Edit Message Delete Message React to Message Archive Chat Set Presence Mark as Read Get History (GET)
Group Management
Create Group Group Info Group Invite Link Set Group Photo Set Group Name Set Group Topic Set Group Description Manage Participants Group Settings: Only Admins Send Group Settings: Only Admins Edit Disappearing Messages Join Group with Link Get Invite Link Info Leave Group
Session
Status QR Code

Text Message

JSON Body cURL

                
Response

          

Model Schema


        
Recipient
Hello World!
12:00 PM

Groups Manager
Manage your WhatsApp groups

Loading groups...
No groups found
Create your first group
Getting Pair Code
How to pair?
  1. Open your Whatsapp
  2. Link a device
  3. Link with pair code
Press Enter to submit
Webhook





Close
Set
S3 Configuration
S3 Storage Configuration

Configure S3-compatible storage for media files. This includes AWS S3, MinIO, DigitalOcean Spaces, and other S3-compatible services.

For AWS S3, use the default. For MinIO/others, use your custom endpoint.
Required for AWS S3. Optional for MinIO and other providers.
Public URL for accessing files (if different from endpoint).
How media should be delivered in webhook events.
Number of days to retain files in S3 before deletion.
Enable for MinIO and some S3-compatible providers.
Cancel
Test Connection
Delete Configuration
Save
History Configuration
Message History

Number of messages to keep in history database. Set to zero to disable history.

Cancel
Save
Instance Language
Message Language Settings

Choose the language used for this instance's internal messages (e.g., "sent via api", "sent via phone" on Chatwoot).

This language will be used to translate internal strings generated by the API.
Cancel
Save
Proxy Configuration
Proxy Settings

Configure HTTP/HTTPS or SOCKS5 proxy for WhatsApp connections. Useful for network restrictions or enhanced privacy.

Enable or disable proxy for this instance.
Include protocol (http://, https://, or socks5://) and port. Authentication can be included in URL format.
Cancel
Save
HMAC Configuration
HMAC Key Settings

Configure HMAC key for webhook security. This key will be used to verify webhook authenticity.

Important Security Notice

The HMAC key will be hidden after saving for security reasons.
• You won't be able to view it again
• Save a copy in a secure location before proceeding
• If lost, you'll need to generate a new key

Minimum 32 characters for security. Keep this key secret!
Cancel
Delete Configuration
Save
Chatwoot Integration Configuration
Chatwoot CRM Integration

Configure Chatwoot integration to sync WhatsApp conversations with your Chatwoot CRM. Features include automatic contact sync, bidirectional messaging, media support, and conversation management.

Enable or disable Chatwoot integration for this instance.

Connection Settings

If enabled, status updates (stories) will be forwarded to Chatwoot.
Ative para mostrar o status 'digitando...' para o cliente no WhatsApp quando você estiver escrevendo pelo Chatwoot.
Base URL of your Chatwoot instance (e.g., https://app.chatwoot.com)
Your Chatwoot account ID
API access token from Chatwoot

Inbox Settings

Name for the inbox in Chatwoot (defaults to instance name if empty)
Automatically create inbox in Chatwoot if it doesn't exist

Message Settings

Add agent signature to messages sent from Chatwoot
Delimiter for message signatures (default: \n\n---\n)

Conversation Settings

Automatically reopen closed conversations when new messages arrive
Set new conversations as pending status
Merge contacts with Brazilian phone number variations (with/without 9th digit)
Import messages from WhatsApp groups to Chatwoot

Webhook Information

Configure this URL in your Chatwoot inbox settings to receive messages from agents
Cancel
Delete Configuration
Save
Add New Instance

Basic Configuration

Token is automatically generated. Click refresh to generate a new one.
Number of messages to store in history per chat for this instance. Set to 0 to disable message history.

Proxy Configuration (Optional)

Enable proxy for this instance
Include protocol (http://, https://, or socks5://) and port. Authentication can be included in URL format.

S3 Storage Configuration (Optional)

Enable S3-compatible storage for media files
For AWS S3, leave empty or use default. For MinIO/others, use your custom endpoint.
Required for AWS S3. Optional for MinIO and other providers.
Public URL for accessing files (if different from endpoint).
How media should be delivered in webhook events.
Number of days to retain files in S3 before deletion.
Enable for MinIO and some S3-compatible providers.

HMAC Configuration (Optional)

Enable HMAC key for webhook security
Important Security Notice

The HMAC key will be hidden after saving for security reasons.
• You won't be able to view it again
• Save a copy in a secure location before proceeding
• If lost, you'll need to generate a new key

Minimum 32 characters for security. Keep this key secret!
Delete Instance

Are you sure you want to delete this instance? This action cannot be undone.

No
Yes
User Info
Close
Get Info
User Avatar
Close
Get Avatar
Send Text Message
Close
Set
Delete Message
Close
Delete
Group Details
Group Name
-
Description
-
Participants
-
Created
-

Participants

Basic Actions
Admin Actions
Danger Zone
Create New Group
Click "Load Contacts" to populate the participants list.
Select participants
Cancel
Create Group
Join Group
Paste the full WhatsApp invite link or just the invite code
Group Preview
Cancel
Preview Group
Join Group
Edit Group
Current Photo
No Photo
Cancel
Save Changes
Group Settings

Message Permissions

When enabled, only group admins can send messages to this group.

Group Information

When enabled, only group admins can edit group name, description, and photo.

Disappearing Messages

Messages will automatically disappear after the selected time.

Group Photo

No Photo
Close
Save Settings
Manage Participants

Add Participants

Click "Load Contacts" to populate the list.
Select contacts to add

Current Participants

Close
Confirm Action

Are you sure you want to perform this action?

No
Yes
Edit Group Information
Cancel
Save Changes
Group Invite Link

Current Invite Link

Share this link to invite people to join the group.
Reset Invite Link

Resetting the invite link will invalidate the current link and create a new one. Anyone with the old link will no longer be able to join.

Close