Início / Documentação da API Connect

API para ações em Tickets




Este módulo é dedicado à gestão de Tickets, que representam atendimentos ou interações com clientes dentro do sistema. Por meio das APIs descritas aqui, é possível criar, consultar, atualizar e encerrar tickets, além de realizar ações administrativas, como transferi-los entre filas ou conexões. 🔃






📌 API Criar Ticket


API: Todas

Crie um ticket, para iniciar uma conversa com um cliente.

Verifique aqui os Pré-Requisitos para utilizar APIs

Endpoint POST


https://https://api.gpconnect.com.br/api/tickets/createTicketAPI


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

📤 Endpoint

URL:

POST https://https://api.gpconnect.com.br/api/tickets/createTicketAPI


🔐 Autenticação

A autenticação é feita via token Bearer.

Cabeçalho:

Authorization: Bearer {seutokenaqui}




📥 Parâmetros da Requisição

A requisição deve ser enviada com o tipo de conteúdo application/json.

Corpo (JSON)

{

  "contactId": 9580

}


Campo

Tipo

Obrigatório

Descrição

contactId

int

Sim

ID do contato ao qual o ticket será vinculado.



💻 Exemplo de Código (PHP com cURL)


<?php


$curl = curl_init();


curl_setopt_array($curl, array(

  CURLOPT_URL => 'https://https://api.gpconnect.com.br/api/tickets/createTicketAPI',

  CURLOPT_RETURNTRANSFER => true,

  CURLOPT_ENCODING => '',

  CURLOPT_MAXREDIRS => 10,

  CURLOPT_TIMEOUT => 0,

  CURLOPT_FOLLOWLOCATION => true,

  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

  CURLOPT_CUSTOMREQUEST => 'POST',

  CURLOPT_POSTFIELDS =>'{

    "contactId": 9580

  }',

  CURLOPT_HTTPHEADER => array(

    'Content-Type: application/json',

    'Authorization: Bearer {seutokenaqui}' // Token cadastrado na conexão

  ),

));


$response = curl_exec($curl);


curl_close($curl);

echo $response;




✅ Resposta Esperada

Exemplo de Resposta (Sucesso)


{

  "status": "success",

  "ticketId": 12345,

  "message": "Ticket criado com sucesso."

}




⚠️ Possíveis Erros

Código HTTP

Descrição

Causa Provável

400

Bad Request

Campo contactId ausente ou inválido

401

Unauthorized

Token de autenticação ausente ou incorreto

500

Internal Server Error

Erro inesperado no servidor da API







📌 API Obter um Ticket


API: Todas

Obter um ticket específico.

Verifique aqui os Pré-Requisitos para utilizar APIs
Endpoint POST

https://https://api.gpconnect.com.br/api/tickets/updateAPI

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


📤 Endpoint

URL:

POST https://https://api.gpconnect.com.br/api/tickets/updateAPI


🔐 Autenticação

A autenticação é feita via token Bearer.

Cabeçalho:

Authorization: Bearer {seutokenaqui}




📥 Parâmetros da Requisição

A requisição deve ser enviada com o tipo de conteúdo application/json.

Corpo (JSON)

{

  "ticketId": "2003"

}


Campo

Tipo

Obrigatório

Descrição

ticketId

string

Sim

ID do ticket que será atualizado ou reaberto.



💻 Exemplo de Código (PHP com cURL)

<?php


$curl = curl_init();


curl_setopt_array($curl, array(

  CURLOPT_URL => 'https://https://api.gpconnect.com.br/api/tickets/updateAPI',

  CURLOPT_RETURNTRANSFER => true,

  CURLOPT_ENCODING => '',

  CURLOPT_MAXREDIRS => 10,

  CURLOPT_TIMEOUT => 0,

  CURLOPT_FOLLOWLOCATION => true,

  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

  CURLOPT_CUSTOMREQUEST => 'POST',

  CURLOPT_POSTFIELDS =>'{

    "ticketId": "2003"

  }',

  CURLOPT_HTTPHEADER => array(

    'Content-Type: application/json',

    'Authorization: Bearer {seutokenaqui}' // Token cadastrado na conexão

  ),

));


$response = curl_exec($curl);


curl_close($curl);

echo $response;




✅ Resposta Esperada
Exemplo de Resposta (Sucesso)

