Documentation

HTTP API Documentation

https://api.waapi.me

Get instance

This request retrieves information about a specific WaAPI instance(bot) using its unique identifier. Use this method to check the bot`s status, configuration parameters, and other important details.

Request

Make sure to specify the correct URL and include any required parameters, such as the instance ID, to successfully fetch the data.

GEThttps://api.waapi.me/instance/:id

Headers

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

Authorization: <YOUR_API_KEY>

Response

In this section, you`ll find an example JSON response returned by the server for a successful request, along with a detailed table describing each field. The JSON object includes key information about the instance, such as it`s status, configuration details, and other relevant properties. Refer to the table to understand the meaning and format of each field in the response.

Field	Type	Description
id	string\|uuid	Instance(bot) id
name	string	Instance(bot) name
phone	string	Connected phone number
platform	string\|enum	Connected phone platform
status	string\|enum	Instance(bot) status
hookUrl	string\|url\|null	Webhook URL
messageHook	boolean	Send outgoing messages to webhook url flag
messageBotHook	boolean	Send incoming messages to webhook url flag
instanceHook	boolean	Send 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
}