API Reference
Start typing to search…

Check health & launch channel

get https://gate.whapi.cloud/health

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

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to true

If set to false, the channel will not launch

string

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

string
Defaults to web

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

Responses

Updated 12 months ago

Did this page help you?
Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago

Did this page help you?