> ## 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 /send/schedules
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:
  /send/schedules:
    get:
      tags:
        - send
      summary: 预定发送列表列表
      description: 列出设备的预定发送。 即将到来的时间表排在首位(下次排列最早)，然后是完工的，最新的优先排列。
      operationId: listScheduledSends
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - running
              - paused
              - completed
              - failed
              - cancelled
          description: 仅此状态中的Schedules
        - name: search
          in: query
          schema:
            type: string
          description: 匹配收件人或消息文本
        - name: message_type
          in: query
          schema:
            type: string
            enum:
              - text
              - image
              - file
              - video
              - audio
              - sticker
              - contact
              - link
              - location
              - poll
              - forward
          description: 仅此类型的预定发送
        - name: limit
          in: query
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
          description: 返回计划的最大数量
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: 要跳过的计划数 (用于分页)
      responses:
        '200':
          description: 好的
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleListResponse'
        '400':
          description: 错误请求(例如未知状态或消息类型，限制或偏移超出范围)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '500':
          description: 服务器内部错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: |
        多设备支持的设备标识符。 当多个设备被注册时需要.
        如果只有一个设备被注册，它将被用作默认。
        也可以以 `device_id` 查询参数提供。
      schema:
        type: string
        example: my-device-id
  schemas:
    ScheduleListResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Schedules fetched
        results:
          type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Schedule'
            pagination:
              type: object
              properties:
                limit:
                  type: integer
                  example: 25
                offset:
                  type: integer
                  example: 0
                total:
                  type: integer
                  example: 3
    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: 附加数据
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: you are not loggin
          description: 详细错误消息
        results:
          type: object
          example: null
          description: 附加数据
    Schedule:
      type: object
      properties:
        id:
          type: string
          example: 0b5c3a8e-7f5d-4d6f-9d1e-2f8c1a7b9e10
        message_type:
          type: string
          enum:
            - text
            - image
            - file
            - video
            - audio
            - sticker
            - contact
            - link
            - location
            - poll
            - forward
          example: text
        phone:
          type: string
          example: 6289685028129@s.whatsapp.net
        summary:
          type: string
          example: selamat pagi
          description: 短消息预览
        status:
          type: string
          enum:
            - active
            - running
            - paused
            - completed
            - failed
            - cancelled
          example: active
          description: |
            - `active`：等待下一次执行
            - `running`：已由工作进程领取，正在发送
            - `paused`：已暂停，等待恢复
            - `completed`：没有剩余执行次数
            - `failed`：重试后放弃，或发生验证错误
            - `cancelled`：已被用户取消
        scheduled_at:
          type: string
          format: date-time
          example: '2026-10-01T02:00:00Z'
        next_run_at:
          type: string
          format: date-time
          example: '2026-10-01T02:00:00Z'
          description: 没有剩余运行时关闭
        timezone:
          type: string
          example: Asia/Jakarta
        recurrence:
          type: string
          enum:
            - once
            - daily
            - weekly
            - monthly
          example: once
        weekdays:
          type: array
          items:
            type: integer
          example:
            - 1
            - 3
            - 5
        day_of_month:
          type: integer
          example: 15
        end_at:
          type: string
          format: date-time
        occurrence_limit:
          type: integer
          example: 10
        occurrence_count:
          type: integer
          example: 0
          description: 到目前为止成功发送的次数
        attempts:
          type: integer
          example: 0
          description: 尝试当前运行失败
        last_run_at:
          type: string
          format: date-time
        last_message_id:
          type: string
          example: 3EB0B430B6F8F1D0E053AC120E0A9E5C
        last_error:
          type: string
        created_at:
          type: string
          format: date-time
          example: '2026-09-25T08:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-09-25T08:00:00Z'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [预定发送](https://gowa-docs.mintlify.site/zh/examples/scheduled-sends.md)
- [恢复已暂停的预定发送](https://gowa-docs.mintlify.site/zh/api-reference/send/恢复已暂停的预定发送.md)
- [发送实验性交互消息](https://gowa-docs.mintlify.site/zh/api-reference/send/发送实验性交互消息.md)
- [用户我的列表组](https://gowa-docs.mintlify.site/zh/api-reference/user/用户我的列表组.md)
- [暂停预定的发送](https://gowa-docs.mintlify.site/zh/api-reference/send/暂停预定的发送.md)


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