> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 健康检查

> 在 `/health` 注册的公开健康检查探针；其路径不带 `APP_BASE_PATH` 前缀。



## OpenAPI

````yaml /zh/openapi.yml get /health
openapi: 3.0.0
info:
  title: WhatsApp API 多设备
  version: 9.7.0
  description: |
    此 API 用于通过 API 发送什么应用。

    Web 仪表板是一个单独的项目(gowa-ui)； 服务器下载它的
    最新版本资产并在 `/` 处服务(或在
    APP_UI_ENABLED=false时返回一个 JSON 横幅)。

    设备范围：
    - 在所有设备范围的REST 调用上发送 `X-Device-Id` 。
    - WebSocket: 连接到"/w?device_id=<id>`.
    - WebSocket 身份验证（启用基本身份验证时）：浏览器无法为
      WebSocket 连接设置 Authorization 请求头，因此还需在
      查询字符串中传入 `&authorization=<base64(user:pass)>`。 在
      生产中使用TLS ，因为凭据在 URL 中可见。
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: 初始连接到 Whatsapp 服务器
  - name: device
    description: 多设备支持的设备管理
  - name: user
    description: 获取信息
  - name: send
    description: 发送消息 (Text/Image/File/Video)。
  - name: message
    description: 消息操作 (撤销/react/update)。
  - name: call
    description: 通话管理 (拒绝来电)
  - name: chat
    description: 聊天对话和消息
  - name: group
    description: 组设置
  - name: newsletter
    description: 通讯设置
  - name: chatwoot
    description: 客户支持的聊天窗口集成
paths:
  /health:
    get:
      tags:
        - app
      summary: 健康检查
      description: 在 `/health` 注册的公开健康检查探针；其路径不带 `APP_BASE_PATH` 前缀。
      operationId: health
      responses:
        '200':
          description: 服务健康
          content:
            text/plain:
              schema:
                type: string
                example: OK
        '503':
          description: 服务不可用
          content:
            text/plain:
              schema:
                type: string
                example: Service Unavailable
      security: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [检查用户是否在WhatsApp](https://gowa-docs.mintlify.site/zh/api-reference/user/检查用户是否在whatsapp.md)
- [获取服务器健康度量表](https://gowa-docs.mintlify.site/zh/api-reference/app/获取服务器健康度量表.md)
- [错误处理](https://gowa-docs.mintlify.site/zh/advanced/error-handling.md)
- [正在发送消息](https://gowa-docs.mintlify.site/zh/examples/sending-messages.md)
- [聊天woot 集成](https://gowa-docs.mintlify.site/zh/integrations/chatwoot.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.