v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB

Channel

Check health & launch channel

Allows you to track and get feedback on the operational status of the whapi channel (instance). An instance is a connection with a phone number that has a WhatsApp account, which will be responsible for sending and receiving messages

get/health

Query parameters

wakeupboolean

If set to false, the channel will not launch

platformstring

Example:Chrome,Whapi,1.6.0

Browser name, OS name, OS version separated by commas. Example: 'Safari,Windows,10.0.19044' or 'Desktop,Mac OS,11.6.3'

channel_type'web' | 'mobile'

Channel type. Web - for linking existing WA account via WA Web, Mobile - for creating new WA account

Response

channel_idstring

Active channel ID

start_atnumber required

Date timestamp when channel started on the server.

uptimenumber required

Seconds have passed since the start of the instance.

versionstring

Channel version

core_versionstring

Core version

api_versionstring

Api version

device_idnumber

Current device ID

ipstring ipv4

Current channel ip-address

All 181 operations