Endpoints

Referência: atendimentos e equipe

Atendimentos (protocolos), equipe, setores, regras e o relatório.

Nesta página

Todos os exemplos de resposta foram gerados chamando a API de verdade. Os caminhos são relativos à base URL e toda chamada leva Authorization: Bearer nck_….

Base URLhttps://app.nextchat.nextsistem.dev.br/api/integrations/v1

Os campos do atendimento estão explicados em Eventos do webhook.

Listar atendimentos (protocolos)

GET /attendances Permissão attendances:read

Filtros (query string)

Parâmetro	Tipo	Descrição
`status`	texto	open ou closed. · `open`, `closed`
`assignee`	texto	UUID ou none.
`sector`	texto	UUID do setor.
`conversation`	texto	UUID da conversa.
`protocol`	texto	Número do protocolo, com ou sem NC-.
`from`	texto	Abertos a partir de (RFC 3339 ou AAAA-MM-DD).
`to`	texto	Abertos antes de.
`limit`	número	Itens por página (1 a 100).
`cursor`	texto	next_cursor da página anterior.

Exemplo de chamada

GET/attendancesbash

curl -X GET "$NEXTCHAT_API/attendances" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "items": [
    {
      "id": "a270b2ea-057c-4186-b741-4d9e4c9059a1",
      "protocol": 1,
      "status": "open",
      "opened_by": "customer",
      "sector_id": null,
      "assignee_id": null,
      "opened_at": "2026-10-22T22:26:56.252601-03:00",
      "first_response_at": "2026-10-22T22:26:56.396776-03:00",
      "closed_at": null,
      "close_reason": "",
      "protocol_label": "NC-000001",
      "conversation_id": "15917920-d305-4888-901a-1f4a4d713537",
      "channel_id": "8802af70-1081-432c-b48a-5e06df19e0e9",
      "contact_name": "Maria Souza",
      "contact_phone": "5511988887777",
      "assignee_name": "",
      "first_response_by": "5c82d935-9e12-41d5-b3ff-5ea839823470"
    }
  ],
  "next_cursor": null
}

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.

Detalhar atendimento

GET /attendances/{id} Permissão attendances:read

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID)

Exemplo de chamada

GET/attendances/{id}bash

curl -X GET "$NEXTCHAT_API/attendances/{id}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "id": "a270b2ea-057c-4186-b741-4d9e4c9059a1",
  "protocol": 1,
  "status": "open",
  "opened_by": "customer",
  "sector_id": null,
  "assignee_id": null,
  "opened_at": "2026-10-22T22:26:56.252601-03:00",
  "first_response_at": "2026-10-22T22:26:56.396776-03:00",
  "closed_at": null,
  "close_reason": "",
  "protocol_label": "NC-000001",
  "conversation_id": "15917920-d305-4888-901a-1f4a4d713537",
  "channel_id": "8802af70-1081-432c-b48a-5e06df19e0e9",
  "contact_name": "Maria Souza",
  "contact_phone": "5511988887777",
  "assignee_name": "",
  "first_response_by": "5c82d935-9e12-41d5-b3ff-5ea839823470"
}

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.

Atendimento atual da conversa

GET /conversations/{id}/attendance Permissão attendances:read

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID)

Exemplo de chamada

GET/conversations/{id}/attendancebash

curl -X GET "$NEXTCHAT_API/conversations/{id}/attendance" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "id": "a270b2ea-057c-4186-b741-4d9e4c9059a1",
  "protocol": 1,
  "status": "open",
  "opened_by": "customer",
  "sector_id": null,
  "assignee_id": null,
  "opened_at": "2026-10-22T22:26:56.252601-03:00",
  "first_response_at": "2026-10-22T22:26:56.396776-03:00",
  "closed_at": null,
  "close_reason": ""
}

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.

Histórico de responsáveis

GET /conversations/{id}/assignments Permissão attendances:read

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID)

Exemplo de chamada

GET/conversations/{id}/assignmentsbash

curl -X GET "$NEXTCHAT_API/conversations/{id}/assignments" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[
  {
    "user_id": "c0ee6c5f-9199-4421-a6a5-290a2cfc4391",
    "user_name": "Ana Souza",
    "previous_user_id": null,
    "previous_name": "",
    "by_name": "Amanda Costa",
    "source": "transfer",
    "reason": "Pedido grande, Ana acompanha",
    "at": "2026-10-22T22:26:56.501806-03:00"
  }
]

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.

Finalizar atendimento

POST /conversations/{id}/attendance/close Permissão attendances:write

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID)

Corpo (JSON)

Campo	Tipo	Descrição
`reason`	texto	Motivo do encerramento (opcional), guardado no atendimento.

Exemplo de chamada

POST/conversations/{id}/attendance/closebash

