Tools do Front
As 13 operações do Front que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- 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.
- Listar caixas de entradaGETLista as caixas de entrada da empresa com id e name. O id é o inbox_id de Atualizar conversa e do filtro inbox: de Buscar conversas.
- Listar colegasGETLista 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.
- Listar tagsGETLista as tags da empresa, da equipe e pessoais que o token de API alcança, com id, name e description. O id vai em tag_ids e no filtro tag: de Buscar conversas.
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.
