Equipes e Agentes

Organize seus agentes em equipes para distribuicao automatica de conversas e gerenciamento de permissoes.

GET/api/v1/accounts/{account_id}/teams

Lista todas as equipes da conta.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/teams" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de equipes

json

[
  {
    "id": 1,
    "name": "Suporte Tecnico",
    "description": "Equipe de suporte nivel 1",
    "allow_auto_assign": true,
    "account_id": 1
  },
  {
    "id": 2,
    "name": "Vendas",
    "description": "Equipe comercial",
    "allow_auto_assign": true,
    "account_id": 1
  }
]

POST/api/v1/accounts/{account_id}/teams

Cria uma nova equipe.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome da equipe
`description`	`string`	Nao	Descricao da equipe
`allow_auto_assign`	`boolean`	Nao	Permitir auto-atribuicao de conversas

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/teams" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Suporte N2",
    "description": "Suporte tecnico nivel 2",
    "allow_auto_assign": true
  }'

GET/api/v1/accounts/{account_id}/teams/{team_id}

Retorna os detalhes de uma equipe.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/teams/1" \
  -H "api_access_token: YOUR_TOKEN" | jq .

PATCH/api/v1/accounts/{account_id}/teams/{team_id}

Atualiza os dados de uma equipe.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Nao	Nome da equipe
`description`	`string`	Nao	Descricao
`allow_auto_assign`	`boolean`	Nao	Auto-atribuicao

bash

curl -X PATCH "https://chat.seudominio.com/api/v1/accounts/1/teams/1" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Suporte Premium", "allow_auto_assign": false }'

DELETE/api/v1/accounts/{account_id}/teams/{team_id}

Remove uma equipe. Conversas atribuidas a equipe serao desatribuidas.

bash

curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/teams/1" \
  -H "api_access_token: YOUR_TOKEN"

Membros da Equipe

GET/api/v1/accounts/{account_id}/teams/{team_id}/team_members

Lista os membros de uma equipe.

200Lista de membros

json

[
  { "id": 1, "name": "Maria", "email": "maria@empresa.com", "role": "agent" },
  { "id": 2, "name": "Pedro", "email": "pedro@empresa.com", "role": "agent" }
]

POST/api/v1/accounts/{account_id}/teams/{team_id}/team_members

Adiciona agentes a uma equipe.

Body

Nome	Tipo	Obrigatorio	Descricao
`user_ids`	`array`	Sim	Array de IDs dos agentes a adicionar

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/teams/1/team_members" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "user_ids": [3, 4, 5] }'

DELETE/api/v1/accounts/{account_id}/teams/{team_id}/team_members

Remove agentes de uma equipe.

Body

Nome	Tipo	Obrigatorio	Descricao
`user_ids`	`array`	Sim	Array de IDs dos agentes a remover

bash

curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/teams/1/team_members" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "user_ids": [3] }'

Agentes

Agentes sao os usuarios que atendem conversas na plataforma.

GET/api/v1/accounts/{account_id}/agents

Lista todos os agentes da conta.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/agents" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de agentes

json

[
  {
    "id": 1,
    "name": "Maria Santos",
    "email": "maria@empresa.com",
    "role": "agent",
    "availability_status": "online",
    "auto_offline": true
  }
]

POST/api/v1/accounts/{account_id}/agents

Adiciona um novo agente a conta.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome do agente
`email`	`string`	Sim	Email do agente
`role`	`string`	Sim	Role: agent ou administrator

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/agents" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Carlos Oliveira",
    "email": "carlos@empresa.com",
    "role": "agent"
  }'

PATCH/api/v1/accounts/{account_id}/agents/{id}

Atualiza dados de um agente.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Nao	Nome
`role`	`string`	Nao	Role
`availability`	`string`	Nao	Status: online, offline, busy
`auto_offline`	`boolean`	Nao	Auto-offline quando inativo

DELETE/api/v1/accounts/{account_id}/agents/{id}

Remove um agente da conta.

bash

curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/agents/3" \
  -H "api_access_token: YOUR_TOKEN"