API – Clickdesk – OpenClick






OpenClick API – Documentação


OpenClick API – Documentação

Autenticação

A API da OpenClick utiliza autenticação via Bearer Token. Todas as requisições devem conter o header:

Authorization: Bearer <seu_token_de_acesso>

Estrutura Base

Base URL:

https://app.clickdesk.openclick.ai/v1

Todas as rotas descritas abaixo são relativas a essa URL.

Contacts

Gerencia os contatos de clientes.

GET /api/v1/accounts/:account_id/contacts
POST /api/v1/accounts/:account_id/contacts
PUT /api/v1/accounts/:account_id/contacts/:id
DELETE /api/v1/accounts/:account_id/contacts/:id

Exemplo de criação

POST /api/v1/accounts/1/contacts
{
  "name": "Maria Souza",
  "email": "maria@cliente.com",
  "phone_number": "+5511999999999"
}

Conversations

Gerencia as conversas (chats e tickets).

GET /api/v1/accounts/:account_id/conversations
POST /api/v1/accounts/:account_id/conversations
PUT /api/v1/accounts/:account_id/conversations/:id

Exemplo de criação

POST /api/v1/accounts/1/conversations
{
  "contact_id": 101,
  "inbox_id": 5,
  "status": "open",
  "message": { "content": "Olá, preciso de ajuda com meu acesso." }
}

Messages

Permite envio e recebimento de mensagens dentro das conversas.

POST /api/v1/accounts/:account_id/conversations/:conversation_id/messages
GET /api/v1/accounts/:account_id/conversations/:conversation_id/messages

Exemplo de envio

POST /api/v1/accounts/1/conversations/123/messages
{
  "content": "Poderia me enviar o boleto atualizado?"
}

Inboxes

Listagem de canais disponíveis (WhatsApp, Chat, E-mail, etc.).

GET /api/v1/accounts/:account_id/inboxes

Agents

Consulta informações dos agentes.

GET /api/v1/accounts/:account_id/agents

Labels

Gerencia etiquetas (tags) aplicáveis a tickets e conversas.

GET /api/v1/accounts/:account_id/labels
POST /api/v1/accounts/:account_id/labels

Reports

Obtém relatórios de performance e volume de atendimento.

GET /api/v1/accounts/:account_id/reports/summary

Eventos disponíveis (Webhooks)

  • conversation_created – Disparado quando uma conversa é criada
  • conversation_status_changed – Quando o status muda (ex: encerramento)
  • message_created – Quando uma mensagem é enviada ou recebida
  • contact_created – Novo contato registrado

Códigos de resposta

Código Descrição
200 OK – Requisição bem-sucedida
201 Criado – Recurso criado com sucesso
400 Requisição inválida
401 Não autorizado (token inválido ou ausente)
404 Recurso não encontrado
422 Erro de validação
500 Erro interno do servidor