Ultramsg WhatsApp API Documentation

https://docs.ultramsg.com
Admin
Integrate any application with Ultramsg's WhatsApp messaging system. The API simplifies sending and...
Tokens:144,775
Snippets:422
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### UltraMsg API: Get Instance Settings

Source: https://docs.ultramsg.com/api/get/instance/status

Retrieves the current settings configured for the WhatsApp instance.

```APIDOC
API Endpoint: /instance/settings

HTTP Method: GET

Description: Get the instance settings.

Parameters:
  - token (Required): Your API authentication token.
  - instance_id (Optional): The ID of the instance to use.
```

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

### UltraMsg API - Get Instance Settings

Source: https://docs.ultramsg.com/api/get/messages/statistics

Retrieves the current settings configured for the WhatsApp instance.

```APIDOC
Endpoint: GET /instance/settings

Description:
Retrieves the current settings configured for the WhatsApp instance.

URL:
https://api.ultramsg.com/{{instance_id}}/instance/settings

Parameters:
- token (Required): Your authentication token.

Example Request:
GET https://api.ultramsg.com/YOUR_INSTANCE_ID/instance/settings?token=YOUR_TOKEN.
```

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

### Get Instance Settings API

Source: https://docs.ultramsg.com/api/post/chats/clearMessages

Retrieves the settings of a WhatsApp instance. Requires instance ID and token.

```APIDOC
GET /{{instance_id}}/instance/settings

Description:
Retrieves the settings of a WhatsApp instance.

Parameters:
- token (Required): Your UltraMsg API token.
- instance_id (Path Parameter): The ID of your UltraMsg instance.

Example Request URL:
https://api.ultramsg.com/{{instance_id}}/instance/settings?token=YOUR_TOKEN
```

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

### Get Instance Settings API

Source: https://docs.ultramsg.com/api/get/chats

Retrieves the current settings of the WhatsApp instance. Requires instance ID and token.

```APIDOC
GET /api/get/instance/settings

Instance ID
Token

Request URL:
https://api.ultramsg.com/{{instance_id}}/instance/settings

Parameters:
| Name  | Type   | Required |
|-------|--------|----------|
| token | string | Yes      |

Example Request:
GET https://api.ultramsg.com/YOUR_INSTANCE_ID/instance/settings?token=YOUR_AUTH_TOKEN
```

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

### Get Instance QR Code

Source: https://docs.ultramsg.com/api/get/groups/ids

Fetches the QR code for instance connection. Requires instance ID and token.

```APIDOC
API Endpoint: GET /instance/qr

Purpose:
  Retrieves the QR code needed to connect your WhatsApp instance.

Parameters:
  token (string, Required): Your API authentication token.
  instance_id (string, Required): The unique identifier for your WhatsApp instance.

Request URL:
  https://api.ultramsg.com/{{instance_id}}/instance/qr

Example Usage:
  GET /instance/qr?token=YOUR_API_TOKEN HTTP/1.1
  Host: api.ultramsg.com

  Note:
    The response will typically be an image or a URL to an image.
```

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

### Instance Status and Settings APIs

Source: https://docs.ultramsg.com/api/post/instance/restart

APIs to retrieve instance status, QR codes, user information, and manage instance settings.

```APIDOC
GET /instance/status
  Retrieves the current status of the WhatsApp instance.

GET /instance/qr
GET /instance/qrCode
  Retrieves the QR code for instance authentication.

GET /instance/me
  Retrieves information about the authenticated user (me).

GET /instance/settings
  Retrieves the current settings of the instance.

POST /instance/settings
  Updates the settings for the WhatsApp instance.

POST /instance/logout
  Logs out the WhatsApp instance.

POST /instance/clear
  Clears instance data and settings.

Notes:
  - All these operations require the instance ID and an authentication token.
  - The QR code endpoints are crucial for initial instance setup and authentication.
```

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

### Get All Groups Info and Participants Example

Source: https://docs.ultramsg.com/api/get/groups

Example of how to retrieve all group information and participant details using the UltraMsg API.

```APIDOC
Request URL:
https://api.ultramsg.com/{{instance_id}}/groups

Parameters:
|  |  |
| --- | --- |
| token *Required | Your UltraMsg API token |

Note: Don't forget to URL encode your query params like base64 or utf-8.
```

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

### Get Chat IDs Example

Source: https://docs.ultramsg.com/api/get/chats/ids

Example of how to retrieve chat IDs, including the 'clear' parameter which may affect chat history.

```APIDOC
GET /chats/ids

Parameters:
  token *Required: Your UltraMsg API token.
  clear *Required: A boolean indicating whether to clear chat history after retrieval.

Example Request URL:
https://api.ultramsg.com/{{instance_id}}/chats/ids?token=YOUR_TOKEN&clear=true

Note: Ensure query parameters are URL encoded.
```

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

### UltraMsg API: Instance Management

Source: https://docs.ultramsg.com/api/get/instance/settings

Endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes, getting instance details, and performing actions like logout, restart, and settings configuration.

```APIDOC
GET /api/get/instance/status
  Get the current status of the instance.

GET /api/get/instance/qr
GET /api/get/instance/qrCode
  Retrieve the QR code for instance connection.

GET /api/get/instance/me
  Get details about the connected instance.

GET /api/get/instance/settings
  Retrieve the current instance settings.
  Parameters:
    token: Required. Authentication token.
  Example Request URL:
    https://api.ultramsg.com/{{instance_id}}/instance/settings
  Example Parameters:
    token: YOUR_API_TOKEN
  Example Request Body/Query Parameters:
    sendDelay: Delay in seconds between sending messages (default 1).
    webhook_url: URL for receiving notifications.
    webhook_message_received: Enable/disable webhook notifications for message received.
    webhook_message_create: Enable/disable webhook notifications for message create.
    webhook_message_ack: Enable/disable webhook notifications for message delivery/view status.
    webhook_message_download_media: Enable/disable receiving media files via webhooks.

POST /api/post/instance/logout
  Log out the current instance.

POST /api/post/instance/restart
  Restart the instance.

POST /api/post/instance/settings
  Update instance settings.
  Parameters:
    token: Required. Authentication token.
    sendDelay: Optional. Delay in seconds between sending messages.
    webhook_url: Optional. Http or https URL for receiving notifications.
    webhook_message_received: Optional. on/off notifications in webhooks when message received.
    webhook_message_create: Optional. on/off notifications in webhooks when message create.
    webhook_message_ack: Optional. on/off ack (message delivered and message viewed) notifications in webhooks.
    webhook_message_download_media: Optional. on/off to get received document / media files.

POST /api/post/instance/clear
  Clear instance data.
```

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

### UltraMsg API Endpoints Overview

Source: https://docs.ultramsg.com/api/post/instance/settings

A comprehensive list of available API endpoints for managing WhatsApp messages, instances, chats, contacts, groups, and media operations.

```APIDOC
Messages API:
  POST /messages/chat
  POST /messages/image
  POST /messages/sticker
  POST /messages/document
  POST /messages/audio
  POST /messages/voice
  POST /messages/video
  POST /messages/contact
  POST /messages/location
  POST /messages/vcard
  POST /messages/reaction
  POST /messages/delete
  POST /messages/resendByStatus
  POST /messages/resendById
  POST /messages/clear
  GET /messages
  GET /messages/statistics

Instance API:
  GET /instance/status
  GET /instance/qr
  GET /instance/qrCode
  GET /instance/me
  GET /instance/settings
  POST /instance/logout
  POST /instance/restart
  POST /instance/settings
  POST /instance/clear

Chats API:
  GET /chats
  GET /chats/ids
  GET /chats/messages
  POST /chats/archive
  POST /chats/unarchive
  POST /chats/clearMessages
  POST /chats/delete
  POST /chats/read

Contacts API:
  POST /contacts/block
  POST /contacts/unblock
  GET /contacts
  GET /contacts/ids
  GET /contacts/contact
  GET /contacts/blocked
  GET /contacts/invalid
  GET /contacts/check
  GET /contacts/image

Groups API:
  GET /groups
  GET /groups/ids
  GET /groups/group

Media API:
  POST /media/upload
  POST /media/delete
  POST /media/deleteByDate
```

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

### Get Contacts List Example

Source: https://docs.ultramsg.com/api/get/contacts

Demonstrates how to retrieve the list of contacts using the UltraMsg API. It specifies the required parameters and the request URL.

```APIDOC
GET /contacts

Request URL:
https://api.ultramsg.com/{{instance_id}}/contacts

Parameters:
  token (string, Required): Your UltraMsg API token.

Note: Ensure query parameters are URL encoded (e.g., base64 or utf-8).
```

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

### UltraMsg API - Instance Management

Source: https://docs.ultramsg.com/api/post/messages/voice

Endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes for connection, fetching instance details, logging out, restarting, and configuring instance settings.

```APIDOC
instance:
  get:
    Status: /api/get/instance/status
    QR: /api/get/instance/qr
    qrCode: /api/get/instance/qrCode
    Me: /api/get/instance/me
    Settings: /api/get/instance/settings
  post:
    Logout: /api/post/instance/logout
    Restart: /api/post/instance/restart
    Settings: /api/post/instance/settings
    Clear: /api/post/instance/clear
```

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

### UltraMsg API: Get Invalid Contacts Example

Source: https://docs.ultramsg.com/api/get/contacts/invalid

Demonstrates how to retrieve a list of invalid contacts from the UltraMsg API. This endpoint requires an instance ID and token, and optionally accepts a 'clear' parameter.

