WPPConnect API Rest (2.0.0)
Download OpenAPI specification:Download
Welcome to the wppconnect-server API documentation. This API provides a set of endpoints to interact with the wppconnect-server application, allowing you to build integrations and automate interactions with WhatsApp.
Deprecated in favor of Deprecated
This body is not required. Not sent body to get all chats or filter.
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
query Parameters
phone | string Example: phone=5521999999999 |
isGroup | string Example: isGroup=false |
includeMe | string Example: includeMe=true |
includeNotifications | string Example: includeNotifications=false |
messageId required | string Example: messageId=<messageId> |
type | string Example: type=all |
count | string Example: count=20 |
direction | string Example: direction=before |
id | string Example: id=<message_id_to_use_direction> |
status | string |
response | string |
Request Body schema: application/json
event | string |
private | string |
Responses
Request samples
- Payload
{- "messageId": "conversation_status_changed",
- "private": "false"
}
Retrieve a list of chats
This body is not required. Not sent body to get all chats or filter.
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
id | string |
count | number |
direction | string |
onlyGroups | boolean |
onlyUsers | boolean |
onlyWithUnreadMessage | boolean |
withLabels | Array of arrays |
Responses
Request samples
- Payload
{- "id": "<chatId>",
- "count": 20,
- "direction": "after",
- "onlyGroups": false,
- "onlyUsers": false,
- "onlyWithUnreadMessage": false,
- "withLabels": [ ]
}
/api/{session}/all-messages-in-chat/{phone}
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
phone required | string Example: 5521999999999 |
query Parameters
isGroup | string Example: isGroup=false |
includeMe | string Example: includeMe=true |
includeNotifications | string Example: includeNotifications=true |
Responses
/api/{session}/load-messages-in-chat/{phone} Deprecated
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
phone required | string Example: 5521999999999 |
query Parameters
includeMe | string Example: includeMe=true |
includeNotifications | string Example: includeNotifications=false |
Responses
/api/{session}/archive-chat
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
value | boolean |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "value": true
}
/api/{session}/send-mute
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
time | number |
type | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "time": 1,
- "type": "hours"
}
/api/{session}/chat-state Deprecated
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
chatstate | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "chatstate": "1"
}
/api/{session}/typing
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
value | boolean |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "value": true
}
/api/{session}/recording
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
duration | number |
value | boolean |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "duration": 5,
- "value": true
}
Handles operations related to contacts, such as managing contact lists, adding or removing contacts, and retrieving contact information.
Handles operations related to catalogs and business-related functionalities, such as managing product catalogs and business information.
/api/{session}/add-product
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
name | string |
image | string |
description | string |
price | string |
url | string |
retailerId | string |
currency | string |
Responses
Request samples
- Payload
{- "name": "Product name",
- "image": "<base64_string>",
- "description": "Description for your product",
- "price": "8890",
- "retailerId": "SKU001",
- "currency": "BRL"
}
/api/{session}/edit-product
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
id | string |
options | object |
Responses
Request samples
- Payload
{- "id": "<product_id>",
- "options": {
- "name": "New name for product"
}
}
/api/{session}/create-collection
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
name | string |
products | Array of arrays |
Responses
Request samples
- Payload
{- "name": "Collection name",
- "products": [
- "<id_product1>",
- "<id_product2>"
]
}
/api/{session}/edit-collection
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
id | string |
products | Array of arrays |
Responses
Request samples
- Payload
{- "id": "<product_id>",
- "options": {
- "name": "New name for collection"
}
}
/api/{session}/create-community
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
name | string |
description | boolean |
groupIds | Array of arrays |
Responses
Request samples
- Payload
{- "name": "My community name",
- "description": "Description for your community",
- "groupIds": [
- "groupId1",
- "groupId2"
]
}
/api/{session}/add-community-subgroup
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
id | string |
groupsIds | Array of arrays |
Responses
Request samples
- Payload
{- "id": "<you_community_id@g.us>",
- "groupsIds": [
- "group1Id@g.us"
]
}
/api/{session}/remove-community-subgroup
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
id | string |
groupsIds | Array of arrays |
Responses
Request samples
- Payload
{- "id": "<you_community_id@g.us>",
- "groupsIds": [
- "group1Id@g.us"
]
}
/api/{session}/promote-community-participant
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
id | string |
participantsId | Array of arrays |
Responses
Request samples
- Payload
{- "id": "<you_community_id@g.us>",
- "participantsId": [
- "group1Id@g.us"
]
}
/api/{session}/demote-community-participant
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
id | string |
participantsId | Array of arrays |
Responses
Request samples
- Payload
{- "id": "<you_community_id@g.us>",
- "participantsId": [
- "group1Id@g.us"
]
}
/api/{session}/send-message
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
isNewsletter | boolean |
message | string |
options | object |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "isNewsletter": false,
- "message": "Hi from WPPConnect"
}
/api/{session}/edit-message
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
id | string |
newText | string |
options | object |
Responses
Request samples
- Payload
{- "id": "true_5521999999999@c.us_3EB04FCAA1527EB6D9DEC8",
- "newText": "New text for message"
}
/api/{session}/send-image
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
isNewsletter | boolean |
filename | string |
caption | string |
base64 | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "isNewsletter": false,
- "filename": "file name lol",
- "caption": "caption for my file",
- "base64": "<base64> string"
}
/api/{session}/send-sticker
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone required | string |
isGroup | boolean |
path required | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": true,
- "path": "<path_file>"
}
/api/{session}/send-sticker-gif
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone required | string |
isGroup | boolean |
path required | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": true,
- "path": "<path_file>"
}
/api/{session}/send-reply
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
message | string |
messageId | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "message": "Reply to message",
- "messageId": "<id_message>"
}
/api/{session}/send-file
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
isNewsletter | boolean |
filename | string |
caption | string |
base64 | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "isNewsletter": false,
- "filename": "file name lol",
- "caption": "caption for my file",
- "base64": "<base64> string"
}
/api/{session}/send-file-base64
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
isNewsletter | boolean |
filename | string |
caption | string |
base64 | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "isNewsletter": false,
- "filename": "file name lol",
- "caption": "caption for my file",
- "base64": "<base64> string"
}
/api/{session}/send-voice
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
path | string |
quotedMessageId | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "path": "<path_file>",
- "quotedMessageId": "message Id"
}
/api/{session}/send-voice-base64
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
base64Ptt | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "base64Ptt": "<base64_string>"
}
/api/{session}/send-status
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone required | string |
isGroup required | boolean |
message required | string |
messageId | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "message": "Reply to message",
- "messageId": "<id_message>"
}
/api/{session}/send-link-preview
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
url | string |
caption | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "caption": "Text for describe link"
}
/api/{session}/send-location
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
lat | string |
lng | string |
title | string |
address | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "lat": "-89898322",
- "lng": "-545454",
- "title": "Rio de Janeiro",
- "address": "Av. N. S. de Copacabana, 25, Copacabana"
}
/api/{session}/send-mentioned
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone required | string |
isGroup | boolean |
message required | string |
mentioned required | Array of strings |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": true,
- "message": "Your text message",
- "mentioned": [
- "@556593077171@c.us"
]
}
/api/{session}/send-list-message
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
description | string |
sections | Array of arrays |
buttonText | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "description": "Desc for list",
- "buttonText": "Select a option",
- "sections": [
- {
- "title": "Section 1",
- "rows": [
- {
- "rowId": "my_custom_id",
- "title": "Test 1",
- "description": "Description 1"
}, - {
- "rowId": "2",
- "title": "Test 2",
- "description": "Description 2"
}
]
}
]
}
/api/{session}/send-order-message
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
items | object |
options | object |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "items": [
- {
- "type": "custom",
- "name": "Item test",
- "price": 120000,
- "qnt": 2
}, - {
- "type": "custom",
- "name": "Item test 2",
- "price": 145000,
- "qnt": 2
}
]
}
/api/{session}/send-poll-message
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
name | string |
choices | Array of arrays |
options | object |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "name": "Poll name",
- "choices": [
- "Option 1",
- "Option 2",
- "Option 3"
], - "options": {
- "selectableCount": 1
}
}
/api/{session}/get-messages/{phone}
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
phone required | string Example: 5521999999999@c.us |
query Parameters
count | string Example: count=20 |
direction | string Example: direction=before |
id | string Example: id=<message_id_to_use_direction> |
Responses
/api/{session}/delete-message
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
messageId | string |
onlyLocal | boolean |
deleteMediaInDevice | boolean |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "messageId": "<messageId>",
- "deleteMediaInDevice": true
}
/api/{session}/forward-messages
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
messageId | string |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "messageId": "<messageId>"
}
/api/{session}/contact-vcard
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
name | string |
contactsId | Array of arrays |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "name": "Name of contact",
- "contactsId": [
- "5521999999999"
]
}
/api/{session}/temporary-messages
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phone | string |
isGroup | boolean |
value | boolean |
Responses
Request samples
- Payload
{- "phone": "5521999999999",
- "isGroup": false,
- "value": true
}
/api/{session}/send-link-catalog
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
phones | Array of arrays |
message | string |
Responses
Request samples
- Payload
{- "phones": [
- "<array_phone_id"
], - "message": "Message"
}
editBusinessProfile
Edit your bussiness profile
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
adress | string |
string | |
categories | object |
websites | Array of arrays |
Responses
Request samples
- Payload
{- "adress": "Av. Nossa Senhora de Copacabana, 315",
- "email": "test@test.com.br",
- "categories": {
- "$id": "133436743388217",
- "$localized_display_name": "Artes e entretenimento",
- "$not_a_biz": false
},
}
Handles operations related to status stories, such as viewing, updating, and managing status stories
/api/{session}/send-text-storie
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
text required | string |
options | object |
Responses
Request samples
- Payload
{- "text": "My new storie",
- "options": {
- "backgroundColor": "#0275d8",
- "font": 2
}
}
Manages labels or tags associated with chats or messages for organization and categorization purposes.
/api/{session}/add-new-label
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
$name | string |
object |
Responses
Request samples
- Payload
{- "name": "Name of your label",
- "options": {
- "labelColor": 4292849392
}
}
/api/{session}/add-or-remove-label
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
chatIds required | Array of strings |
Array of objects |
Responses
Request samples
- Payload
{- "chatIds": [
- "5521999999999"
], - "options": [
- {
- "labelId": "76",
- "type": "add"
}, - {
- "labelId": "75",
- "type": "remove"
}
]
}
Manages operations related to WhatsApp groups, such as creating, modifying, and managing group settings.
Deprecated in favor of Deprecated
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
query Parameters
groupId | string Example: groupId=<groupId> |
wid | string Example: wid=5521999999999@c.us |
Request Body schema: application/json
$groupId | string |
$path | string |
Responses
Request samples
- Payload
{- "$groupId": "string",
- "$path": "string"
}
/api/{session}/create-group
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
participants required | Array of strings |
name required | string |
Responses
Request samples
- Payload
{- "participants": [
- "5521999999999"
], - "name": "Group name"
}
/api/{session}/add-participant-group
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
groupId required | string |
phone required | string |
Responses
Request samples
- Payload
{- "groupId": "<groupId>",
- "phone": "5521999999999"
}
/api/{session}/remove-participant-group
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
groupId required | string |
phone required | string |
Responses
Request samples
- Payload
{- "groupId": "<groupId>",
- "phone": "5521999999999"
}
/api/{session}/promote-participant-group
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
groupId required | string |
phone required | string |
Responses
Request samples
- Payload
{- "groupId": "<groupId>",
- "phone": "5521999999999"
}
/api/{session}/demote-participant-group
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
groupId required | string |
phone required | string |
Responses
Request samples
- Payload
{- "groupId": "<groupId>",
- "phone": "5521999999999"
}
/api/{session}/group-description
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
$groupId | string |
$description | string |
Responses
Request samples
- Payload
{- "$groupId": "string",
- "$description": "string"
}
/api/{session}/group-property
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
$groupId | string |
$property | string |
$value | boolean |
Responses
Request samples
- Payload
{- "$groupId": "string",
- "$property": "string",
- "$value": true
}
Change limits of whatsapp web. Types value: maxMed
Change limits of whatsapp web. Types value: maxMediaSize, maxFileSize, maxShare, statusVideoMaxDuration, unlimitedPin;
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
type required | string |
value required | any |
Responses
Request samples
- Payload
{- "type": "maxFileSize",
- "value": 104857600
}
You can point your Chatwoot to this route so that
You can point your Chatwoot to this route so that it can perform functions.
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
Request Body schema: application/json
event | string |
private | string |
Responses
Request samples
- Payload
{- "messageId": "conversation_status_changed",
- "private": "false"
}
createNewsletter
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
query Parameters
id | string Example: id=<newsletter_id> |
Request Body schema: application/json
name | string |
description | string |
picture | string |
Responses
Request samples
- Payload
{- "name": "New name of channel",
- "description": "New description of channel",
- "picture": "<new_base64_image> or send null"
}
editNewsletter
Authorizations:
path Parameters
session required | string Example: NERDWHATS_AMERICA |
id required | string Example: NEWSLETTER ID |
Request Body schema: application/json
name | string |
description | string |
picture | string |
Responses
Request samples
- Payload
{- "name": "New name of channel",
- "description": "New description of channel",
- "picture": "<new_base64_image> or send null"
}