Listar colegas no Front, por uma API
Lista os colegas da empresa com id, email, username, name e availability. O id é o assignee_id e o author_id das outras ferramentas e do filtro assignee: de Buscar conversas.
- Identificador
- front_list_teammates
A chamada
POST https://connect.reportei.com/api/tools/front_list_teammates/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
Esta tool não recebe argumentos.
Conexões possíveis
O seu cliente conecta a conta do Front uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/front_list_teammates. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Front
- Buscar conversasGETBusca as conversas que o token de API alcança, da atividade mais recente para a mais antiga, e retorna _total com as correspondências. Conversas na lixeira ficam de fora, a menos que a consulta peça is:trashed. A próxima página vem do page_token dentro de _pagination.next, que é null na última página.
- Obter conversaGETRetorna uma conversa com assunto, status, responsável, destinatário principal, tags, campos personalizados e links. As mensagens vêm de Listar mensagens da conversa.
- Listar mensagens da conversaGETLista as mensagens de uma conversa, as mais novas primeiro, a menos que sort_order seja asc, com autor, destinatários, assunto, corpo e detalhes dos anexos. A próxima página vem do page_token dentro de _pagination.next, que é null na última página.
- Atualizar conversaPATCHAtualiza o responsável, a caixa de entrada, o status, as tags ou os campos personalizados de uma conversa. Envie só os campos a mudar. tag_ids substitui todas as tags da conversa; para adicionar tags sem remover as outras, use Aplicar tags.
- Aplicar tagsPOSTAdiciona uma ou mais tags a uma conversa e mantém as que ela já tem.
- Criar comentárioPOSTAdiciona um comentário interno a uma conversa. Os comentários só são vistos pelos colegas, nunca pelo contato. O corpo aceita Markdown.
- Criar rascunhoPOSTCria um rascunho de resposta à última mensagem de uma conversa, para um colega revisar e enviar no Front. Nada é enviado. Um rascunho privado só é visível ao autor, então defina author_id como o colega que vai revisar, ou use o modo shared.
- Responder à conversaPOSTEnvia uma resposta em uma conversa na hora e responde 202 com um message_uid. O Front arquiva a conversa quando a resposta sai, a menos que options.archive seja false. Exige a permissão de envio no token de API. Uma conversa mesclada responde com um redirecionamento para a conversa em que foi mesclada.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
