Pular para o conteúdo

Agentes

Gerencie os agentes de atendimento da sua conta. Agentes podem atender conversas, ser atribuidos a equipes e ter diferentes niveis de acesso.

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

Lista todos os agentes da conta.

Parametros

NomeTipoObrigatorioDescricao
account_id(path)integerSimID numerico 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
  },
  {
    "id": 2,
    "name": "Pedro Lima",
    "email": "pedro@empresa.com",
    "role": "agent",
    "availability_status": "busy",
    "auto_offline": true,
    "confirmed": true
  }
]
POST/api/v1/accounts/{account_id}/agents

Adiciona um novo agente a conta. Um convite sera enviado por email.

Body

NomeTipoObrigatorioDescricao
namestringSimNome completo do agente
emailstringSimEmail (sera usado para login)
rolestringSimFuncao: 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 (role, disponibilidade, etc).

Body

NomeTipoObrigatorioDescricao
namestringNaoNome
rolestringNaoFuncao: agent ou administrator
availabilitystringNaoStatus: online, offline, busy
auto_offlinebooleanNaoFicar offline automaticamente quando inativo
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 '{ "role": "administrator", "availability": "online" }'
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