WhatsApp API

https://whapi.readme.io/reference
Admin
A comprehensive API for developers to programmatically manage WhatsApp accounts, send and receive...
Tokens:97,530
Snippets:1,014
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### cURL request to get products

Source: https://whapi.readme.io/reference/getproducts

Example cURL request to retrieve products from a WhatsApp Business catalog. Uses the GET method with the count query parameter set to 100 and an accept header for JSON.

```shell
curl --request GET \
     --url 'https://gate.whapi.cloud/business/products?count=100' \
     --header 'accept: application/json'
```

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

### GET /business/products/{ProductID}

Source: https://whapi.readme.io/reference/getproduct

Retrieves a product by its ID. The product ID must match the specified pattern and is required.

```APIDOC
## GET /business/products/{ProductID}

### Description
Retrieves a product by its ID from the WhatsApp Business catalog.

### Method
GET

### Endpoint
https://gate.whapi.cloud/business/products/{ProductID}

### Parameters
#### Path Parameters
- **ProductID** (string) - Required - Product ID. Must match pattern `^([\d]{10,18})?$`.

### Request Example
```
curl --request GET \
     --url https://gate.whapi.cloud/business/products/ \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **400** - Wrong request parameters
- **401** - Need channel authorization for getting products
- **404** - Specified product not found
- **500** - Internal Error

```

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

### GET /business/products

Source: https://whapi.readme.io/reference/getproducts

Retrieves the products from a WhatsApp Business catalog. Supports pagination with count and offset parameters.

```APIDOC
## GET /business/products

### Description
With this method you will be able to get the products from a Whatsapp Business catalog.

### Method
GET

### Endpoint
https://gate.whapi.cloud/business/products

### Parameters
#### Query Parameters
- **count** (number) - Optional - Count of objects to return. Range: 1 to 500. Defaults to 100.
- **offset** (number) - Optional - Offset of objects to return. Must be ≥ 0.

### Request Example
```
curl --request GET \
     --url 'https://gate.whapi.cloud/business/products?count=100' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Response Example
(No example provided in source)

### Error Responses
- **400** - Wrong request parameters
- **401** - Need channel authorization for getting products
- **429** - Too many requests
- **500** - Internal Error
```

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

### GET /health

Source: https://whapi.readme.io/reference/checkhealth

This snippet documents the GET /health endpoint for checking and launching the WhatsApp channel instance.

```APIDOC
## [GET] /health

### Description
Allows you to track and get feedback on the operational status of the whapi channel (instance). An instance is a connection with a phone number that has a WhatsApp account, which will be responsible for sending and receiving messages.

### Method
GET

### Endpoint
https://gate.whapi.cloud/health

### Parameters
#### Query Parameters
- **wakeup** (boolean) - Optional - Defaults to true. If set to false, the channel will not launch.
- **platform** (string) - Optional - Browser name, OS name, OS version separated by commas. Example: 'Safari,Windows,10.0.19044' or 'Desktop,Mac OS,11.6.3'.
- **channel_type** (string) - Optional - Defaults to web. Channel type. Web - for linking existing WA account via WA Web, Mobile - for creating new WA account. Allowed: `web`, `mobile`.

### Request Example
```
curl --request GET \
     --url 'https://gate.whapi.cloud/health?wakeup=true&channel_type=web' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Error Response (500)
Internal Error
```

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

### cURL Request for sending audio

Source: https://whapi.readme.io/reference/sendmessageaudio

A cURL command example demonstrating how to send an audio message to the Whapi API.

```Shell
curl --request POST \
     --url https://gate.whapi.cloud/messages/audio \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "background_color": "#00000000"
}
'
```

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

### cURL request to get business profile

Source: https://whapi.readme.io/reference/getbusinessprofile

Sends a GET request to https://gate.whapi.cloud/business to retrieve the WhatsApp Business profile. Requires channel authorization; returns 200 with the profile, 400 for wrong parameters, 401 if authorization is missing, or 500 on internal error.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/business \
```

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

### cURL request to get media files

Source: https://whapi.readme.io/reference/getmediafiles

Use this cURL command to call the GET /media endpoint. It requests up to 100 media files (default count) and expects a JSON response. The URL includes the count query parameter set to 100.

