> ## 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.

# 获取聊天窗口同步进度

> 返回设备当前同步进度



## OpenAPI

````yaml /zh/openapi.yml get /chatwoot/sync/status
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:
  /chatwoot/sync/status:
    get:
      tags:
        - chatwoot
      summary: 获取聊天窗口同步进度
      description: 返回设备当前同步进度
      operationId: chatwootSyncStatus
      parameters:
        - name: device_id
          in: query
          description: 检查同步状态的设备 ID
          schema:
            type: string
      responses:
        '200':
          description: 同步已获取的状态
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatwootSyncStatusResponse'
        '400':
          description: 错误请求
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
components:
  schemas:
    ChatwootSyncStatusResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Sync status retrieved
        results:
          type: object
          properties:
            device_id:
              type: string
              example: my-device-id
            status:
              type: string
              enum:
                - idle
                - running
                - completed
                - failed
              example: running
            total_chats:
              type: integer
              example: 10
            synced_chats:
              type: integer
              example: 5
            total_messages:
              type: integer
              example: 100
            synced_messages:
              type: integer
              example: 50
            failed_messages:
              type: integer
              example: 2
            current_chat:
              type: string
              example: 628123456789@s.whatsapp.net
            started_at:
              type: string
              format: date-time
            completed_at:
              type: string
              format: date-time
            error:
              type: string
    ErrorBadRequest:
      type: object
      properties:
        code:
          type: string
          example: 400
          description: HTTP 状态代码
        message:
          type: string
          example: field cannot be blank
          description: 详细错误消息
        results:
          type: object
          example: null
          description: 附加数据
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [获取设备的聊天窗口配置](https://gowa-docs.mintlify.site/zh/api-reference/chatwoot/获取设备的聊天窗口配置.md)
- [获取聊天列表](https://gowa-docs.mintlify.site/zh/api-reference/chat/获取聊天列表.md)
- [删除设备的聊天窗口配置](https://gowa-docs.mintlify.site/zh/api-reference/chatwoot/删除设备的聊天窗口配置.md)
- [聊天woot 集成](https://gowa-docs.mintlify.site/zh/integrations/chatwoot.md)
- [创建或更新设备的聊天窗口配置](https://gowa-docs.mintlify.site/zh/api-reference/chatwoot/创建或更新设备的聊天窗口配置.md)


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