---
title: "Check health & launch channel"
method: GET
path: "/health"
tags: ["Channel"]
---

# Check health & launch channel

`GET /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

## Query parameters

- `wakeup` boolean
- `platform` string
- `channel_type` 'web' | 'mobile'

## Response `200`

OK

- Health — The health object contains information about the uptime of the channel and the status of the channel. Sent on event "channels.post"
  - `channel_id` string — Active channel ID
  - `start_at` number, required — Date timestamp when channel started on the server.
  - `uptime` number, required — Seconds have passed since the start of the instance.
  - `version` string — Channel version
  - `core_version` string — Core version
  - `api_version` string — Api version
  - `device_id` number — Current device ID
  - `ip` string, ipv4 — Current channel ip-address
  - `status` ChannelStatus, required
    - `code` number, required — Status code
    - `text` 'NOT_INIT' | 'INIT' | 'LAUNCH' | 'QR' | 'AUTH' | 'ERROR' | 'SYNC_ERROR', required — Status text
  - `user` Contact
    - `id` string, required — WA ID
    - `phone` string — Phone number
    - `name` string, required — Contact title from contact book
    - `pushname` string — Account name from WA or WA Business name
    - `is_business` boolean — Is a business account
    - `profile_pic` string — Profile picture URL
    - `profile_pic_full` string — Profile full picture URL
    - `status` string — Contact status
    - `phonebook` boolean — If true, the contact is present in the WhatsApp address book on the primary phone
    - `saved` boolean — Deprecated alias for phonebook

## Other responses

- `500` — Internal Error

---

[API](https://skmtc.dev/whapi/apis/whatsapp-api.md) · [All operations](https://skmtc.dev/whapi/apis/whatsapp-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/whapi/whatsapp-api/revisions/40ab05abffdb/schema)