```shell
curl --request GET \
     --url 'https://gate.whapi.cloud/media?count=100' \
     --header 'accept: application/json'
```

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

### GET /groups/{GroupID}/icon - Get group icon

Source: https://whapi.readme.io/reference/getgroupicon

Returns the profile image of a group. Requires a valid GroupID matching the pattern ^[\d-]{10,31}@g\.us$ and an accept header of application/json or image/png. Returns 204 if the group icon is not set, 401 if channel authorization is missing, 403 for insufficient permissions, and 404 if the group is not found.

```http
get
https://gate.whapi.cloud/groups/{GroupID}/icon
```

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

### cURL request to get profile

Source: https://whapi.readme.io/reference/getcontactprofile

Sends a GET request to the profile endpoint with an accept header. The ContactID is empty in the URL, so replace it with a valid contact ID.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/contacts//profile \
     --header 'accept: application/json'
```

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

### cURL Request for Login user with QR-image

Source: https://whapi.readme.io/reference/loginuserimage

A GET request to the login image endpoint with the wakeup parameter set to true.

```shell
curl --request GET \
```

```shell
     --url 'https://gate.whapi.cloud/users/login/image?wakeup=true' \
```

```shell
     --header 'accept: application/json'
```

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

### GET /newsletters/recommended

Source: https://whapi.readme.io/reference/recommendednewsletter

Retrieves recommended WhatsApp newsletters by country. Supports pagination with cursor and count parameters.

```APIDOC
## GET /newsletters/recommended

### Description
Returns a list of WhatsApp Channels data based on the search performed using filters provided in the request body.

### Method
GET

### Endpoint
https://gate.whapi.cloud/newsletters/recommended

### Parameters
#### Query Parameters
- **country_code** (string) - Required - Country for search
- **cursor** (string) - Optional - Cursor to continue pagination
- **count** (number) - Optional - Count of objects to return, 1 to 500, defaults to 100

### Request Example
```
curl --request GET \
     --url 'https://gate.whapi.cloud/newsletters/recommended?count=100' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **400** - Wrong request parameters
- **404** - Specified newsletter not found
- **500** - Internal Error
```

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

### cURL request to create a product

Source: https://whapi.readme.io/reference/createproduct

Sends a POST request to https://gate.whapi.cloud/business/products with a JSON body containing the required currency parameter. The example uses 'USD' as the currency and includes the necessary headers for JSON content.

```shell
curl --request POST \
     --url https://gate.whapi.cloud/business/products \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"currency":"USD"}'
```

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

### cURL request to get new chat limit

Source: https://whapi.readme.io/reference/getnewchatlimit

Use this cURL command to call the GET endpoint. It requires the accept header set to application/json. The endpoint returns the current account limit for starting new individual chats.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/business/limits/new_chat \
     --header 'accept: application/json'
```

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

### cURL request to send a product

Source: https://whapi.readme.io/reference/sendproduct

A cURL command example for sending a product using the POST method to the specified business products endpoint.

```shell
curl --request POST \
     --url https://gate.whapi.cloud/business/products/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

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

### GET /business/limits/reachout_timelock

Source: https://whapi.readme.io/reference/getreachouttimelock

Returns whether the current account is temporarily limited from starting chats. This endpoint is used to check the reachout timelock status.

```APIDOC
## GET /business/limits/reachout_timelock

### Description
Returns whether the current account is temporarily limited from starting chats.

### Method
GET

### Endpoint
https://gate.whapi.cloud/business/limits/reachout_timelock

### Parameters
None

### Request Example
```
curl --request GET \
     --url https://gate.whapi.cloud/business/limits/reachout_timelock \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Response Example
(No example provided)

#### Error Responses
- **401** - Need channel authorization
- **500** - Internal Error
```

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

### POST /business/products

Source: https://whapi.readme.io/reference/createproduct

Registers a product in your catalog. Requires a request body with product details including currency, images, name, description, and price.

```APIDOC
## POST /business/products

### Description
Registers a product in your catalog.

### Method
POST

### Endpoint
https://gate.whapi.cloud/business/products