```APIDOC
API Endpoint:
GET https://api.ultramsg.com/{{instance_id}}/contacts/invalid

Description:
Retrieves all invalid contacts associated with the specified instance. The 'clear' parameter can be used to clear the list of invalid contacts after retrieval.

Parameters:
- instance_id (Path Parameter): The unique identifier for your WhatsApp instance.
- token (Query Parameter, Required): Your API authentication token.
- clear (Query Parameter, Optional): If set to 'true', the list of invalid contacts will be cleared after fetching.

Request Sample (URL Encoded):
https://api.ultramsg.com/YOUR_INSTANCE_ID/contacts/invalid?token=YOUR_API_TOKEN&clear=true

Note:
It is recommended to URL encode query parameters, especially if they contain special characters or spaces.
```

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

### UltraMsg API: Contact Unblock Example

Source: https://docs.ultramsg.com/api/post/contacts/unblock

Example of how to unblock a contact using the UltraMsg API. This includes the request URL, required parameters, and a sample request body.

```APIDOC
Request URL:
https://api.ultramsg.com/{{instance_id}}/contacts/unblock

Request Body:
| Parameter | Type   | Required | Description                                    |
|-----------|--------|----------|------------------------------------------------|
| token     | string | Yes      | Your UltraMsg API token.                       |
| chatId    | string | Yes      | The chat ID of the contact to unblock (e.g., "[email protected]"). |

Note: Ensure query parameters are URL encoded (e.g., base64 or utf-8).
```

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

### UltraMsg API: Instance Management

Source: https://docs.ultramsg.com/api/post/instance/clear

Endpoints for retrieving instance status, QR codes, user information, settings, and performing instance operations like logout, restart, and clearing settings.

```APIDOC
GET /instance/status
GET /instance/qr
GET /instance/qrCode
GET /instance/me
GET /instance/settings
POST /instance/logout
POST /instance/restart
POST /instance/settings
POST /instance/clear

These methods allow for comprehensive management and monitoring of WhatsApp instances connected via UltraMsg.
```

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

### Ultramsg API: Instance Management

Source: https://docs.ultramsg.com/index

Endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes, fetching user information, and performing instance operations like logout, restart, and settings updates.

```APIDOC
GET /api/get/instance/status
  Description: Gets the current status of the WhatsApp instance.

GET /api/get/instance/qr
  Description: Retrieves the QR code for instance authentication.

GET /api/get/instance/qrCode
  Description: Retrieves the QR code for instance authentication (alternative endpoint).

GET /api/get/instance/me
  Description: Gets information about the authenticated user/instance.

GET /api/get/instance/settings
  Description: Retrieves the current instance settings.

POST /api/post/instance/logout
  Description: Logs out the current instance.

POST /api/post/instance/restart
  Description: Restarts the WhatsApp instance.

POST /api/post/instance/settings
  Description: Updates instance settings.
  Parameters:
    - webhook: URL for receiving webhooks.
    - webhook_message: Enable/disable message webhooks.
    - webhook_presence: Enable/disable presence webhooks.
    - webhook_state: Enable/disable state webhooks.
    - webhook_auth: Enable/disable webhook authentication.
    - webhook_auth_key: Webhook authentication key.

POST /api/post/instance/clear
  Description: Clears instance data.
```

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

### Send Voice Message Example

Source: https://docs.ultramsg.com/api/post/messages/voice

Example of how to send a voice message using the UltraMsg API. It specifies the required parameters like instance ID, token, recipient ('to'), and the audio file link or base64 data.

```APIDOC
POST /{{instance_id}}/messages/voice

Parameters:
  token (Required): API token.
  to (Required): Phone number with international format (e.g., +1408XXXXXXX) or chatID for contact or group (e.g., [[email protected]] or [[email protected]]). 
  audio (Required): HTTP link to the audio file or base64-encoded file in opus codec. [More info.](https://blog.ultramsg.com/how-to-send-ogg-file-using-whatsapp-api/)

Request URL:
https://api.ultramsg.com/{{instance_id}}/messages/voice

Request Body Example (JSON):
{
  "token": "YOUR_API_TOKEN",
  "to": "+1408XXXXXXX",
  "audio": "HTTP_LINK_TO_AUDIO_OR_BASE64_DATA"
}

Note: URL encode query parameters like base64 or utf-8 when necessary.
```

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

### UltraMsg API: Get Contact Image

Source: https://docs.ultramsg.com/api/get/instance/status

No description

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

### UltraMsg API: Get Messages

Source: https://docs.ultramsg.com/api/post/messages/resendByStatus

Endpoints for retrieving messages and statistics from a WhatsApp instance.

```APIDOC
GET /messages
GET /messages/statistics

These endpoints allow fetching message history and performance statistics for a given WhatsApp instance.

Parameters:
  - token (Required): Authentication token.
  - instance_id (Path Parameter): The ID of the WhatsApp instance.

GET /messages:
  Retrieves a list of messages. May support filtering by status or date.

GET /messages/statistics:
  Retrieves statistics related to message delivery, volume, etc.
```

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

### WhatsApp Instance API

