Sign in

v1

latestOpenAPI 3.0.3raw.githubusercontent.com2024-06-11720209.3 KB
Instance Controller

Create Instance

post/instance/create

Request body

instanceNamestring required

instance (Instance name)

tokenstring

apikey (Enter or leave empty to create dynamically)

qrcodeboolean

Create QR Code automatically after creation

numberstring

559999999999 (Instance owner number with Country Code)

integration'WHATSAPP-BAILEYS' | 'WHATSAPP-BUSINESS'

WhatsApp engine

webhookstring

Webhook URL

webhook_by_eventsboolean

Enable Webhook by events

eventsstring[]

Events to be sent to the Webhook

reject_callboolean

Reject WhatsApp calls automatically

msg_callstring

Message to be sent when a call is rejected automatically

groups_ignoreboolean

Ignore group messages

always_onlineboolean

Keep WhatsApp always online

read_messagesboolean

Send read receipts to received messages

read_statusboolean

Show sent messages read status

websocket_enabledboolean

Enable websocket

websocket_eventsstring[]

Events to be sent to the websocket

rabbitmq_enabledboolean

Enable RabbitMQ

rabbitmq_eventsstring[]

Events to be sent to the RabbitMQ

sqs_enabledboolean

Enable SQS

sqs_eventsstring[]

Events to be sent to the SQS

typebot_urlstring

URL for the typebot instance

typebotstring

Typebot flow name

typebot_expireinteger

Seconds to expire TODO

typebot_keyword_finishstring

Keyword to finish the typebot flow

typebot_delay_messageinteger

Default delay for the typebot messages

typebot_unknown_messagestring

TODO

typebot_listening_from_meboolean

Typebot listen messages sent by the connected number

chatwoot_account_idinteger

Chatwoot account ID

chatwoot_tokenstring

Chatwoot authentication token

chatwoot_urlstring

Chatwoot server URL

chatwoot_sign_msgboolean

Send message signature on Chatwoot

chatwoot_reopen_conversationboolean

Reopen conversation on Chatwoot

chatwoot_conversation_pendingboolean

TODO

Response

Created

Example response

{
  "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
  }
}