Agentes

Gerencie os agentes de atendimento da sua conta. Agentes podem atender conversas, ser atribuídos a equipes e ter diferentes níveis de acesso. Além das funções base (agent e administrator), você pode atribuir uma Função Personalizada a um agente pelo campo custom_role_id.

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

Lista todos os agentes da conta.

Parâmetros

Nome	Tipo	Obrigatorio	Descricao
`account_id`(path)	`integer`	Sim	ID numérico da conta

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": "administrator",
    "availability_status": "online",
    "auto_offline": true,
    "confirmed": true,
    "custom_role_id": null
  },
  {
    "id": 2,
    "name": "Pedro Lima",
    "email": "pedro@empresa.com",
    "role": "agent",
    "availability_status": "busy",
    "auto_offline": true,
    "confirmed": true,
    "custom_role_id": 5
  }
]

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

Adiciona um novo agente à conta. Um convite será enviado por email.

Body (envolto em objeto agent)

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome completo do agente
`email`	`string`	Sim	Email (será usado para login)
`role`	`string`	Sim	Função: agent ou administrator
`availability`	`string`	Nao	Disponibilidade inicial: online, offline, busy
`auto_offline`	`boolean`	Nao	Ficar offline automaticamente quando inativo

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 '{
    "agent": {
      "name": "Carlos Oliveira",
      "email": "carlos@empresa.com",
      "role": "agent"
    }
  }'

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

Atualiza dados de um agente (role, disponibilidade, etc).

Body (campos do agente envoltos em objeto agent)

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Nao	Nome
`role`	`string`	Nao	Função base: agent ou administrator
`availability`	`string`	Nao	Status: online, offline, busy
`auto_offline`	`boolean`	Nao	Ficar offline automaticamente quando inativo
`custom_role_id`(body)	`integer \| null`	Nao	Enviado na RAIZ do corpo (fora do objeto agent). ID de uma Função Personalizada da conta a atribuir ao agente. Enviar null limpa a função (volta ao comportamento base). IDs de outra conta são ignorados.

Atenção: diferente dos demais campos, custom_role_id é lido na raiz do corpo da requisição, fora do objeto agent. O ID deve referenciar uma Função Personalizada da mesma conta. O campo também retorna no response de listagem dos agentes.

bash

curl -X PATCH "https://chat.seudominio.com/api/v1/accounts/1/agents/2" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "agent": { "role": "agent", "availability": "online" },
    "custom_role_id": 5
  }'

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"

200Agente removido com sucesso