Source: https://docs.ultramsg.com/api/post/chats/unarchive

Endpoints for managing the WhatsApp instance status, QR code generation, user information, and instance settings. Includes methods for logging out, restarting, and clearing instance data.

```APIDOC
GET /instance/status
  - Retrieves the current status of the WhatsApp instance.
  - Parameters:
    - token (Required): Your UltraMsg API token.
  - Returns: Instance status information.

GET /instance/qr
  - Retrieves the QR code for instance connection.
  - Parameters:
    - token (Required): Your UltraMsg API token.
  - Returns: QR code image data.

GET /instance/qrCode
  - Retrieves the QR code for instance connection (alternative endpoint).
  - Parameters:
    - token (Required): Your UltraMsg API token.
  - Returns: QR code image data.

GET /instance/me
  - Retrieves information about the connected WhatsApp account.
  - Parameters:
    - token (Required): Your UltraMsg API token.
  - Returns: User account details.

GET /instance/settings
  - Retrieves the current settings of the WhatsApp instance.
  - Parameters:
    - token (Required): Your UltraMsg API token.
  - Returns: Instance configuration settings.

POST /instance/logout
  - Logs out the current WhatsApp instance.
  - Parameters:
    - token (Required): Your UltraMsg API token.
  - Returns: Confirmation of logout.

POST /instance/restart
  - Restarts the WhatsApp instance.
  - Parameters:
    - token (Required): Your UltraMsg API token.
  - Returns: Confirmation of restart.

POST /instance/settings
  - Updates the settings of the WhatsApp instance.
  - Parameters:
    - token (Required): Your UltraMsg API token.
    - ... (various settings parameters)
  - Returns: Confirmation of settings update.

POST /instance/clear
  - Clears all data associated with the WhatsApp instance.
  - Parameters:
    - token (Required): Your UltraMsg API token.
  - Returns: Confirmation of data clear.
```

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

### UltraMsg Instance API

Source: https://docs.ultramsg.com/api/post/chats/archive

Endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes, logging out, restarting, and configuring settings.

```APIDOC
GET /instance/status
  Retrieves the status of the WhatsApp instance.
  Parameters:
    token (Required): Your API token.

GET /instance/qr
  Retrieves the QR code for instance connection.
  Parameters:
    token (Required): Your API token.

GET /instance/qrCode
  Retrieves the QR code for instance connection.
  Parameters:
    token (Required): Your API token.

GET /instance/me
  Retrieves information about the connected instance.
  Parameters:
    token (Required): Your API token.

GET /instance/settings
  Retrieves the instance settings.
  Parameters:
    token (Required): Your API token.

POST /instance/logout
  Logs out the WhatsApp instance.
  Parameters:
    token (Required): Your API token.

POST /instance/restart
  Restarts the WhatsApp instance.
  Parameters:
    token (Required): Your API token.

POST /instance/settings
  Updates the instance settings.
  Parameters:
    token (Required): Your API token.
    ... (various settings parameters)

POST /instance/clear
  Clears the instance data.
  Parameters:
    token (Required): Your API token.
```

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

### Get Chats API

Source: https://docs.ultramsg.com/api/post/chats/clearMessages

Retrieves a list of all chats. Requires instance ID and token.

```APIDOC
GET /{{instance_id}}/chats

Description:
Retrieves a list of all chats.

Parameters:
- token (Required): Your UltraMsg API token.
- instance_id (Path Parameter): The ID of your UltraMsg instance.

Example Request URL:
https://api.ultramsg.com/{{instance_id}}/chats?token=YOUR_TOKEN
```

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

### Ultramsg Instance API

Source: https://docs.ultramsg.com/api/post/messages/vcard

Manages the WhatsApp instance status, QR code generation, user settings, and instance operations like logout, restart, and clearing data.

```APIDOC
GET /instance/status
  Retrieves the status of the WhatsApp instance.
  Parameters:
    token (string, required): Your API token.

GET /instance/qr
  Retrieves the QR code for instance connection.
  Parameters:
    token (string, required): Your API token.

GET /instance/qrCode
  Retrieves the QR code for instance connection (alternative endpoint).
  Parameters:
    token (string, required): Your API token.

GET /instance/me
  Retrieves information about the connected WhatsApp account.
  Parameters:
    token (string, required): Your API token.

GET /instance/settings
  Retrieves the current instance settings.
  Parameters:
    token (string, required): Your API token.

POST /instance/logout
  Logs out the current WhatsApp instance.
  Parameters:
    token (string, required): Your API token.

POST /instance/restart
  Restarts the WhatsApp instance.
  Parameters:
    token (string, required): Your API token.

POST /instance/settings
  Updates instance settings.
  Parameters:
    token (string, required): Your API token.
    key (string, required): The setting key to update.
    value (string, required): The new value for the setting.

POST /instance/clear
  Clears all data associated with the instance.
  Parameters:
    token (string, required): Your API token.

```

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

