v2 GitHub

Português English API

Início Instances
cURL Python JavaScript PHP Go Java
GET Get Information
Create Instance <?php

Instances
POST / instance / create Try it $curl = curl_init();

POST Create Instance

curl_setopt_array($curl, [
GET Fetch Instances CURLOPT_URL => "https://{server-url}/instance/create",
CURLOPT_RETURNTRANSFER => true,
GET Instance Connect Authorizations CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
PUT Restart Instance
CURLOPT_TIMEOUT => 30,
GET Connection State apikey string header required CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
DEL Logout Instance Your authorization key header CURLOPT_POSTFIELDS => "{\n \"instanceName\": \"<string>\
CURLOPT_HTTPHEADER => [
DEL Delete Instance
"Content-Type: application/json",
POST Set Presence "apikey: "
Body application/json ],
]);
Webhook
instanceName string required
$response = curl_exec($curl);
POST Set Webhook $err = curl_error($curl);
instance (Instance name)
GET Find Webhook
curl_close($curl);

alwaysOnline boolean if ($err) {

Settings
echo "cURL Error #:" . $err;
Keep WhatsApp always online } else {
POST Set Settings
echo $response;
GET Find Settings }
chatwootAccountId integer

Send Message Chatwoot account ID

201 403
POST Send Plain Text
POST Send Status chatwootConversationPending boolean {
"instance": {
POST Send Media Start the conversation as pending instead of open "instanceName": "teste-docs",
POST Send WhatsApp Audio "instanceId": "af6c5b7c-ee27-4f94-9ea8-192393746ddd",
"webhook_wa_business": null,
POST Send Sticker chatwootDaysLimitImportMessages integer "access_token_wa_business": "",
"status": "created"
POST Send Location Specifies how many days' messages to import from today },
POST Send Contact "hash": {
"apikey": "123456"
POST Send Reaction chatwootImportContacts boolean },
"settings": {
POST Send Poll
Import contacts from WhatsApp to Chatwoot "reject_call": false,
POST Send List "msg_call": "",
"groups_ignore": true,
POST Send Buttons "always_online": false,
chatwootLogo string
"read_messages": false,
Chatwoot logo URL "read_status": false,
Chat Controller "sync_full_history": false
}
POST Check is WhatsApp }
chatwootMergeBrazilContacts boolean
POST Mark Message As Read
POST Mark Message As Unread Whether to merge Brazilian number contacts with and without the additional 9 . Ex:
553198765432 merges with 5531998765432
POST Archive Chat
Delete Message for
DEL
Everyone chatwootNameInbox string

POST Update Message Chatwoot inbox name (uses the instance name if empty)

POST Send Presence

POST Update Block Status chatwootOrganization string

POST Fetch Profile Picture URL Chatwoot organization name

POST Get Base64
POST Find Contacts chatwootReopenConversation boolean
POST Find Messages Reopen conversation on Chatwoot
POST Find Status Message
POST Find Chats chatwootSignMsg boolean

Send message signature on Chatwoot

Profile Settings

POST Fetch Business Profile

chatwootToken string
POST Fetch Profile
Chatwoot authentication token
POST Update Profile Name
POST Update Profile Status
chatwootUrl string
POST Update Profile Picture
DEL Remove Profile Picture Chatwoot server URL

GET Fetch Privacy Settings

POST Update Privacy Settings groupsIgnore boolean

Ignore group messages

Group Controller

POST Create Group integration enum<string>

POST Update Group Picture WhatsApp engine
POST Update Group Subject
Available options: WHATSAPP-BAILEYS , WHATSAPP-BUSINESS
POST Update Group Description
GET Fetch Invite Code
msgCall string
POST Revoke Invite Code
Message to be sent when a call is rejected automatically
POST Send Group Invite
GET Find Group by Invite Code
number string
GET Find Group by JID
GET Fetch All Groups 559999999999 (Instance owner number with Country Code)

GET Find Group Members

POST Update Group Members proxyHost string

POST Update Group Setting Proxy host

POST Toggle Ephemeral
DEL Leave Group proxyPassword string

Proxy password
Typebot

POST Create Typebot

proxyPort string
POST Start Typebot
Proxy port
GET Find Typebot
GET Fetch Typebot
proxyProtocol enum<string>
POST Update Typebot
Proxy protocol
DEL Delete Typebot
POST Change Session Status Available options: http , https

GET Fetch Session Typebot

POST Settings Typebot proxyUsername string

GET Fetch Typebot Settings Proxy username

OpenAI
qrcode boolean
POST Create OpenIA Bot
Create QR Code automatically after creation
GET Find OpenIA Bot
GET Find OpenIA Bots
rabbitmqEnabled boolean
PUT Update Bot
Enables RabbitMQ
DEL Delete OpenIA Bot
GET Find OpenIA Creds
rabbitmqEvents enum<string>[]
POST Creds config OpenAI
Events to be sent to the RabbitMQ
DEL Delete OpenIA Bot
POST Settigns config OpenAI Available options: APPLICATION_STARTUP , QRCODE_UPDATED , MESSAGES_SET ,
MESSAGES_UPSERT , MESSAGES_UPDATE , MESSAGES_DELETE , SEND_MESSAGE ,
GET Find settings OpenAI CONTACTS_SET , CONTACTS_UPSERT , CONTACTS_UPDATE , PRESENCE_UPDATE ,
POST Change status OpenAI CHATS_SET , CHATS_UPSERT , CHATS_UPDATE , CHATS_DELETE , GROUPS_UPSERT ,
GROUP_UPDATE , GROUP_PARTICIPANTS_UPDATE , CONNECTION_UPDATE , LABELS_EDIT ,
GET Find sessions OpenAI LABELS_ASSOCIATION , CALL , TYPEBOT_START , TYPEBOT_CHANGE_STATUS

Evolution Bot
readMessages boolean
POST Create Evolution Bot
Send read receipts to received messages
GET Find Evolution Bots
GET Fetch Evolution Bot
readStatus boolean
PUT Update Evolution Bot
Show sent messages read status
DEL Delete Evolution Bot
POST Set Settings Bot
reject_call boolean
GET Find Settings Bot
Change Evolution Bot Reject WhatsApp calls automatically
POST
status
GET Fetch Evolution Bot Session sqsEnabled boolean

Enable SQS
Dify

POST Create Dify Bot

sqsEvents enum<string>[]
GET Find Dify Bots
Events to be sent to the SQS
GET Find Dify Bot
PUT Update Dify Bot Available options: APPLICATION_STARTUP , QRCODE_UPDATED , MESSAGES_SET ,
MESSAGES_UPSERT , MESSAGES_UPDATE , MESSAGES_DELETE , SEND_MESSAGE ,
POST Set Dify Settings
CONTACTS_SET , CONTACTS_UPSERT , CONTACTS_UPDATE , PRESENCE_UPDATE ,
GET Find Dify Settings CHATS_SET , CHATS_UPSERT , CHATS_UPDATE , CHATS_DELETE , GROUPS_UPSERT ,
GROUP_UPDATE , GROUP_PARTICIPANTS_UPDATE , CONNECTION_UPDATE , LABELS_EDIT ,
POST Change Status Bot
LABELS_ASSOCIATION , CALL , TYPEBOT_START , TYPEBOT_CHANGE_STATUS
GET Find Status Bot

syncFullHistory boolean
Flowise
Whether to sync the full history of messages and chats or not
POST Create Flowise Bot
GET Find Flowise Bots
token string
GET Find Flowise Bot
apikey (Enter or leave empty to create dynamically)
POST Update Flowise Bot
DEL Delete Flowise Bot
typebot string
POST Set Settings Flowise Bots
GET Find Flowise settings Typebot flow name

POST Change Status Session

GET Find Sessions Flowise typebotDelayMessage integer

Default delay for the typebot messages

Chatwoot

POST Set Chatwoot typebotExpire integer

GET Find Chatwoot
Time to expire the session in seconds

Websocket
typebotKeywordFinish string
POST Set Websocket
Keyword to finish the typebot flow (escape keyword)
GET Find Websocket

SQS typebotListeningFromMe boolean

POST Set SQS Typebot listen messages sent by the connected number

GET Find SQS

typebotUnknownMessage string
RabbitMQ
TODO
POST Set RabbitMQ
GET Find RabbitMQ typebotUrl string

Typebot server URL

webhookBase64 boolean

Sends media files on base64 via Webhook

webhookByEvents boolean

Enables the Webhook by events

webhookEvents enum<string>[]

Events to be sent to the Webhook

Available options: APPLICATION_STARTUP , QRCODE_UPDATED , MESSAGES_SET ,

MESSAGES_UPSERT , MESSAGES_UPDATE , MESSAGES_DELETE , SEND_MESSAGE ,
CONTACTS_SET , CONTACTS_UPSERT , CONTACTS_UPDATE , PRESENCE_UPDATE ,
CHATS_SET , CHATS_UPSERT , CHATS_UPDATE , CHATS_DELETE , GROUPS_UPSERT ,
GROUP_UPDATE , GROUP_PARTICIPANTS_UPDATE , CONNECTION_UPDATE , LABELS_EDIT ,
LABELS_ASSOCIATION , CALL , TYPEBOT_START , TYPEBOT_CHANGE_STATUS

webhookUrl string

Webhook URL

Response 201 - application/json

hash object

Show child attributes

instance object

Show child attributes

settings object

Show child attributes

Get Information Fetch Instances

Powered by Mintlify

The PDF has been downloaded. Rate us: