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

# Daftar pengiriman terjadwal

> Menampilkan daftar pengiriman terjadwal perangkat. Jadwal mendatang ditampilkan terlebih dahulu (waktu eksekusi berikutnya yang paling dekat di urutan pertama), diikuti jadwal yang telah berakhir, dengan yang terbaru di urutan pertama.



## OpenAPI

````yaml /id/openapi.yml get /send/schedules
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: >
    API ini digunakan untuk mengirim pesan WhatsApp melalui API.


    Dashboard web merupakan proyek terpisah (gowa-ui); server mengunduh aset
    rilis

    terbarunya dan menyajikannya di `/` (atau mengembalikan banner JSON saat

    APP_UI_ENABLED=false).


    Cakupan perangkat:

    - Kirim `X-Device-Id` pada semua panggilan REST yang memiliki cakupan
    perangkat.

    - WebSocket: hubungkan ke `/ws?device_id=<id>`.

    - Autentikasi WebSocket (saat autentikasi dasar diaktifkan): browser tidak
    dapat menyetel
      header Authorization pada koneksi WebSocket, sehingga sertakan juga
      `&authorization=<base64(user:pass)>` dalam query string. Gunakan TLS di
      produksi karena kredensial terlihat di URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Koneksi awal ke server WhatsApp
  - name: device
    description: Pengelolaan perangkat untuk dukungan multi-perangkat
  - name: user
    description: Mengambil informasi
  - name: send
    description: Kirim pesan (teks/gambar/berkas/video).
  - name: message
    description: Manipulasi pesan (cabut/beri reaksi/perbarui).
  - name: call
    description: Pengelolaan panggilan (tolak panggilan masuk)
  - name: chat
    description: Percakapan chat dan perpesanan
  - name: group
    description: Pengaturan grup
  - name: newsletter
    description: Pengaturan newsletter
  - name: chatwoot
    description: Integrasi Chatwoot untuk dukungan pelanggan
paths:
  /send/schedules:
    get:
      tags:
        - send
      summary: Daftar pengiriman terjadwal
      description: >-
        Menampilkan daftar pengiriman terjadwal perangkat. Jadwal mendatang
        ditampilkan terlebih dahulu (waktu eksekusi berikutnya yang paling dekat
        di urutan pertama), diikuti jadwal yang telah berakhir, dengan yang
        terbaru di urutan pertama.
      operationId: listScheduledSends
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - running
              - paused
              - completed
              - failed
              - cancelled
          description: Hanya jadwal dengan status ini
        - name: search
          in: query
          schema:
            type: string
          description: Cocokkan penerima atau teks pesan
        - name: message_type
          in: query
          schema:
            type: string
            enum:
              - text
              - image
              - file
              - video
              - audio
              - sticker
              - contact
              - link
              - location
              - poll
              - forward
          description: Hanya jenis pengiriman terjadwal ini
        - name: limit
          in: query
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
          description: Jumlah maksimal jadwal yang dikembalikan
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: Jumlah jadwal yang dilewati (untuk paginasi)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleListResponse'
        '400':
          description: >-
            Permintaan Tidak Valid (misalnya status atau message_type tidak
            dikenal, limit atau offset di luar rentang)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '500':
          description: Kesalahan Internal Server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Pengenal perangkat untuk dukungan multi-device. Wajib jika beberapa
        perangkat terdaftar.

        Jika hanya satu perangkat terdaftar, perangkat tersebut digunakan
        sebagai default.

        Dapat juga diberikan sebagai parameter kueri `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: Kode Status HTTP
        message:
          type: string
          example: field cannot be blank
          description: Pesan kesalahan terperinci
        results:
          type: object
          example: null
          description: data tambahan
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: you are not loggin
          description: Pesan kesalahan terperinci
        results:
          type: object
          example: null
          description: data tambahan
    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: Pratinjau singkat pesan
        status:
          type: string
          enum:
            - active
            - running
            - paused
            - completed
            - failed
            - cancelled
          example: active
          description: >
            - `active`: menunggu eksekusi berikutnya

            - `running`: diambil oleh worker dan sedang dikirim

            - `paused`: ditahan hingga dilanjutkan

            - `completed`: tidak ada eksekusi tersisa

            - `failed`: dihentikan setelah percobaan ulang atau kesalahan
            validasi

            - `cancelled`: dibatalkan oleh pengguna
        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: Tidak disertakan jika tidak ada eksekusi tersisa
        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: Jumlah pengiriman yang berhasil sejauh ini
        attempts:
          type: integer
          example: 0
          description: Percobaan yang gagal untuk eksekusi saat ini
        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

- [Pengiriman Terjadwal](https://gowa-docs.mintlify.site/id/examples/scheduled-sends.md)
- [Jeda pengiriman terjadwal](https://gowa-docs.mintlify.site/id/api-reference/send/jeda-pengiriman-terjadwal.md)
- [Ambil pengiriman terjadwal](https://gowa-docs.mintlify.site/id/api-reference/send/ambil-pengiriman-terjadwal.md)
- [Batalkan pengiriman terjadwal](https://gowa-docs.mintlify.site/id/api-reference/send/batalkan-pengiriman-terjadwal.md)
- [Lanjutkan pengiriman terjadwal yang dijeda](https://gowa-docs.mintlify.site/id/api-reference/send/lanjutkan-pengiriman-terjadwal-yang-dijeda.md)


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