### UltraMsg API - Get Chat IDs

Source: https://docs.ultramsg.com/api/get/messages/statistics

Retrieves a list of chat IDs for all conversations.

```APIDOC
Endpoint: GET /chats/ids

Description:
Retrieves a list of chat IDs for all conversations.

URL:
https://api.ultramsg.com/{{instance_id}}/chats/ids

Parameters:
- token (Required): Your authentication token.

Example Request:
GET https://api.ultramsg.com/YOUR_INSTANCE_ID/chats/ids?token=YOUR_TOKEN.
```

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

### UltraMsg API Endpoints Overview

Source: https://docs.ultramsg.com/api/get/instance/qrCode

This section lists the available API endpoints for managing WhatsApp messages, instances, chats, contacts, groups, and media. Each endpoint represents a specific operation that can be performed.

```APIDOC
messages:
  post chat: /api/post/messages/chat
  post image: /api/post/messages/image
  post sticker: /api/post/messages/sticker
  post document: /api/post/messages/document
  post audio: /api/post/messages/audio
  post voice: /api/post/messages/voice
  post video: /api/post/messages/video
  post contact: /api/post/messages/contact
  post location: /api/post/messages/location
  post vcard: /api/post/messages/vcard
  post reaction: /api/post/messages/reaction
  post delete: /api/post/messages/delete
  post resendByStatus: /api/post/messages/resendByStatus
  post resendById: /api/post/messages/resendById
  post clear: /api/post/messages/clear
  get messages: /api/get/messages
  get statistics: /api/get/messages/statistics

instance:
  get Status: /api/get/instance/status
  get QR: /api/get/instance/qr
  get qrCode: /api/get/instance/qrCode
  get Me: /api/get/instance/me
  get Settings: /api/get/instance/settings
  post Logout: /api/post/instance/logout
  post Restart: /api/post/instance/restart
  post Settings: /api/post/instance/settings
  post Clear: /api/post/instance/clear

chats:
  get chats: /api/get/chats
  get ids: /api/get/chats/ids
  get Messages: /api/get/chats/messages
  post archive: /api/post/chats/archive
  post unarchive: /api/post/chats/unarchive
  post clearMessages: /api/post/chats/clearMessages
  post delete: /api/post/chats/delete
  post Read: /api/post/chats/read

contacts:
  post block: /api/post/contacts/block
  post unblock: /api/post/contacts/unblock
  get contacts: /api/get/contacts
  get ids: /api/get/contacts/ids
  get contact: /api/get/contacts/contact
  get blocked: /api/get/contacts/blocked
  get invalid: /api/get/contacts/invalid
  get check: /api/get/contacts/check
  get image: /api/get/contacts/image

groups:
  get groups: /api/get/groups
  get ids: /api/get/groups/ids
  get group: /api/get/groups/group

media:
  post upload: /api/post/media/upload
  post delete: /api/post/media/delete
  post deleteByDate: /api/post/media/deleteByDate
```

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

### UltraMsg API - Get Chats

Source: https://docs.ultramsg.com/api/get/messages/statistics

Retrieves a list of all chats associated with the WhatsApp instance.

```APIDOC
Endpoint: GET /chats

Description:
Retrieves a list of all chats associated with the WhatsApp instance.

URL:
https://api.ultramsg.com/{{instance_id}}/chats

Parameters:
- token (Required): Your authentication token.

Example Request:
GET https://api.ultramsg.com/YOUR_INSTANCE_ID/chats?token=YOUR_TOKEN.
```

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

### UltraMsg API Endpoints Overview

Source: https://docs.ultramsg.com/api/get/instance/qr

Provides a structured list of available API endpoints for managing WhatsApp interactions via UltraMsg. This includes categories for messages, instance, chats, contacts, groups, and media.

```APIDOC
messages:
  post chat: /api/post/messages/chat
  post image: /api/post/messages/image
  post sticker: /api/post/messages/sticker
  post document: /api/post/messages/document
  post audio: /api/post/messages/audio
  post voice: /api/post/messages/voice
  post video: /api/post/messages/video
  post contact: /api/post/messages/contact
  post location: /api/post/messages/location
  post vcard: /api/post/messages/vcard
  post reaction: /api/post/messages/reaction
  post delete: /api/post/messages/delete
  post resendByStatus: /api/post/messages/resendByStatus
  post resendById: /api/post/messages/resendById
  post clear: /api/post/messages/clear
  get messages: /api/get/messages
  get statistics: /api/get/messages/statistics

instance:
  get Status: /api/get/instance/status
  get QR: /api/get/instance/qr
  get qrCode: /api/get/instance/qrCode
  get Me: /api/get/instance/me
  get Settings: /api/get/instance/settings
  post Logout: /api/post/instance/logout
  post Restart: /api/post/instance/restart
  post Settings: /api/post/instance/settings
  post Clear: /api/post/instance/clear

chats:
  get chats: /api/get/chats
  get ids: /api/get/chats/ids
  get Messages: /api/get/chats/messages
  post archive: /api/post/chats/archive
  post unarchive: /api/post/chats/unarchive
  post clearMessages: /api/post/chats/clearMessages
  post delete: /api/post/chats/delete
  post Read: /api/post/chats/read

contacts:
  post block: /api/post/contacts/block
  post unblock: /api/post/contacts/unblock
  get contacts: /api/get/contacts
  get ids: /api/get/contacts/ids
  get contact: /api/get/contacts/contact
  get blocked: /api/get/contacts/blocked
  get invalid: /api/get/contacts/invalid
  get check: /api/get/contacts/check
  get image: /api/get/contacts/image

groups:
  get groups: /api/get/groups
  get ids: /api/get/groups/ids
  get group: /api/get/groups/group

media:
  post upload: /api/post/media/upload
  post delete: /api/post/media/delete
  post deleteByDate: /api/post/media/deleteByDate
```

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