### Parameters
#### Request Body
- **product_retailer_id** (string) - Optional - Product Retailer ID
- **currency** (string) - Required - Currency (enum: USD, EUR, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL)
- **images** (array) - Required - Product images urls (length between 1 and 10)
  - **images*** (object) - Required - Media with upload from URL, Media with upload from base64, or Media without upload
- **availability** (string) - Optional - Product availability (enum: in stock, out of stock)
- **name** (string) - Required - Product name
- **url** (string) - Optional - Product url
- **description** (string) - Required - Product description
- **price** (number) - Required - Product price (>= 0)
- **is_hidden** (boolean) - Optional - Product is hidden

### Request Example
```json
{
  "currency": "USD"
}
```

### Response
#### Success Response (200)
OK

#### Response Example
(No example provided)

### Error Responses
- **400** - Wrong request parameters
- **401** - Need channel authorization for create product
- **429** - Too many requests
- **500** - Internal Error
```

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

### GET /business/limits/new_chat

Source: https://whapi.readme.io/reference/getnewchatlimit

Returns the current account limit for starting new individual chats. This endpoint requires authentication and returns the limit information.

```APIDOC
## GET /business/limits/new_chat

### Description
Returns the current account limit for starting new individual chats.

### Method
GET

### Endpoint
https://gate.whapi.cloud/business/limits/new_chat

### Parameters
No parameters are documented.

### Request Example
No request body is required.

### Response
#### Success Response (200)
OK

#### Response Example
No response example is provided.

#### Error Responses
- **401** - Need channel authorization
- **500** - Internal Error
```

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

### Get contact about with cURL

Source: https://whapi.readme.io/reference/getcontactabout

Sends a GET request to the Whapi Cloud API to retrieve the About text of a WhatsApp contact. The ContactID path parameter is empty in the example, so you must replace it with a valid contact ID or phone number. Requires a Bearer token for authorization.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/contacts//about \
     --header 'accept: application/json'
```

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

### cURL request to find newsletters by filters

Source: https://whapi.readme.io/reference/findnewsletter

Sends a GET request to the newsletters/find endpoint with a count query parameter. The request includes an accept header for JSON. The response is not shown in the example.

```shell
curl --request GET \
     --url 'https://gate.whapi.cloud/newsletters/find?count=100' \
     --header 'accept: application/json'
```

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

### cURL request to get product

Source: https://whapi.readme.io/reference/getproduct

Use this cURL command to fetch a product by its ID. The ProductID path parameter is required and must match the pattern ^([\d]{10,18})?$. The request returns a 200 OK response on success, or 400, 401, 404, 500 on errors.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/business/products/ \
     --header 'accept: application/json'
```

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

### cURL request to get reachout timelock status

Source: https://whapi.readme.io/reference/getreachouttimelock

Use this cURL command to check if the current account is temporarily limited from starting chats. The endpoint is https://gate.whapi.cloud/business/limits/reachout_timelock and requires an 'accept: application/json' header.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/business/limits/reachout_timelock \
     --header 'accept: application/json'
```

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

### GET /users/login

Source: https://whapi.readme.io/reference/loginuser

This endpoint returns a QR code as a base64 image for user authentication. It accepts query parameters to control the wakeup behavior and QR code appearance.

```APIDOC
## GET /users/login

### Description
This method returns an image of the type base64. You can render this in a component of the type image that is compatible with the language that you use to program. Just like on WhatsApp Web you will need to read a QR code to connect to Whapi.Cloud.

### Method
GET

### Endpoint
https://gate.whapi.cloud/users/login

### Parameters
#### Query Parameters
- **wakeup** (boolean) - Optional - Defaults to true. If set to false, the channel will not launch.
- **size** (number) - Optional - Size of QR-code.
- **width** (number) - Optional - Width of result image.
- **height** (number) - Optional - Height of result image.
- **color_light** (string) - Optional - Background color.
- **color_dark** (string) - Optional - Color of code.

### Request Example
```
curl --request GET \
     --url 'https://gate.whapi.cloud/users/login?wakeup=true' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Response Example
(Not provided in source)

