Atendimento
Front no seu produto e nos seus agentes de IA, por uma API
O toolkit do Front cobre conversas e suas mensagens, tags, comentários internos, rascunhos, respostas, novas mensagens e os canais, caixas de entrada e colegas a que se referem. Pelo Connect, seu produto ou agente de IA chama tudo por um só endpoint, enquanto o Connect guarda o token de API e registra cada execução.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/front_apply_tags/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"conversation_id": "<conversation_id>",
"tag_ids": []
}
}Como funciona
Do cliente conectado à primeira chamada no Front.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do Front. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o Front.
Rascunhe respostas para revisão
Um agente de IA lê uma conversa e cria um rascunho de resposta, para um colega revisar e enviar no Front. Nada sai sozinho.
Triagem e roteamento de conversas
Uma ferramenta de suporte busca conversas, aplica tags e atualiza o responsável ou a caixa de entrada.
Avise clientes a partir do app
Um produto envia uma nova mensagem de um canal ou responde em uma conversa existente quando algo acontece no app.
Tools
13 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.
- Enviar mensagemPOSTEnvia uma nova mensagem a partir de um canal, o que inicia uma nova conversa, e responde 202 com um message_uid. Sai na hora, e o Front arquiva a nova conversa, a menos que options.archive seja false. Exige a permissão de envio no token de API.
- Listar canaisGETLista os canais da empresa, como endereços de e-mail, números de SMS e chat, com id, name, address, type e o link para a caixa de entrada. O id é o channel_id de Enviar mensagem e Criar rascunho.
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.
Perguntas sobre o toolkit do Front
Preciso implementar a API do Front?
Não. O Connect já traz 13 tools do Front descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do Front?
Pelo modo que o toolkit aceita: Chave de API. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
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.
