Para: Administradores
Leia as funções com uma chave de gerenciamento.
Liste as funções do seu hub e leia as permissões de uma função, para que seu software possa atribuir os casos às pessoas com a função correta.
Neste artigo5 seções
Antes de começar
Esta página aborda como ler as informações do seu hub. Funções/rolesFunção Um conjunto de permissões que define o que alguém pode ver e fazer em um caso, como funcionários ou clientes., Quais são os IDs que você envia quando coloca alguém em um caso? Os caminhos estão abaixo… https://prd-api-manage.caseactive.com/v1/<hub id>. Uma chave pode ler os papéis associados a ela, mas não pode criar, alterar ou excluir esses papéis.
Chamadas
| Chamar | O que faz |
|---|---|
GET /roles | Lista dos papéis do seu hub |
GET /roles/<role_id> | Lê um papel, juntamente com as permissões associadas a ele. |
GET /roles recebe limit (padrão: 20) e start_key. Além disso, startKey vem da página anterior. Um hub pode ter no máximo 20 funções. Portanto, uma chamada com limit=20 permite que todas essas funções sejam utilizadas.
IDs de função
O ID da função é role::, e o seu nome é role::senior-paralegal. Cada hub possui três funções integradas.
| ID da função | Para quem é? |
|---|---|
role::clients | Clientes |
role::staff | A sua equipe |
role::bots | O seu hub… Assistente VirtualAssistente Virtual Um membro de equipe automatizado que publica mensagens de boas-vindas, atualizações e posts de apresentação para a empresa; suas publicações exibem um selo de Assistente Virtual., Qualquer chave de API funciona como isso. Não dê essa chave para ninguém. |
Que função envolve
GET /roles responde a cada um dos role_id, name, role_type (system para os três papéis padrão; custom para o seu próprio papel). Além disso, description, color e users_ct indicam o número de posições que esse papel ocupa nos casos.
{
"data": {
"items": [
{"role_id": "role::clients", "name": "clients", "role_type": "system", "color": "#10B981", "users_ct": 214},
{"role_id": "role::senior-paralegal", "name": "senior-paralegal", "role_type": "custom", "description": "Paralegals who run intake", "color": "#6366F1", "users_ct": 9}
],
"currentItemCount": 2,
"selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles"
}
}
GET /roles/<role_id> adiciona:
| Campo | O que contém |
|---|---|
permissions | Qual é o papel que cada seção pode desempenhar em um caso: case, convos, events, posts, forms, signs, invoices, notes, tasks e team. Cada seção lista nomes como list_posts (veja-os), put_post (adicione ou edite os seus próprios nomes), delete_post, put_comment e moderator (gerencie os nomes de todos). |
case_read_fields, case_write_fields | O caso detalha o papel que desempenha, bem como as possíveis mudanças nesse papel. |
user_read_fields, user_write_fields | Os detalhes do perfil dos outros envolvidos no caso podem mudar, dependendo do papel que cada um desempenha. |
file_size | O arquivo maior que o programa pode carregar, em MB, de acordo com o tipo: audios, docs, files, images, schemas e videos |
A lista mencionada não inclui nenhum dos elementos que deveriam estar presentes na resposta.
Por padrão, role::staff E… role::bots É possível gerenciar tudo relacionado a um caso. role::clients É possível visualizar o caso e todas as seções do sistema. Além disso, é possível adicionar seus próprios eventos, formulários, sinais e tarefas, além de pagar faturas. O “hub” pode ter sido alterado. Para saber quais permissões são permitidas, veja… Verifique todas as permissões relacionadas a cada função..
Se uma chamada for recusada
| Status | message | Por que |
|---|---|---|
| 404 | ItemNotFoundException | O seu hub não tem nenhum papel relacionado a essa identificação. |
| 403 | BotNotAllowedException | Você tentou criar, alterar ou excluir uma função. |