### Error Responses
- **406** - Not acceptable for mobile type channel
- **409** - Channel already authenticated
- **422** - Render QR failed
- **500** - Internal Error
```

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

### GET /users/profile

Source: https://whapi.readme.io/reference/getuserprofile

Retrieves information about your WhatsApp profile. Use this endpoint to get profile details such as name, about, and other settings.

```APIDOC
## [GET] /users/profile

### Description
Retrieves information about your WhatsApp profile.

### Method
GET

### Endpoint
https://gate.whapi.cloud/users/profile

### Parameters
None documented.

### Request Example
curl --request GET \
     --url https://gate.whapi.cloud/users/profile \
     --header 'accept: application/json'

### Response
#### Success Response (200)
No response schema documented.

#### Response Example
No response example provided.

### Error Handling
- 500 Internal Error
```

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

### cURL request for Get channel settings

Source: https://whapi.readme.io/reference/getchannelsettings

A cURL command to perform a GET request to the channel settings endpoint.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/settings \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

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

### cURL request to create a business collection

Source: https://whapi.readme.io/reference/createcollection

Use this cURL command to create a business collection. It sends a POST request to https://gate.whapi.cloud/business/collections with JSON body {"products":[]}. The request requires authentication (Bearer token) and content-type application/json.

```shell
curl --request POST \
     --url https://gate.whapi.cloud/business/collections \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"products":[]}'
```

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

### POST /messages/media/{MediaMessageType}

Source: https://whapi.readme.io/reference/sendmediamessage

Sends a media file as a WhatsApp message. The media type is specified in the path parameter, and the file is uploaded in the request body.

```APIDOC
## POST /messages/media/{MediaMessageType}

### Description
Sends a media file (image, video, gif, audio, voice, document, sticker) as a WhatsApp message. The media type is specified in the path, and the file is uploaded in the request body.

### Method
POST

### Endpoint
https://gate.whapi.cloud/messages/media/{MediaMessageType}

### Parameters
#### Path Parameters
- **MediaMessageType** (string, enum) - Required - Media message type. Allowed values: `image`, `video`, `gif`, `audio`, `voice`, `document`, `sticker`.

#### Query Parameters
- **SendParams** (object) - Required - Send sender parameters via query.

#### Request Body
The request body is the media file to upload. Supported content types include: `application/pdf`, `application/msword`, `application/vnd.ms-powerpoint`, `application/vnd.ms-excel`, `text/plain`, `image/jpeg`, `image/png`, `audio/acc`, `audio/mp4`, `audio/amr`, `audio/mpeg`, `audio/ogg; codecs=opus`, `video/mp4`, `application/json`.

- **no_encode** (boolean) - Optional - Do not use our encoding. Default: `false`.
- **media** (object) - Optional - Media with upload from file, URL, or base64.

### Request Example
```
curl --request POST \
     --url https://gate.whapi.cloud/messages/media/image \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

### Response
#### Success Response (200)
Created.

#### Error Responses
- **400** - Wrong request parameters
- **401** - Need channel authorization for send message
- **402** - Trial version limit exceeded
- **404** - Media with specified id not found
- **413** - Request media too large
- **415** - Unsupported media type
- **429** - Too many requests
- **500** - Internal Error

```

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

### cURL request to get blacklist

Source: https://whapi.readme.io/reference/getblacklist

A cURL command to retrieve the blacklist from the WhatsApp API using the GET method.

```Shell
curl --request GET \
```

```Shell
     --url https://gate.whapi.cloud/blacklist \
```

```Shell
     --header 'accept: application/json'
```

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

### GET /users/login/image

Source: https://whapi.readme.io/reference/loginuserimage

Returns a QR code image for user login. Use the query parameters to control wakeup behavior, QR code size, colors, and image dimensions.

```APIDOC
## GET /users/login/image

### Description
Returns a QR code image that can be used to connect a WhatsApp user to Whapi.Cloud, similar to WhatsApp Web. The image can be customized with various parameters.

### Method
GET

### Endpoint
https://gate.whapi.cloud/users/login/image

### Parameters
#### Query Parameters
- **wakeup** (boolean) - Optional - Defaults to true. If set to false, the channel will not launch.
- **size** (number) - Optional - Size of QR-code.
- **width** (number) - Optional - Width of result image.
- **height** (number) - Optional - Height of result image.
- **color_light** (string) - Optional - Background color.
- **color_dark** (string) - Optional - Color of code.

#### Headers
- **accept** (string) - Optional - Defaults to application/json. Allowed values: application/json, image/png.

### Request Example
```
curl --request GET \
     --url 'https://gate.whapi.cloud/users/login/image?wakeup=true' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns the QR code image in the format specified by the accept header (image/png or application/json).

