---
title: "Listar"
method: GET
path: "/v1/scheduled-message"
tags: ["Mensagens Agendadas"]
---

# Listar

`GET /v1/scheduled-message`

Listagem paginada de mensagens agendadas com filtros opcionais.

## Query parameters

- `ScheduledAt.Before` string, date-time
- `ScheduledAt.After` string, date-time
- `IncludeDetails` string[]
- `Status` 'SCHEDULED' | 'PROCESSED' | 'SENT' | 'DELIVERED' | 'READ' | 'CANCELED' | 'FAILED'
- `Type` 'TEMPLATE' | 'CHATBOT'
- `From` string
- `To` string
- `User` string
- `Department` string
- `CreatedAt.Before` string, date-time
- `CreatedAt.After` string, date-time
- `UpdatedAt.Before` string, date-time
- `UpdatedAt.After` string, date-time
- `PageNumber` integer
- `PageSize` integer
- `OrderBy` string
- `OrderDirection` 'ASCENDING' | 'DESCENDING'

## Response `200`

Success

- PublicScheduledMessageDTOPublicPageListDTO
  - `pageNumber` integer — Número da página a ser obtida.
  - `pageSize` integer — Tamanho da página a ser obtida.
  - `orderBy` string, nullable — Nome do campo para ser utilizado como pivô da ordenação.
  - `orderDirection` 'ASCENDING' | 'DESCENDING', nullable — Determina se a ordenação deve ser crescente ou decrescente.
  - `items` PublicScheduledMessageDTO[], nullable
    - `id` string, uuid — Identificador único da mensagem agendada
    - `createdAt` string, date-time — Data e hora de criação da mensagem agendada
    - `updatedAt` string, date-time — Data e hora da última atualização da mensagem agendada
    - `active` boolean — Indica se a mensagem agendada está ativa
    - `companyId` string, uuid — Identificador da empresa associada à mensagem agendada
    - `sessionId` string, uuid, nullable — Identificador da sessão
    - `contactId` string, uuid — Identificador do contato que receberá a mensagem
    - `userId` string, uuid — Identificador do usuário que criou a mensagem agendada
    - `channelId` string, uuid — Identificador do canal onde a mensagem será enviada
    - `departmentId` string, uuid, nullable — ID da equipe
    - `status` 'SCHEDULED' | 'PROCESSED' | 'SENT' | 'DELIVERED' | 'READ' | 'CANCELED' | 'FAILED' — Status atual da mensagem agendada
    - `type` 'TEMPLATE' | 'CHATBOT' — Tipo da mensagem agendada
    - `templateId` string, uuid, nullable — Identificador do template utilizado
    - `botId` string, uuid, nullable — Chave do chatbot associado
    - `scheduling` string, date-time — Data e hora programada para envio da mensagem
    - `hiddenSession` boolean — Indica se a sessão deve ficar oculta
    - `failureReason` string, nullable — Indica o motivo de falha caso ocorra
    - `contact` PublicScheduledMessageContactDTO
      - `id` string, uuid — Identificador único do contato
      - `name` string, nullable — Nome do contato
      - `phonenumberFormatted` string, nullable — Número de telefone formatado do contato
      - `instagram` string, nullable — Usuário do Instagram do contato
      - `pictureUrl` string, nullable — URL da foto de perfil do contato
    - `user` PublicScheduledMessageUserDTO
      - `id` string, uuid — Identificador único do usuário
      - `name` string, nullable — Nome do usuário
    - `channel` PublicScheduledMessageChannelDTO
      - `id` string, uuid — Identificador único do canal
      - `humanId` string, nullable — Identificador humano do canal
      - `type` 'GupShup_WhatsApp' | 'Dialog360_WhatsApp' | 'CloudAPI_WhatsApp' | 'ZAPI_WhatsApp' | 'EvolutionApi_WhatsApp' | 'Instagram' | 'Messenger' — Tipo do canal (WhatsApp, Instagram, etc.)
    - `department` PublicScheduledMessageDepartmentDTO
      - `id` string, uuid — Identificador único do departamento
      - `name` string, nullable — Nome do departamento
    - `chatbot` PublicScheduledMessageChatBotDTO
      - `id` string, uuid — Chave única do chatbot
      - `botId` string, uuid — Id do chatbot
      - `name` string, nullable — Nome do chatbot
    - `template` PublicScheduledMessageTemplateDTO
      - `id` string, uuid — Identificador único do template
      - `name` string, nullable — Nome do template
      - `templateParams` PublicResponseScheduledMessageTemplateParamsDTO
        - `parameters` object, nullable — Parâmetros do modelo de mensagem. Obrigatório caso o modelo de mensagem informado no `templateId` possua parâmetros.
        - `file` PublicFileDTO
          - `id` string, uuid
          - `companyId` string, uuid, nullable
          - `userId` string, uuid, nullable
          - `name` string, nullable
          - `extension` string, nullable
          - `mimeType` string, nullable
          - `type` 'UNDEFINED' | 'PDF' | 'EXCEL' | 'WORD' | 'IMAGE' | 'AUDIO' | 'VIDEO'
          - `publicUrl` string, nullable
          - `publicUrlDownload` string, nullable
          - `size` integer
          - `isThumbnail` boolean
          - `thumbnail` PublicFileThumbnailDTO
            - `id` string, uuid
            - `publicUrl` string, nullable
  - `totalItems` integer
  - `totalPages` integer
  - `hasMorePages` boolean

## Other responses

- `500` — Server Error

---

[API](https://skmtc.net/helena/apis/core.md) · [All operations](https://skmtc.net/helena/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helena/core/versions/811b2cdd2ec2/schema)