v1

latestOpenAPI 3.0.12026-08-04115177259.2 KB
Chatbots

Listar

Listagem de chatbots.

get/v1/chatbot

Query parameters

Namestring

Filtro por nome do chatbot.

Typesstring[]

Filtro por tipo de uso do chatbot. É possível informar mais de um tipo.

ChannelIdsstring[]

Filtro por ID do canal. É possível informar mais de um ID.

DefaultDepartmentIdsstring[]

Filtro por ID da equipe padrão. É possível informar mais de um ID.

PublishStatusesstring[]

Filtro por status de publicação do chatbot. É possível informar mais de um status.

AutomationUsagesstring[]

Filtro por disponibilidade da automação. É possível informar mais de uma disponibilidade.

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