#### Response Example
(Image content)

#### Error Response (500)
Internal Error.

```

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

### cURL request to get communities

Source: https://whapi.readme.io/reference/communities

Sends a GET request to the communities endpoint with a count of 100. Requires a bearer token for authentication.

```shell
curl --request GET \
     --url 'https://gate.whapi.cloud/communities?count=100' \
     --header 'accept: application/json'
```

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

### cURL request to create a call event

Source: https://whapi.readme.io/reference/calls

Use this cURL command to create a call event. It sends a POST request to https://gate.whapi.cloud/calls with an empty JSON body. The start_time parameter is required in the body.

```shell
curl --request POST \
     --url https://gate.whapi.cloud/calls \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

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

### cURL Request for Get group

Source: https://whapi.readme.io/reference/getgroup

A cURL request to retrieve group metadata. The request uses the GET method and accepts JSON responses.

```shell
curl --request GET \
```

```shell
     --url 'https://gate.whapi.cloud/groups/?resync=false' \
```

```shell
     --header 'accept: application/json'
```

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

### GET /business/{ContactID}/products

Source: https://whapi.readme.io/reference/getcontactproducts

Fetches the product catalog for a specified contact ID. Requires channel authorization and supports pagination.

```APIDOC
## [GET] /business/{ContactID}/products

### Description
This method allows you to get the catalog and products by Chat ID, even if it is not in your contact list.

### Method
GET

### Endpoint
https://gate.whapi.cloud/business/{ContactID}/products

### Parameters
#### Path Parameters
- **ContactID** (string) - Required - Contact ID. Must match pattern `^([\d]{7,15})?(@lid|@s.whatsapp.net)?$`

#### Query Parameters
- **count** (number) - Optional - Count of objects to return. Range: 1 to 500. Defaults to 100.
- **offset** (number) - Optional - Offset of objects to return. Must be ≥ 0.

### Request Example
```
curl --request GET \
     --url 'https://gate.whapi.cloud/business//products?count=100' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **400** - Wrong request parameters
- **401** - Need channel authorization for getting products
- **404** - Specified user not found
- **500** - Internal Error

```

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

### cURL request to get groups

Source: https://whapi.readme.io/reference/getgroups

Sends a GET request to the /groups endpoint with a count parameter and an accept header. The response is a list of groups.

```shell
curl --request GET \
     --url 'https://gate.whapi.cloud/groups?count=100' \
     --header 'accept: application/json'
```

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

### cURL request to create a community

Source: https://whapi.readme.io/reference/createcommunity

Sends a POST request to https://gate.whapi.cloud/communities with an empty JSON body. Requires a Bearer token for authorization. The response will be 200 on success, 400 for wrong parameters, 401 if channel authorization is missing, or 500 for internal errors.

```shell
curl --request POST \
     --url https://gate.whapi.cloud/communities \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

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

### POST /calls/group_link

Source: https://whapi.readme.io/reference/creategroupcalllink

Creates a link for starting a group video call. The request can include an optional start time in UNIX timestamp seconds.

```APIDOC
## POST /calls/group_link

### Description
Creates a link for starting a group video call.

### Method
POST

### Endpoint
https://gate.whapi.cloud/calls/group_link

### Parameters
#### Body Params
- **start_time** (string) - Required - Optional start time of the call in UNIX timestamp seconds

### Request Example
```
curl --request POST \
     --url https://gate.whapi.cloud/calls/group_link \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **400** - Wrong request parameters
- **401** - Need channel authorization for create call link
- **500** - Internal Error
```

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

### cURL request to get collection products

Source: https://whapi.readme.io/reference/getcollectionproductlist

Use this cURL command to fetch products from a collection. The CollectionID path parameter is required, and the products_count query parameter defaults to 10. The request must include an accept: application/json header.

```shell
curl --request GET \
     --url 'https://gate.whapi.cloud/business/collections//products?products_count=10' \
     --header 'accept: application/json'