{

  "status": "success",

  "message": "Ticket atualizado com sucesso."

}


A ação exata dependerá da lógica do backend (ex: reabertura, movimentação de fila, atribuição etc.).



⚠️ Possíveis Erros

Código HTTP

Descrição

Causa Provável

400

Bad Request

Campo ticketId ausente ou inválido

401

Unauthorized

Token ausente ou inválido

404

Not Found

Ticket com o ID informado não encontrado

500

Internal Server Error

Erro inesperado no servidor





📌 API Obter Tickets do Contato

API: Todas

Obter TODOS os tickets do contato, em todas conexões. Lembre-se: um ticket é uma conversa aberta entre um contato e uma conexão.

Verifique aqui os Pré-Requisitos para utilizar APIs
Endpoint GET


https://https://api.gpconnect.com.br/api/contacts/alltickets



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

Visão Geral

Este documento descreve como utilizar a API para consultar todos os tickets associados a um contato específico, utilizando o número de telefone no formato internacional. A requisição é feita via método GET com corpo JSON e autenticação por token.



📤 Endpoint

URL:

ruby

CopiarEditar

GET https://https://api.gpconnect.com.br/api/contacts/alltickets


🔐 Autenticação

A autenticação é feita via token Bearer.

Cabeçalho:

Authorization: Bearer {seutokenaqui}




📥 Parâmetros da Requisição

Embora o método HTTP seja GET, esta API aceita corpo JSON com os dados de busca.

Corpo (JSON)


{

  "number": "5511989091838"

}


Campo

Tipo

Obrigatório

Descrição

number

string

Sim

Número de telefone no formato internacional (ex: 55...).



💻 Exemplo de Código (PHP com cURL)


<?php


$curl = curl_init();


curl_setopt_array($curl, array(

  CURLOPT_URL => 'https://https://api.gpconnect.com.br/api/contacts/alltickets',

  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 =>'{

    "number":"5511989091838"

  }',

  CURLOPT_HTTPHEADER => array(

    'Content-Type: application/json',

    'Authorization: Bearer {seutokenaqui}' // Token cadastrado na conexão

  ),

));


$response = curl_exec($curl);


curl_close($curl);

echo $response;




✅ Resposta Esperada

Exemplo de Resposta (Sucesso)


{

  "status": "success",

  "tickets": [

    {

      "ticketId": 123,

      "status": "open",

      "createdAt": "2024-03-01T12:30:00.000Z",

      "queue": "Suporte"

    },

    {

      "ticketId": 124,

      "status": "closed",

      "createdAt": "2024-02-15T09:00:00.000Z",

      "queue": "Comercial"

    }

  ]

}




⚠️ Possíveis Erros

Código HTTP

Descrição

Causa Provável

400

Bad Request

Campo number ausente ou mal formatado

401

Unauthorized

Token de autenticação ausente ou inválido

404

Not Found

Nenhum ticket encontrado para o número informado

500

Internal Server Error

Erro interno no servidor da API





📌 API Atualizar Ticket

API: Todas

Atualize um ticket, alterando seu status, fila, atendente, typebot, ou campos personalziados.

Verifique aqui os Pré-Requisitos para utilizar APIs

Endpoint POST

https://https://api.gpconnect.com.br/api/tickets/updateAPI


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

📌 Visão Geral

Este documento descreve como utilizar a API para atualizar um ticket existente com múltiplos campos, como status, usuário, fila, campos personalizados (customA, customB, typebot_sessionId) e mais.



📤 Endpoint

URL:

POST https://https://api.gpconnect.com.br/api/tickets/updateAPI



🔐 Autenticação

A autenticação é feita via token Bearer.

Cabeçalho:

Authorization: Bearer {seutokenaqui}




📥 Parâmetros da Requisição

A requisição deve ser enviada com o tipo de conteúdo application/json.

Corpo (JSON)

{

  "ticketId": "1067",

  "status": "pending",

  "userId": "13",

  "queueId": "34",

  "typebot_sessionId": "CAMPO LIVRE LETRAS E NÚMEROS",

  "customA": "CAMPO LIVRE LETRAS E NÚMEROS",

  "customB": "CAMPO LIVRE LETRAS E NÚMEROS"

}


Campo

Tipo

Obrigatório

Descrição

ticketId

string

Sim