### UltraMsg API: Get Blocked Contacts

Source: https://docs.ultramsg.com/api/get/instance/status

Retrieves a list of all contacts that have been blocked by the instance.

```APIDOC
API Endpoint: /contacts/blocked

HTTP Method: GET

Description: Get blocked contacts.

Parameters:
  - token (Required): Your API authentication token.
  - instance_id (Optional): The ID of the instance to use.
```

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

### UltraMsg API - Instance Management Endpoints

Source: https://docs.ultramsg.com/api/get/instance/me

Endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes, getting instance details, logging out, restarting, and updating settings.

```APIDOC
API Endpoints: Instance Management

Description: Endpoints for managing the connected WhatsApp instance.

GET /api/get/instance/status
  - Get the status of the connected instance.
GET /api/get/instance/qr
  - Retrieve the QR code for instance connection.
GET /api/get/instance/qrCode
  - Retrieve the QR code for instance connection (alias).
GET /api/get/instance/me
  - Get information about the connected phone.
GET /api/get/instance/settings
  - Retrieve instance settings.
POST /api/post/instance/logout
  - Log out the current instance.
POST /api/post/instance/restart
  - Restart the instance.
POST /api/post/instance/settings
  - Update instance settings.
POST /api/post/instance/clear
  - Clear instance data.
```

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

### UltraMsg API: Get Chat IDs

Source: https://docs.ultramsg.com/api/get/instance/status

Retrieves only the IDs of all chats associated with the instance.

```APIDOC
API Endpoint: /chats/ids

HTTP Method: GET

Description: Get all chat IDs.

Parameters:
  - token (Required): Your API authentication token.
  - instance_id (Optional): The ID of the instance to use.
```

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

### UltraMsg Instance API

Source: https://docs.ultramsg.com/api/post/messages/video

Manages the WhatsApp instance, including checking status, retrieving QR codes, managing settings, and performing instance-level actions like logout or restart.

```APIDOC
Instance API:

GET /instance/status
  - Checks the status of the WhatsApp instance.
  - Parameters:
    - token (string, required): Your UltraMsg API token.

GET /instance/qr
GET /instance/qrCode
  - Retrieves the QR code for connecting the WhatsApp instance.
  - Parameters:
    - token (string, required): Your UltraMsg API token.

GET /instance/me
  - Retrieves information about the authenticated user (instance).
  - Parameters:
    - token (string, required): Your UltraMsg API token.

GET /instance/settings
  - Retrieves the current settings of the WhatsApp instance.
  - Parameters:
    - token (string, required): Your UltraMsg API token.

POST /instance/logout
  - Logs out the WhatsApp instance.
  - Parameters:
    - token (string, required): Your UltraMsg API token.

POST /instance/restart
  - Restarts the WhatsApp instance.
  - Parameters:
    - token (string, required): Your UltraMsg API token.

POST /instance/settings
  - Updates the settings of the WhatsApp instance.
  - Parameters:
    - token (string, required): Your UltraMsg API token.
    - key (string, required): The setting key to update.
    - value (string, required): The new value for the setting.

POST /instance/clear
  - Clears all data associated with the WhatsApp instance.
  - Parameters:
    - token (string, required): Your UltraMsg API token.
```

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

### UltraMsg API: Get Invalid Contacts

Source: https://docs.ultramsg.com/api/get/instance/status

Retrieves a list of contacts that are invalid or not on WhatsApp.

```APIDOC
API Endpoint: /contacts/invalid

HTTP Method: GET

Description: Get invalid contacts.

Parameters:
  - token (Required): Your API authentication token.
  - instance_id (Optional): The ID of the instance to use.
```

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

### UltraMsg API - Instance Management

Source: https://docs.ultramsg.com/api/post/messages/audio

API endpoints for managing the UltraMsg instance, including checking status, retrieving QR codes, logging out, restarting, and updating settings.