```

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

### GET /contacts/lids/{ContactID}

Source: https://whapi.readme.io/reference/getlidbyid

Retrieves the Linked ID (LID) for a single user. Provide the Contact ID as a path parameter to get the LID information.

```APIDOC
## [GET] /contacts/lids/{ContactID}

### Description
Retrieve Linked ID (LID) for a single user.

### Method
GET

### Endpoint
https://gate.whapi.cloud/contacts/lids/{ContactID}

### Parameters
#### Path Parameters
- **ContactID** (string) - Required - Contact ID. Must match pattern: `^([\d]{7,15})?(@lid|@s.whatsapp.net)?$`

### Request Example
```
curl --request GET \
     --url https://gate.whapi.cloud/contacts/lids/ \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
User LID information

#### Error Responses
- **401** - Need channel authorization
- **402** - Trial version limit exceeded
- **404** - User not found
- **500** - Internal Error

```

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

### POST /calls

Source: https://whapi.readme.io/reference/calls

Creates a call event. Requires a start time in UNIX timestamp format. Returns success or error responses.

```APIDOC
## [POST] /calls

### Description
This method is responsible for creating a call event.

### Method
POST

### Endpoint
https://gate.whapi.cloud/calls

### Parameters
#### Body Params
- **start_time** (string) - Required - Start time of the call in UNIX timestamp format (in seconds)

### Request Example
```
curl --request POST \
     --url https://gate.whapi.cloud/calls \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

### Response
#### Success Response (200)
Internal Error

#### Error Response (400)
Wrong request parameters

#### Error Response (401)
Need channel authorization for create call event

#### Error Response (500)
Internal Error
```

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

### cURL Request for Get messages

Source: https://whapi.readme.io/reference/getmessages

A cURL command to retrieve a list of messages from the WhatsApp API. The request uses the GET method and accepts JSON responses.

```shell
curl --request GET \
     --url 'https://gate.whapi.cloud/messages/list?count=100' \
     --header 'accept: application/json'
```

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

### cURL request to get objects associated with label

Source: https://whapi.readme.io/reference/getlabelassociations

A cURL command to perform a GET request to the labels endpoint. Replace the URL path with the specific LabelID.

```shell
curl --request GET \
```

```shell
     --url https://gate.whapi.cloud/labels/ \
```

```shell
     --header 'accept: application/json'
```

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

### GET /settings

Source: https://whapi.readme.io/reference/getchannelsettings

Retrieves the current settings for the WhatsApp channel. This endpoint does not require any parameters and returns the settings in the response body.

```APIDOC
## GET /settings

### Description
Retrieves the current settings for the WhatsApp channel.

### Method
GET

### Endpoint
https://gate.whapi.cloud/settings

### Parameters
None

### Request Example
```
curl --request GET \
     --url https://gate.whapi.cloud/settings \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

### Response
#### Success Response (200)
Returns the current channel settings in JSON format.

#### Response Example
(No example provided in the source)

#### Error Response (500)
Internal Error - An unexpected error occurred on the server.

```

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

### POST /presences/{EntryID}

Source: https://whapi.readme.io/reference/subscribepresence

Starts tracking presence updates for a contact or group. Requires the EntryID path parameter and returns a 200 OK on success.

```APIDOC
## POST /presences/{EntryID}

### Description
Starts tracking presence updates for a contact or group so its latest status and last-seen time can be retrieved.

### Method
POST

### Endpoint
https://gate.whapi.cloud/presences/{EntryID}

### Parameters
#### Path Parameters
- **EntryID** (string) - Required - Contact or group id. Must match pattern `^([\d]{7,15})?(@lid|@s.whatsapp.net)?$`.

### Request Example
```
curl --request POST \
     --url https://gate.whapi.cloud/presences/ \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **400** - Wrong request parameters
- **401** - Need channel authorization to subscribe to presence
- **402** - Trial version limit exceeded
- **404** - Specified contact not found in whatsapp
- **409** - Specified contact presence already subscribed
- **500** - Internal Error