ID do ticket que será atualizado.

status

string

Não

Novo status do ticket (open, pending, closed).

userId

string

Não

ID do atendente (ou null para não alterar).

queueId

string

Não

ID da fila (ou null para não alterar).

typebot_sessionId

string

Não

Campo livre para integrar com sessões do Typebot (ou outros).

customA

string

Não

Campo livre personalizado A.

customB

string

Não

Campo livre personalizado B.



💻 Exemplo de Código (PHP com cURL)

<?php


$curl = curl_init();


curl_setopt_array($curl, array(

  CURLOPT_URL => 'https://https://api.gpconnect.com.br/api/tickets/updateAPI',

  CURLOPT_RETURNTRANSFER => true,

  CURLOPT_ENCODING => '',

  CURLOPT_MAXREDIRS => 10,

  CURLOPT_TIMEOUT => 0,

  CURLOPT_FOLLOWLOCATION => true,

  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

  CURLOPT_CUSTOMREQUEST => 'POST',

  CURLOPT_POSTFIELDS =>'{

    "ticketId": "1067",

    "status": "pending",

    "userId": "13",

    "queueId": "34",

    "typebot_sessionId": "CAMPO LIVRE LETRAS E NÚMEROS",

    "customA": "CAMPO LIVRE LETRAS E NÚMEROS",

    "customB": "CAMPO LIVRE LETRAS E NÚMEROS"

  }',

  CURLOPT_HTTPHEADER => array(

    'Content-Type: application/json',

    'Authorization: Bearer {seutokenaqui}' // Token cadastrado na conexão

  ),

));


$response = curl_exec($curl);


curl_close($curl);

echo $response;




✅ Resposta Esperada

Exemplo de Resposta (Sucesso)


{

  "status": "success",

  "message": "Ticket atualizado com sucesso."

}




⚠️ Possíveis Erros

Código HTTP

Descrição

Causa Provável

400

Bad Request

Campo obrigatório ausente ou mal formatado

401

Unauthorized

Token de autenticação inválido ou ausente

404

Not Found

Ticket não encontrado

500

Internal Server Error

Erro interno na aplicação




📌API Atualizar Tags

API: Todas

Vincule tags à um ticket. Tenha em mente que ao utilizar esse api, todas as tags serão apagadas e serão adicionadas as tags definidas no código.


 Visão Geral

Este documento explica como utilizar a API para vincular uma ou mais TAGs a um ticket. As TAGs permitem classificar e organizar os atendimentos com base em categorias, status ou ações específicas.


📤 Endpoint

URL:
POST https://https://api.gpconnect.com.br/api/tags/add


🔐 Autenticação

A autenticação é feita via token Bearer.

Cabeçalho:

Authorization: Bearer {seutokenaqui}




📥 Parâmetros da Requisição

A requisição deve conter um corpo em JSON, indicando o ticketId e uma lista de objetos com os ids das TAGs.

Corpo (JSON)

{

  "ticketId": 383,

  "tags": [

    { "id": 100 },

    { "id": 98 }

  ]

}


Campo

Tipo

Obrigatório

Descrição

ticketId

inteiro

Sim

ID do ticket ao qual as TAGs serão vinculadas

tags

array de objetos

Sim

Lista de TAGs a serem adicionadas ao ticket

tags[].id

inteiro

Sim

ID da TAG que será associada



💻 Exemplo de Código (PHP com cURL)


<?php


$curl = curl_init();


curl_setopt_array($curl, array(

  CURLOPT_URL => 'https://https://api.gpconnect.com.br/api/tags/add',

  CURLOPT_RETURNTRANSFER => true,

  CURLOPT_ENCODING => '',

  CURLOPT_MAXREDIRS => 10,

  CURLOPT_TIMEOUT => 0,

  CURLOPT_FOLLOWLOCATION => true,

  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

  CURLOPT_CUSTOMREQUEST => 'POST',

  CURLOPT_POSTFIELDS =>'{

    "ticketId": 383,

    "tags": [

      {

        "id": 100

      },

      {

        "id": 98

      }

    ]

  }',

  CURLOPT_HTTPHEADER => array(

    'Content-Type: application/json',

    'Authorization: Bearer {seutokenaqui}' // Token cadastrado na conexão

  ),

));


$response = curl_exec($curl);


curl_close($curl);