curl -X POST "$NEXTCHAT_API/conversations/{id}/attendance/close" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Pedido entregue"}'

Resposta 200 · Sucesso

Resposta 200json

{
  "id": "a270b2ea-057c-4186-b741-4d9e4c9059a1",
  "protocol": 1,
  "status": "closed",
  "opened_by": "customer",
  "sector_id": null,
  "assignee_id": "c0ee6c5f-9199-4421-a6a5-290a2cfc4391",
  "opened_at": "2026-10-22T22:26:56.252601-03:00",
  "first_response_at": "2026-10-22T22:26:56.396776-03:00",
  "closed_at": "2026-10-22T22:26:56.521399-03:00",
  "close_reason": "Pedido entregue"
}

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.

Equipe

GET /team Permissão team:read

Exemplo de chamada

GET/teambash

curl -X GET "$NEXTCHAT_API/team" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[
  {
    "id": "c0ee6c5f-9199-4421-a6a5-290a2cfc4391",
    "name": "Ana Souza",
    "role": "agent",
    "active": true,
    "presence": "online",
    "profile": "",
    "sector_ids": [
      "c3230317-bdb6-4f3b-b33d-51d4eb61e5d1"
    ]
  },
  {
    "id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
    "name": "Amanda Costa",
    "role": "owner",
    "active": true,
    "presence": "online",
    "profile": "",
    "sector_ids": []
  }
]

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.

Setores

GET /sectors Permissão team:read

Exemplo de chamada

GET/sectorsbash

curl -X GET "$NEXTCHAT_API/sectors" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[
  {
    "id": "c3230317-bdb6-4f3b-b33d-51d4eb61e5d1",
    "name": "Pedidos",
    "color": "red",
    "description": "",
    "active": true,
    "distribution": "manual",
    "only_present": true,
    "position": 0,
    "members": [
      {
        "id": "c0ee6c5f-9199-4421-a6a5-290a2cfc4391",
        "name": "Ana Souza",
        "avatar_url": ""
      }
    ],
    "counts": {
      "waiting": 1,
      "in_progress": 0
    },
    "updated_at": "2026-10-22T22:26:56.197566-03:00"
  }
]

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.

Regras de atendimento da empresa

GET /company/attendance Permissão team:read

Exemplo de chamada

GET/company/attendancebash

curl -X GET "$NEXTCHAT_API/company/attendance" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "reply_mode": "liberal",
  "auto_assign": true,
  "auto_close_days": 0,
  "skip_labels": []
}

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.

Relatório do gestor

GET /reports/attendance Permissão reports:read

Filtros (query string)

Parâmetro	Tipo	Descrição
`from`	texto	Início (AAAA-MM-DD).
`to`	texto	Fim (AAAA-MM-DD).
`sector`	texto	UUID do setor.
`user`	texto	UUID da pessoa.

Exemplo de chamada

GET/reports/attendancebash

curl -X GET "$NEXTCHAT_API/reports/attendance" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "from": "2026-10-15",
  "to": "2026-10-22",
  "totals": {
    "opened": 1,
    "closed": 1,
    "open_now": 0,
    "first_response_avg_s": 312.4,
    "first_response_p90_s": 312.4,
    "resolution_avg_s": 1840.2,
    "resolution_p90_s": 1840.2,
    "foreign_replies": 0
  },
  "by_user": [
    {
      "user_id": "c0ee6c5f-9199-4421-a6a5-290a2cfc4391",
      "user_name": "Ana Souza",
      "handled": 1,
      "closed": 1,
      "open_now": 0,
      "first_response_avg_s": 312.4,
      "resolution_avg_s": 1840.2,
      "foreign_replies": 0,
      "away_while_open_s": 0
    }
  ],
  "by_sector": [
    {
      "sector_id": "",
      "sector_name": "Sem setor",
      "opened": 1,
      "closed": 1,
      "open_now": 0,
      "first_response_avg_s": 312.4,
      "resolution_avg_s": 1840.2
    }
  ],
  "by_day": [
    {
      "date": "2026-10-15",
      "opened": 0,
      "closed": 0
    },
    {
      "date": "2026-10-16",
      "opened": 0,
      "closed": 0
    },
    {
      "date": "2026-10-17",
      "opened": 0,
      "closed": 0
    },
    {
      "date": "2026-10-18",
      "opened": 0,
      "closed": 0
    },
    {
      "date": "2026-10-19",
      "opened": 0,
      "closed": 0
    },
    {
      "date": "2026-10-20",
      "opened": 0,
      "closed": 0
    },
    {
      "date": "2026-10-21",
      "opened": 0,
      "closed": 0
    },
    {
      "date": "2026-10-22",
      "opened": 1,
      "closed": 1
    }
  ]
}

Erros possíveis: 401, 403, 429. O que cada um significa e o formato: Limites e erros.