Início
Instances
Settings
Send Message
Chat Controller
Profile Settings
Group Controller
- POSTCreate Group
- POSTUpdate Group Picture
- POSTUpdate Group Subject
- POSTUpdate Group Description
- GETFetch Invite Code
- POSTRevoke Invite Code
- POSTSend Group Invite
- GETFind Group by Invite Code
- GETFind Group by JID
- GETFetch All Groups
- GETFind Group Members
- POSTUpdate Group Members
- POSTUpdate Group Setting
- POSTToggle Ephemeral
- DELLeave Group
Typebot
OpenAI
Evolution Bot
Dify
Flowise
Chatwoot
Websocket
RabbitMQ
Instances
Create Instance
POST
/
instance
/
create
curl --request POST \
--url https://{server-url}/instance/create \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"instanceName": "<string>",
"token": "<string>",
"qrcode": true,
"number": "<string>",
"integration": "WHATSAPP-BAILEYS",
"rejectCall": true,
"msgCall": "<string>",
"groupsIgnore": true,
"alwaysOnline": true,
"readMessages": true,
"readStatus": true,
"syncFullHistory": true,
"proxyHost": "<string>",
"proxyPort": "<string>",
"proxyProtocol": "<string>",
"proxyUsername": "<string>",
"proxyPassword": "<string>",
"webhook": {
"url": "<string>",
"byEvents": true,
"base64": true,
"headers": {
"authorization": "<string>",
"Content-Type": "<string>"
},
"events": [
"APPLICATION_STARTUP"
]
},
"rabbitmq": {
"enabled": true,
"events": [
"APPLICATION_STARTUP"
]
},
"sqs": {
"enabled": true,
"events": [
"APPLICATION_STARTUP"
]
},
"chatwootAccountId": 123,
"chatwootToken": "<string>",
"chatwootUrl": "<string>",
"chatwootSignMsg": true,
"chatwootReopenConversation": true,
"chatwootConversationPending": true,
"chatwootImportContacts": true,
"chatwootNameInbox": "<string>",
"chatwootMergeBrazilContacts": true,
"chatwootImportMessages": true,
"chatwootDaysLimitImportMessages": 123,
"chatwootOrganization": "<string>",
"chatwootLogo": "<string>"
}'
{
"instance": {
"instanceName": "teste-docs",
"instanceId": "af6c5b7c-ee27-4f94-9ea8-192393746ddd",
"webhook_wa_business": null,
"access_token_wa_business": "",
"status": "created"
},
"hash": {
"apikey": "123456"
},
"settings": {
"reject_call": false,
"msg_call": "",
"groups_ignore": true,
"always_online": false,
"read_messages": false,
"read_status": false,
"sync_full_history": false
}
}
Authorizations
Your authorization key header
Body
application/json
Response
201
application/json
Created
The response is of type object
.
curl --request POST \
--url https://{server-url}/instance/create \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"instanceName": "<string>",
"token": "<string>",
"qrcode": true,
"number": "<string>",
"integration": "WHATSAPP-BAILEYS",
"rejectCall": true,
"msgCall": "<string>",
"groupsIgnore": true,
"alwaysOnline": true,
"readMessages": true,
"readStatus": true,
"syncFullHistory": true,
"proxyHost": "<string>",
"proxyPort": "<string>",
"proxyProtocol": "<string>",
"proxyUsername": "<string>",
"proxyPassword": "<string>",
"webhook": {
"url": "<string>",
"byEvents": true,
"base64": true,
"headers": {
"authorization": "<string>",
"Content-Type": "<string>"
},
"events": [
"APPLICATION_STARTUP"
]
},
"rabbitmq": {
"enabled": true,
"events": [
"APPLICATION_STARTUP"
]
},
"sqs": {
"enabled": true,
"events": [
"APPLICATION_STARTUP"
]
},
"chatwootAccountId": 123,
"chatwootToken": "<string>",
"chatwootUrl": "<string>",
"chatwootSignMsg": true,
"chatwootReopenConversation": true,
"chatwootConversationPending": true,
"chatwootImportContacts": true,
"chatwootNameInbox": "<string>",
"chatwootMergeBrazilContacts": true,
"chatwootImportMessages": true,
"chatwootDaysLimitImportMessages": 123,
"chatwootOrganization": "<string>",
"chatwootLogo": "<string>"
}'
{
"instance": {
"instanceName": "teste-docs",
"instanceId": "af6c5b7c-ee27-4f94-9ea8-192393746ddd",
"webhook_wa_business": null,
"access_token_wa_business": "",
"status": "created"
},
"hash": {
"apikey": "123456"
},
"settings": {
"reject_call": false,
"msg_call": "",
"groups_ignore": true,
"always_online": false,
"read_messages": false,
"read_status": false,
"sync_full_history": false
}
}
Assistant
Responses are generated using AI and may contain mistakes.