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}/agentsLista todos os agentes da conta.
Parametros
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
account_id(path) | integer | Sim | ID 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}/agentsAdiciona um novo agente a conta. Um convite sera enviado por email.
Body
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name | string | Sim | Nome completo do agente |
email | string | Sim | Email (sera usado para login) |
role | string | Sim | Funcao: 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
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name | string | Nao | Nome |
role | string | Nao | Funcao: agent ou administrator |
availability | string | Nao | Status: online, offline, busy |
auto_offline | boolean | Nao | Ficar 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