Instances
Create Instance Basic
Início
Instances
Settings
Send Message
Chat Controller
Profile Settings
Group Controller
- POSTCreate Group
- PUTUpdate Group Picture
- PUTUpdate Group Subject
- PUTUpdate Group Description
- GETFetch Invite Code
- GETAccept Invite Code
- PUTRevoke Invite Code
- POSTSend Group Invite
- GETFind Group by Invite Code
- GETFind Group by JID
- GETFetch All Groups
- GETFind Group Members
- PUTUpdate Group Members
- PUTUpdate Group Setting
- PUTToggle Ephemeral
- DELLeave Group
Chatwoot
RabbitMQ
WebSocket
Instances
Create Instance Basic
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",
"webhook": "<string>",
"webhook_by_events": true,
"events": [
"APPLICATION_STARTUP"
],
"reject_call": true,
"msg_call": "<string>",
"groups_ignore": true,
"always_online": true,
"read_messages": true,
"read_status": true,
"websocket_enabled": true,
"websocket_events": [
"APPLICATION_STARTUP"
],
"rabbitmq_enabled": true,
"rabbitmq_events": [
"APPLICATION_STARTUP"
],
"sqs_enabled": true,
"sqs_events": [
"APPLICATION_STARTUP"
],
"typebot_url": "<string>",
"typebot": "<string>",
"typebot_expire": 123,
"typebot_keyword_finish": "<string>",
"typebot_delay_message": 123,
"typebot_unknown_message": "<string>",
"typebot_listening_from_me": true,
"proxy": {
"host": "<string>",
"port": "<string>",
"protocol": "http",
"username": "<string>",
"password": "<string>"
},
"chatwoot_account_id": 123,
"chatwoot_token": "<string>",
"chatwoot_url": "<string>",
"chatwoot_sign_msg": true,
"chatwoot_reopen_conversation": true,
"chatwoot_conversation_pending": true
}'
{
"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",
"webhook": "<string>",
"webhook_by_events": true,
"events": [
"APPLICATION_STARTUP"
],
"reject_call": true,
"msg_call": "<string>",
"groups_ignore": true,
"always_online": true,
"read_messages": true,
"read_status": true,
"websocket_enabled": true,
"websocket_events": [
"APPLICATION_STARTUP"
],
"rabbitmq_enabled": true,
"rabbitmq_events": [
"APPLICATION_STARTUP"
],
"sqs_enabled": true,
"sqs_events": [
"APPLICATION_STARTUP"
],
"typebot_url": "<string>",
"typebot": "<string>",
"typebot_expire": 123,
"typebot_keyword_finish": "<string>",
"typebot_delay_message": 123,
"typebot_unknown_message": "<string>",
"typebot_listening_from_me": true,
"proxy": {
"host": "<string>",
"port": "<string>",
"protocol": "http",
"username": "<string>",
"password": "<string>"
},
"chatwoot_account_id": 123,
"chatwoot_token": "<string>",
"chatwoot_url": "<string>",
"chatwoot_sign_msg": true,
"chatwoot_reopen_conversation": true,
"chatwoot_conversation_pending": true
}'
{
"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
}
}