APIs › Ticket › API Obter Tickets

API Obter Tickets

Todas

Obter a lista de tickets a partir de filtros.

API: Todas

Endpoint

https://apichat.agpt.com.br/api/tickets/get

Método

GET

Autenticação

Bearer {seutokenaqui}

Payload

{
    "pageNumber": 1,
    "status": "open",
    "userId": [1,4],
    "queueIds": [3,16],
    "tags": [211,216],
    "date": null,
    "updatedAt": null,
    "searchParam": null
}

Esta chamada é GET com corpo: existem bibliotecas e servidores intermediários que descartam o corpo de uma requisição GET sem avisar. Se a resposta vier ignorando os filtros que você mandou, é quase sempre isso — use um cliente que permita enviar corpo em GET.

“pageNumber”: número da página (cada página traz de 30 a 40 resultados). Na resposta, "hasMore": true indica que ainda há páginas adiante.

“status”: filtra pelo Status do Ticket — open, pending ou closed. O valor escolhido manda nos três campos seguintes:

open — informe o(s) userId e o(s) queueIds; tags é opcional.

pending — userId fica null; informe o(s) queueIds; tags é opcional.

closed — nada é filtrado: userId, queueIds e tags ficam todos null.

“userId”: ID do atendente.

null quando o status for pending ou closed.

Ou os IDs em array — [1,4] — quando o status for open.

“queueIds”: IDs dos Setores.

null para trazer somente os tickets sem Setor.

Ou os IDs em array — [3,16] —, que traz os desses Setores e também os sem Setor.

“tags”: IDs das Tags.

null para não filtrar por tag, ou seja, trazer todas.

Ou os IDs em array: [211,216].

“date”: data de criação do ticket. null ou no formato ANO-MES-DIA, como 2025-11-20.

“updatedAt”: data de atualização do ticket. null ou no formato ANO-MES-DIA, como 2027-10-16.

“searchParam”: deixe null.

Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://apichat.agpt.com.br/api/tickets/get',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS =>'{
    "pageNumber": 1,
    "status": "open",
    "userId": [1,4],
    "queueIds": [3,16],
    "tags": [211,216],
    "date": null,
    "updatedAt": null,
    "searchParam": null
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;