Listagem de Tickets

Essa funcionalidade permitirá à sua empresa mais visibilidade e controle sobre os tickets relacionados à sua operação em nossa central de atendimento.

Ao chamar o endpoint descrito neste documento retornaremos uma lista com os últimos 200 tickets de suporte ao cliente abertos em nossa central de atendimento, com opções de filtragem por status e data de atualização.

Passos para integrar

1. Enviar o certificado mTLS em todas as chamadas.
2. Realizar geração do token na API - [API Reference]. Ele será utilizado para autenticar nas requisições.
3. Realizar a requisição para listar os tickets [API Reference]

---

Descrição dos campos da chamada | Query Parameters

Nome do Campo	Obrigatório	Tipo	Descrição
status	Não	string	Filtra os tickets pelo status. Valores aceitos: pending, solved, open.
updated_at	Não	string	Filtra os tickets pela data de atualização. O formato deve ser YYYY-MM-DD.

cURL da Chamada

curl -X GET 'https://openfinance.api.celcoin.com.br/painel/v1/support/tickets?status=solved&updated_at=2024-11-26' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{Token}}'

Importante

Caso nenhum filtro seja fornecido na Query String, o endpoint retornará todos os últimos 200 tickets.

Exemplo:

curl -X GET "https://apicorp.celcoin.com.br/painel/v1/support/tickets"

Exemplos de retorno

Sucesso 200

Sucesso 200

[
    {
        "ticket_id": 12345,
        "created_at": "2024-11-25T14:22:35Z",
        "updated_at": "2024-11-26T13:28:35Z",
        "subject": "Exemplo de assunto do ticket",
        "status": "solved",
        "description": "Descrição do ticket.",
        "satisfaction_rating": {
            "score": 5,
            "reason": "Resolução rápida",
            "comment": "Ótimo suporte."
        }
    }
]

Descrição dos campos do retorno com HTTP 200

Nome do Campo	Parâmetros	Tipo	Descrição
ticket_id	body	int	Identificador do ticket
created_at	body	String (date-time)	Data de criação do ticket
updated_at	body	String (date-time)	Data da última atualização do ticket
subject	body	string	Assunto do ticket
status	body	string	Status atual do ticket
description	body	string	Descrição do ticket
satisfaction_rating	body	object	Objeto que retornará os detalhes da resposta enviada na pesquisa de satisfação
score	body	int	Nota enviada
reason	body	string	Motivo da nota enviada
comment	body	string	Comentário sobre o atendimento

---

Error 400

Error 400

{
    "errorCode": 2.2,
    "errorDescription": "Invalid status value. Accepted values are: pending, solved, open. If not provided, all statuses will be listed."
}

Descrição dos campos do retorno com HTTP 400

Nome do Campo	Parâmetros	Tipo	Descrição
errorCode	body	double	Código do erro
errorDescription	body	string	Descrição do erro

---

Tabela de errorCode

Codigo HTTP	errorCode	Message
400	1	Contate nosso time de Atendimento ao Cliente.
400	2.1	Código de cliente não autorizado. Por favor, contate nosso time de Atendimento ao Cliente.
400	2.2	Valor de status inválido. Aceitos: pending, solved, open. Se não informado, todos os status serão listados.
400	2.2	ClientId Inválido – Por favor refaça a autenticação.
400	3	Formato de updated_at inválido. Formato esperado: YYYY-MM-DD. Caso não informado, todas as datas serão consideradas.