Documentation

HTTP API Documentation


https://api.waapi.me

Instance disconnect


This request completely stops a WaAPI instance, bringing its status to stopped. If the instance was connected to WhatsApp, it will be disconnected as well. Use this method when you need to stop the instance`s operation or disconnect it from WhatsApp.


Request


This section provides an example HTTP request to stop the instance and disconnect it from WhatsApp. Ensure the request includes the correct URL and the instance ID for the instance you wish to disconnect and stop.


POSThttps://api.waapi.me/instance/:id/disconnect

Headers


When making this request, it`s important to include Authorization HTTP header


Authorization: <YOUR_API_KEY>

Response


The response contains a JSON example confirming that the bot instance has been stopped. It includes the instance ID and status, showing that the bot has been successfully disconnected from WhatsApp and is now in a stopped state. Refer to the table for a description of each field in the response, explaining the status and other relevant details.


Field
Type
Description
idstring|uuidInstance(bot) id
namestringInstance(bot) name
phonestringConnected phone number
platformstring|enumConnected phone platform
statusstring|enumInstance(bot) status
hookUrlstring|url|nullWebhook URL
messageHookbooleanSend outgoing messages to webhook url flag
messageBotHookbooleanSend incoming messages to webhook url flag
instanceHookbooleanSend instance(bot) changes to webhook url flag

{
    "id": "c3996092-b982-4af7-8cf1-0cfafea5143c",
    "name": "Darth Maul bot",
    "phone": null,
    "platform": "unknown",
    "status": "created",
    "hookUrl": null,
    "messageHook": false,
    "messageBotHook": false,
    "instanceHook": false
}