v1

latestOpenAPI 3.0.12026-08-04115177259.2 KB

Conversas

Listar

Listagem paginada de conversas.

get/v2/session

Query parameters

Statusstring[]

Filtro por status da conversa.

DepartmentIdstring uuid

Filtro por ID da equipe.

UserIdstring uuid

Filtro por ID do usuário.

TagsIdstring[]

Filtro por IDs de etiquetas

TagsNamestring[]

Filtro por nomes de etiquetas

ChannelsIdstring[]

Filtro por ID de canais

ContactIdstring uuid

Filtro por ID do contato.

EndAt.Beforestring date-time

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

EndAt.Afterstring date-time

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

ActiveAt.Beforestring date-time

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

ActiveAt.Afterstring date-time

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

LastInteractionAt.Beforestring date-time

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

LastInteractionAt.Afterstring date-time

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

IncludeDetailsstring[]

Inclua detalhes de outras entidades no resultado da sua busca.

Metadataobject

Filtro por metadados.

Type'INDIVIDUAL' | 'GROUP'

Filtro por tipo da conversa.

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