v1

latestOpenAPI 3.0.12026-07-26105162235.7 KB

Mensagens Agendadas

Listar

Listagem paginada de mensagens agendadas com filtros opcionais.

get/v1/scheduled-message

Query parameters

ScheduledAt.Beforestring date-time

Limite superior de busca, sempre em fuso horário UTM.

ScheduledAt.Afterstring date-time

Limite inferior de busca, sempre em fuso horário UTM.

IncludeDetailsstring[]

Lista de detalhes a serem incluídos na resposta

Status da mensagem agendada para filtrar

Type'TEMPLATE' | 'CHATBOT'

Tipo da mensagem agendada para filtrar

Fromstring

ID ou número de telefone do canal cadastrado na conta.

Tostring

ID ou número de telefone do destinatário.

Userstring

ID ou nome do usuário

Departmentstring

ID ou nome da equipe

CreatedAt.Beforestring date-time

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.Afterstring date-time

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Beforestring date-time

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.Afterstring date-time

Limite inferior de busca, sempre em fuso horário UTM.

PageNumberinteger

Número da página a ser obtida.

PageSizeinteger

Tamanho da página a ser obtida.

OrderBystring

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirection'ASCENDING' | 'DESCENDING'

Determina se a ordenação deve ser crescente ou decrescente.

Response

Success

pageNumberinteger

Número da página a ser obtida.

pageSizeinteger

Tamanho da página a ser obtida.

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

totalItemsinteger

totalPagesinteger

hasMorePagesboolean