echo $response;




✅ Resposta Esperada

Exemplo de Resposta (Sucesso)

{

  "status": "success",

  "message": "Tags adicionadas ao ticket com sucesso."

}




⚠️ Possíveis Erros

Código HTTP

Descrição

Causa Provável

400

Bad Request

Campos ausentes ou formato incorreto

401

Unauthorized

Token inválido ou ausente

404

Not Found

Ticket ou TAG não encontrados

500

Internal Server Error

Erro interno no servidor ou falha ao associar TAGs







📌 API Encerrar Ticket


API: Todas

Encerrar um ticket, alterando seu status.



Visão Geral

Este documento descreve como utilizar a API para encerrar um ticket ao atualizar seu status para closed.


📤 Endpoint

URL: POST https://https://api.gpconnect.com.br/api/tickets/updateAPI


🔐 Autenticação

A autenticação é realizada através de um token do tipo Bearer.

Cabeçalho:


Authorization: Bearer {seutokenaqui}




📥 Parâmetros da Requisição

A requisição deve ser enviada no formato JSON com os seguintes parâmetros:

Corpo (JSON)

json

CopiarEditar

{

  "ticketId": "1067",

  "status": "closed"

}


Campo

Tipo

Obrigatório

Descrição

ticketId

string

Sim

ID do ticket a ser encerrado

status

string

Sim

Novo status do ticket. Para encerrar, use "closed"



💻 Exemplo de Código (PHP com cURL)


<?php


$curl = curl_init();


curl_setopt_array($curl, array(

  CURLOPT_URL => 'https://https://api.gpconnect.com.br/api/tickets/updateAPI',

  CURLOPT_RETURNTRANSFER => true,

  CURLOPT_ENCODING => '',

  CURLOPT_MAXREDIRS => 10,

  CURLOPT_TIMEOUT => 0,

  CURLOPT_FOLLOWLOCATION => true,

  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

  CURLOPT_CUSTOMREQUEST => 'POST',

  CURLOPT_POSTFIELDS =>'{

    "ticketId": "1067",

    "status": "closed"

  }',

  CURLOPT_HTTPHEADER => array(

    'Content-Type: application/json',

    'Authorization: Bearer {seutokenaqui}' // Token cadastrado na conexão

  ),

));


$response = curl_exec($curl);


curl_close($curl);

echo $response;




✅ Resposta Esperada

Exemplo de Resposta (Sucesso)


{

  "status": "success",

  "message": "Ticket atualizado com sucesso."

}




⚠️ Possíveis Erros

Código HTTP

Descrição

Causa Provável

400

Bad Request

JSON mal formatado ou campos ausentes

401

Unauthorized

Token inválido ou expirado

404

Not Found

Ticket com ticketId informado não existe

500

Internal Server Error

Erro interno na aplicação






📌API Transferir Tickets para uma Fila


API: Todas

Transferir todos os Tickets abertos para uma fila específica

– “NEW_queueId”: ID da fila que será atribuída a todos os tickets





Visão Geral

Este documento descreve tecnicamente a utilização de uma API REST para alteração da fila (queue) de um chamado (ticket) em um sistema de atendimento. A chamada é feita via POST utilizando PHP com a biblioteca cURL.

Essa API é útil em sistemas de suporte, help desks e call centers que precisam transferir um chamado para uma nova fila ou setor automaticamente. O endpoint requer autenticação via Bearer Token e os dados devem ser enviados em formato JSON.


📘 Detalhamento Técnico

1. Endpoint

  • https://https://api.gpconnect.com.br/api/tickets/changequeue

    • Este é o endpoint responsável por alterar a fila do chamado.



2. Método HTTP

  • POST

    • Indica que estamos enviando dados para alterar um recurso (no caso, a fila do chamado).



3. Headers

  • Content-Type: application/json

    • Especifica que os dados enviados estão em formato JSON.

  • Authorization: Bearer {seutokenaqui}

    • Substitua {seutokenaqui} pelo token de autenticação da API.

    • Necessário para autenticação e segurança da requisição.



4. Corpo da Requisição (JSON)


{

  "NEW_queueId": 94

}


  • NEW_queueId: o ID da nova fila para onde o chamado será movido. Este valor deve ser um número inteiro correspondente a uma fila existente no sistema