```

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

### cURL Request for Get message or story view statuses

Source: https://whapi.readme.io/reference/getmessageviewstatuses

A cURL command to perform a GET request to the statuses endpoint. Replace the URL path with the specific MessageID.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/statuses/ \
     --header 'accept: application/json'
```

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

### GET /media

Source: https://whapi.readme.io/reference/getmediafiles

Retrieves all media files for the authenticated user. Supports query parameters for pagination, time filtering, and sorting.

```APIDOC
## GET /media

### Description
This method is responsible for returning all of your media files.

### Method
GET

### Endpoint
https://gate.whapi.cloud/media

### Parameters
#### Query Parameters
- **count** (number) - Optional - Count of objects to return. Defaults to 100. Valid range: 1 to 500.
- **offset** (number) - Optional - Offset of objects to return. Must be >= 0.
- **time_from** (number) - Optional - Timestamp from which to get objects.
- **time_to** (number) - Optional - Timestamp up to which to get objects.
- **sort** (string) - Optional - Order for items in request. Allowed values: asc, desc.

### Request Example
```
curl --request GET \
     --url 'https://gate.whapi.cloud/media?count=100' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **400** - Wrong request parameters
- **500** - Internal Error
```

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

### cURL Request to Get User Profile

Source: https://whapi.readme.io/reference/getuserprofile

Use this cURL command to fetch the WhatsApp profile information. The request is a GET to https://gate.whapi.cloud/users/profile with an accept header of application/json.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/users/profile \
     --header 'accept: application/json'
```

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

### GET /users/login

Source: https://whapi.readme.io/reference/users

Retrieves a base64-encoded QR code image for user authentication. Use this to display a QR code in your application for scanning with WhatsApp.

```APIDOC
## [GET] /users/login

### Description
This method returns an image of the type base64. You can render this in a component of the type image that is compatible with the language that you use to program. Just like on WhatsApp Web you will need to read a QR code to connect to Whapi.Cloud.

### Method
GET

### Endpoint
https://gate.whapi.cloud/users/login

### Parameters
#### Query Parameters
- **wakeup** (boolean) - Optional - Defaults to true. If set to false, the channel will not launch.
- **size** (number) - Optional - Size of QR-code.
- **width** (number) - Optional - Width of result image.
- **height** (number) - Optional - Height of result image.
- **color_light** (string) - Optional - Background color.
- **color_dark** (string) - Optional - Color of code.

### Request Example
```
curl --request GET \
     --url 'https://gate.whapi.cloud/users/login?wakeup=true' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Response Example
(Not provided in source)

#### Error Responses
- **406** - Not acceptable for mobile type channel
- **409** - Channel already authenticated
- **422** - Render QR failed
- **500** - Internal Error
```

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

### Send story audio message with curl

Source: https://whapi.readme.io/reference/sendmessagestoryaudio

POST to https://gate.whapi.cloud/messages/story/audio to send an audio status. The media parameter is required and can be a preuploaded file or uploaded on the fly; statuses disappear after 24 hours.

```bash
curl --request POST \
  --url https://gate.whapi.cloud/messages/story/audio \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'authorization: Bearer YOUR_TOKEN' \
  --data '{
  
```

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

### cURL request to get products by Contact ID

Source: https://whapi.readme.io/reference/getcontactproducts

A cURL command to perform a GET request to the products endpoint. Note that the ContactID placeholder in the URL must be replaced with the actual ID.

```shell
curl --request GET \
```

```shell
     --url 'https://gate.whapi.cloud/business//products?count=100' \
```

```shell
     --header 'accept: application/json'
```

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

### cURL request to send poll message

Source: https://whapi.readme.io/reference/sendmessagepoll

Example cURL command to send a poll message. The request body is empty in the example; you need to provide the required parameters (to, title, options) in the JSON data.

```shell
curl --request POST \
     --url https://gate.whapi.cloud/messages/poll \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

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

### cURL request for Login user with QR-rowdata

Source: https://whapi.readme.io/reference/loginuserrowdata

Use this cURL command to call the login endpoint. The 'wakeup' query parameter defaults to true; set to false to prevent the channel from launching. The request expects an 'accept: application/json' header.