```APIDOC
GET /instance/status
  Retrieves the current status of the instance.

GET /instance/qr
GET /instance/qrCode
  Retrieves the QR code for instance connection.

GET /instance/me
  Retrieves information about the connected instance.

GET /instance/settings
  Retrieves the current settings of the instance.

POST /instance/logout
  Logs out the instance.

POST /instance/restart
  Restarts the instance.

POST /instance/settings
  Updates the instance settings.

POST /instance/clear
  Clears instance data.
```

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

### Get All Chats API

Source: https://docs.ultramsg.com/api/get/chats

Retrieves a list of all chats. Requires instance ID and token.

```APIDOC
GET /api/get/chats

Instance ID
Token

Request URL:
https://api.ultramsg.com/{{instance_id}}/chats

Parameters:
| Name  | Type   | Required |
|-------|--------|----------|
| token | string | Yes      |

Example Request:
GET https://api.ultramsg.com/YOUR_INSTANCE_ID/chats?token=YOUR_AUTH_TOKEN
```

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

### UltraMsg API: Instance Management

Source: https://docs.ultramsg.com/api/post/messages/reaction

Endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes, getting user information, and performing instance-level actions like logout or restart.

```APIDOC
instance:
  get:
    status: /api/get/instance/status
      description: Retrieves the current status of the WhatsApp instance.
      parameters:
        token: string (Required)
        apitoken: string (Optional)
    qr: /api/get/instance/qr
      description: Retrieves the QR code for instance connection.
      parameters:
        token: string (Required)
        apitoken: string (Optional)
    qrCode: /api/get/instance/qrCode
      description: Retrieves the QR code for instance connection (alias for /qr).
      parameters:
        token: string (Required)
        apitoken: string (Optional)
    me: /api/get/instance/me
      description: Retrieves information about the connected WhatsApp account.
      parameters:
        token: string (Required)
        apitoken: string (Optional)
    settings: /api/get/instance/settings
      description: Retrieves the instance settings.
      parameters:
        token: string (Required)
        apitoken: string (Optional)
  post:
    logout: /api/post/instance/logout
      description: Logs out the current WhatsApp instance.
      parameters:
        token: string (Required)
        apitoken: string (Optional)
    restart: /api/post/instance/restart
      description: Restarts the WhatsApp instance.
      parameters:
        token: string (Required)
        apitoken: string (Optional)
    settings: /api/post/instance/settings
      description: Updates the instance settings.
      parameters:
        token: string (Required)
        key: string (Required) - The setting key to update.
        value: string (Required) - The new value for the setting.
        apitoken: string (Optional)
    clear: /api/post/instance/clear
      description: Clears all data associated with the instance.
      parameters:
        token: string (Required)
        apitoken: string (Optional)

```

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

### UltraMsg API - Get Instance Me

Source: https://docs.ultramsg.com/api/get/messages/statistics

Retrieves information about the authenticated WhatsApp instance, such as its phone number.

```APIDOC
Endpoint: GET /instance/me

Description:
Retrieves information about the authenticated WhatsApp instance.

URL:
https://api.ultramsg.com/{{instance_id}}/instance/me

Parameters:
- token (Required): Your authentication token.

Example Request:
GET https://api.ultramsg.com/YOUR_INSTANCE_ID/instance/me?token=YOUR_TOKEN.
```

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

### Instance Management API

Source: https://docs.ultramsg.com/api/get/messages

Provides endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes, logging out, restarting, and configuring settings.

```APIDOC
GET /instance/status
GET /instance/qr
GET /instance/qrCode
GET /instance/me
GET /instance/settings
POST /instance/logout
POST /instance/restart
POST /instance/settings
POST /instance/clear

These endpoints manage the WhatsApp instance connection and settings.

GET /instance/status:
  Retrieves the current connection status of the instance.

GET /instance/qr or GET /instance/qrCode:
  Retrieves the QR code for connecting the WhatsApp instance.

GET /instance/me:
  Retrieves information about the authenticated instance.

GET /instance/settings:
  Retrieves the current settings for the instance.

POST /instance/logout:
  Logs out the current WhatsApp instance.

POST /instance/restart:
  Restarts the WhatsApp instance.

POST /instance/settings:
  Updates the settings for the instance. Requires specific setting parameters in the request body.

POST /instance/clear:
  Clears data or cache for the instance.

Common Parameters:
  token (string, required): Your API authentication token.

Note:
  - The `instance_id` is part of the URL path for all these endpoints.
```

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

### UltraMsg API: Get Contact IDs

Source: https://docs.ultramsg.com/api/get/instance/status

Retrieves only the WhatsApp IDs of all contacts associated with the instance.

```APIDOC
API Endpoint: /contacts/ids

HTTP Method: GET

Description: Get all contact IDs.

Parameters:
  - token (Required): Your API authentication token.
  - instance_id (Optional): The ID of the instance to use.
```

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

### UltraMsg API - Instance Management

Source: https://docs.ultramsg.com/api/get/chats/messages

Endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes, managing settings, logging out, and restarting the instance.

```APIDOC
API Category: Instance

Endpoints:
- GET /instance/status: Get the current status of the instance.
- GET /instance/qr: Retrieve the QR code for instance connection.
- GET /instance/qrCode: Alias for retrieving the QR code.
- GET /instance/me: Get information about the connected instance.
- GET /instance/settings: Retrieve instance settings.
- POST /instance/logout: Log out the current instance.
- POST /instance/restart: Restart the instance.
- POST /instance/settings: Update instance settings.
- POST /instance/clear: Clear instance data.
```

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

### UltraMsg API - Instance Management

Source: https://docs.ultramsg.com/api/post/messages/contact

This section covers API endpoints for managing WhatsApp instances, including checking status, retrieving QR codes, fetching user information, managing settings, logging out, restarting, and clearing instance data.

```APIDOC
Instance Management Endpoints:

GET /instance/status
  Retrieves the current status of the instance.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/status
  Parameters: token (Required)

GET /instance/qr
  Retrieves the QR code for instance authentication.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/qr
  Parameters: token (Required)

GET /instance/qrCode
  Alias for /instance/qr.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/qrCode
  Parameters: token (Required)

GET /instance/me
  Retrieves information about the authenticated user/instance.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/me
  Parameters: token (Required)

GET /instance/settings
  Retrieves the current settings of the instance.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/settings
  Parameters: token (Required)

POST /instance/logout
  Logs out the current instance.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/logout
  Parameters: token (Required)

POST /instance/restart
  Restarts the instance.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/restart
  Parameters: token (Required)

POST /instance/settings
  Updates the instance settings.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/settings
  Parameters: token (Required), settings_key (Required), settings_value (Required)

POST /instance/clear
  Clears all data associated with the instance.
  URL: https://api.ultramsg.com/{{instance_id}}/instance/clear
  Parameters: token (Required)
```

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

### APIDOC: UltraMsg Instance Management API Endpoints

Source: https://docs.ultramsg.com/api/post/messages/clear

Details API endpoints for managing the WhatsApp instance status and settings. This includes checking instance status, retrieving QR codes, logging out, restarting, and configuring instance settings.

```APIDOC
instance:
  + get Status: /api/get/instance/status
  + get QR: /api/get/instance/qr
  + get qrCode: /api/get/instance/qrCode
  + get Me: /api/get/instance/me
  + get Settings: /api/get/instance/settings
  + post Logout: /api/post/instance/logout
  + post Restart: /api/post/instance/restart
  + post Settings: /api/post/instance/settings
  + post Clear: /api/post/instance/clear
```

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

### Get All Chats

Source: https://docs.ultramsg.com/api/get/groups/ids

Retrieves a list of all chats associated with the instance. Requires instance ID and token.

```APIDOC
API Endpoint: GET /chats

Purpose:
  Fetches a list of all conversations (chats) on the WhatsApp instance.

Parameters:
  token (string, Required): Your API authentication token.
  instance_id (string, Required): The unique identifier for your WhatsApp instance.

Request URL:
  https://api.ultramsg.com/{{instance_id}}/chats

Example Usage:
  GET /chats?token=YOUR_API_TOKEN HTTP/1.1
  Host: api.ultramsg.com
```

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

### UltraMsg API: Instance Management Endpoints

Source: https://docs.ultramsg.com/api/post/messages/image

API endpoints for managing the WhatsApp instance, including checking status, retrieving QR codes, logging out, restarting, and configuring instance settings.

```APIDOC
GET /instance/status
GET /instance/qr
GET /instance/qrCode
GET /instance/me
GET /instance/settings
POST /instance/logout
POST /instance/restart
POST /instance/settings
POST /instance/clear

Description:
Manages the WhatsApp instance connection and settings. Endpoints allow checking connection status, obtaining QR codes for authentication, retrieving instance information, logging out, restarting the instance, updating settings, and clearing instance data.

Common Parameters for POST requests:
- token (string, Required): Your UltraMsg API token.

GET /instance/qr & GET /instance/qrCode:
Both endpoints are used to retrieve the QR code for WhatsApp Web authentication. The QR code is typically returned as a base64 encoded string or an image URL.

POST /instance/settings:
Allows updating instance-specific settings. Requires a 'settings' parameter which is a JSON object containing the configuration options to modify.
```

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

### Get Instance Me API

Source: https://docs.ultramsg.com/api/post/chats/clearMessages

Retrieves information about the connected WhatsApp account. Requires instance ID and token.

```APIDOC
GET /{{instance_id}}/instance/me

Description:
Retrieves information about the connected WhatsApp account.

Parameters:
- token (Required): Your UltraMsg API token.
- instance_id (Path Parameter): The ID of your UltraMsg instance.

Example Request URL:
https://api.ultramsg.com/{{instance_id}}/instance/me?token=YOUR_TOKEN
```
Tokens:
Raw