✅ Exemplo de Resposta Esperada

A resposta da API dependerá do sistema backend, mas um exemplo típico pode ser:

{

  "success": true,

  "message": "Fila alterada com sucesso",

  "ticketId": 12345,

  "newQueueId": 94

}




⚠️ Possíveis Erros


Código

Mensagem

Causa Provável

401

Unauthorized

Token inválido ou expirado.

400

Bad Request

JSON malformado ou campo obrigatório ausente.

404

Not Found

ID da fila não encontrado.

500

Internal Server Error

Problemas no servidor backend.







Visão Geral

Este manual descreve o funcionamento de uma API REST utilizada para alterar a conexão de um chamado (ticket). Essa funcionalidade é útil em sistemas de atendimento omnichannel, onde um chamado precisa ser transferido entre diferentes conexões configuradas, como instâncias de WhatsApp, e-mail ou outros canais integrados.

A requisição é feita via POST e exige autenticação com token Bearer. Os dados devem ser enviados em JSON, especificando o ID da conexão atual e da nova conexão.



📂 Estrutura do Código

php

CopiarEditar

<?php


$curl = curl_init();


curl_setopt_array($curl, array(

  CURLOPT_URL => 'https://https://api.gpconnect.com.br/api/tickets/changeconnection',

  CURLOPT_RETURNTRANSFER => true,

  CURLOPT_ENCODING => '',

  CURLOPT_MAXREDIRS => 10,

  CURLOPT_TIMEOUT => 0,

  CURLOPT_FOLLOWLOCATION => true,

  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

  CURLOPT_CUSTOMREQUEST => 'POST',

  CURLOPT_POSTFIELDS =>'{

    "OLD_connectionId":158,

    "NEW_connectionId":159

  }',

  CURLOPT_HTTPHEADER => array(

    'Content-Type: application/json',

    'Authorization: Bearer {seutokenaqui}'

  ),

));


$response = curl_exec($curl);


curl_close($curl);

echo $response;






📌API Transferir Tickets entre Conexões

API: Todas

Transferir todos os Tickets de uma conexão para outra.

– “OLD_connectionId”: ID da conexão que irá transferir seus tickets

– “NEW_connectionId”: ID da conexão que recebe a transferência dos tickets


📘 Detalhamento Técnico

1. Endpoint

  • https://https://api.gpconnect.com.br/api/tickets/changeconnection

    • Esse endpoint realiza a alteração da conexão de um chamado existente.



2. Método HTTP

  • POST

    • Envia os dados para o servidor para modificar o estado do chamado, trocando a conexão associada.



3. Headers

  • Content-Type: application/json

    • Indica que os dados estão em formato JSON.

  • Authorization: Bearer {seutokenaqui}

    • Token de autenticação necessário para acessar o endpoint.

    • Substitua {seutokenaqui} por um token válido e autorizado.



4. Corpo da Requisição (JSON)

json

CopiarEditar

{

  "OLD_connectionId": 158,

  "NEW_connectionId": 159

}


  • OLD_connectionId: ID da conexão atual do chamado.

  • NEW_connectionId: ID da nova conexão para a qual o chamado será transferido.

Ambos os IDs devem ser válidos e cadastrados previamente no sistema.

✅ Exemplo de Resposta Esperada

A resposta JSON da API pode variar, mas geralmente segue um padrão como:

json

CopiarEditar

{

  "success": true,

  "message": "Conexão do chamado alterada com sucesso",

  "ticketId": 12345,

  "oldConnectionId": 158,

  "newConnectionId": 159

}




⚠️ Possíveis Erros e Soluções

Código

Mensagem

Causa Provável

401

Unauthorized

Token de acesso inválido ou ausente.

400

Bad Request

JSON malformado ou campos obrigatórios faltando.

404

Not Found

ID da conexão não encontrado.

409

Conflict

O chamado não pode ser movido (restrições internas).

500

Internal Server Error

Erro no servidor backend.



📝 Observações Finais

  • Certifique-se de que ambas as conexões (OLD e NEW) estejam ativas e configuradas corretamente no sistema.

  • Esse tipo de alteração pode impactar o histórico e o rastreamento do chamado, então recomenda-se registrar a ação internamente.



Atualizado em 22/04/2025
Este artigo foi útil?  
Agradecemos sua avaliação.

Sumário