```shell
curl --request GET \
     --url 'https://gate.whapi.cloud/users/login/rowdata?wakeup=true' \
     --header 'accept: application/json'
```

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

### cURL request to get account username

Source: https://whapi.readme.io/reference/getusername

Use this cURL command to retrieve the username for the current WhatsApp account. The request is a GET to https://gate.whapi.cloud/users/username with an accept header for JSON. Requires channel authorization (Bearer token).

```shell
curl --request GET \
     --url https://gate.whapi.cloud/users/username \
     --header 'accept: application/json'
```

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

### POST /groups/{GroupID}/applications

Source: https://whapi.readme.io/reference/approvegroupapplicationslist

Accepts a single join request (application) for the specified group. To accept multiple applications, call this method in a loop, passing each application ID separately.

```APIDOC
## [POST] /groups/{GroupID}/applications

### Description
Accepts a single join request (application) for the specified group. To accept multiple applications, call this method in a loop, passing each application ID separately.

### Method
POST

### Endpoint
https://gate.whapi.cloud/groups/{GroupID}/applications

### Parameters
#### Path Parameters
- **GroupID** (string) - Required - Group ID. Must match pattern `^[\d-]{10,31}@g\.us$`.

#### Request Body
- **application** (string) - Required - Chat ID of the application. Must match pattern `^(?:0@(?:c\.us|s\.whatsapp\.net)|[\d-]{10,31}@[\w\.]{1,})$`.

### Request Example
```json
{
  "application": "1234567890@g.us"
}
```

### Response
#### Success Response (200)
Group Application edit result list

#### Response Example
```json
{}
```

#### Error Responses
- **400** - Wrong request parameters
- **404** - Specified group not found
- **500** - Internal Error
```

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

### cURL request to add participants to a community

Source: https://whapi.readme.io/reference/addcommunityparticipant

A multi-part cURL command example for the POST request to the community participants endpoint.

```shell
curl --request POST \
```

```shell
     --url https://gate.whapi.cloud/communities//participants \
```

```shell
     --header 'accept: application/json' \
```

```shell
     --header 'content-type: application/json' \
```

```shell
     --data '{}'
```

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

### Get bots with cURL

Source: https://whapi.readme.io/reference/bots

Use this cURL command to retrieve the list of bots available for the account. The request is a GET to the /bots endpoint with an accept header for JSON. The response is either a 200 OK or a 500 Internal Error.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/bots \
     --header 'accept: application/json'
```

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

### POST /groups

Source: https://whapi.readme.io/reference/creategroup

Creates a new WhatsApp group with specified participants.

```APIDOC
## POST /groups

### Description
This method is responsible for creating a group with its respective participants. Just like WhatsApp you will need to add at least one contact to be able to create a group. Due to WhatsApp's anti-spam policy, some contacts are not automatically added to the group.

### Method
POST

### Endpoint
https://gate.whapi.cloud/groups

### Parameters
#### Request Body
- **subject** (string) - Required - Group subject
- **participants** (array of objects) - Required - length ≥ 1 - List of participants
  - **participants*** (string) - Contact ID

### Request Example
```json
{}
```

### Response
#### Success Response (200)
No response body details provided.

#### Error Responses
- **400** - Wrong request parameters
- **401** - Need channel authorization for create group
- **404** - Specified participant not found in contacts list
- **429** - Too many requests
- **500** - Internal Error
```

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

### cURL Request for sending a catalog

Source: https://whapi.readme.io/reference/sendcatalog

A POST request to the business catalogs endpoint using cURL. This example demonstrates sending a catalog with a product preview type.

```Shell
curl --request POST \
     --url https://gate.whapi.cloud/business/catalogs/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "preview_type": "product"
}
'
```

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

### cURL request to get community subgroups

Source: https://whapi.readme.io/reference/getcommunitysubgroups

Use this cURL command to call the GET /communities/{CommunityID}/subgroups endpoint. Replace the placeholder in the URL with a valid CommunityID that matches the pattern ^[\d-]{10,31}@g\.us$. The request requires an accept: application/json header.

```shell
curl --request GET \
     --url https://gate.whapi.cloud/communities//subgroups \
     --header 'accept: application/json'
```
Tokens:
Raw