A API de e-mail permite definir propriedades de tickets ao adicionar comandos ao corpo de uma resposta de e-mail para uma notificação ou um e-mail criando um novo ticket. Apenas os agentes podem usar a API de e-mail. Se esses comandos forem usados por usuários finais, o Zendesk vai ignorá-los.
Segue um exemplo de um agente configurando o status e a atribuição de um ticket em resposta a uma notificação por e-mail:
Um agente também pode usar os comandos em um novo e-mail enviado para o endereço de suporte. Este tipo de e-mail cria um novo ticket.
Sintaxe
A API de e-mail apenas examina o topo de seu e-mail para obter a lista de comandos que você deseja executar.
Os comandos devem estar em texto simples, não em HTML, e conforme o seguinte padrão:
#command value
Se, por exemplo, você quiser definir o status de um ticket, use este comando:
#status solved
Cada linha deve ser separada por uma nova linha. Por exemplo, se você quiser definir o status e para quem ele foi atribuído, escreva os comandos da seguinte maneira:
#status solved
#assignee jake@zendesk.com
Insira o corpo do e-mail após o bloco de comandos.
Referência de comandos
Abaixo, está uma lista de todos os comandos suportados que podem ser adicionados, em uma linha de cada vez, ao corpo de um e-mail válido. A lista também inclui comandos curtos, ou seja, comandos de uma palavra para comandos utilizados regularmente que não precisam de valores. Por exemplo, você pode usar o comando curto #solved
em vez do #status
solved
.
Comando | Descrição |
---|---|
#status
|
Os valores válidos são open (aberto), pending (pendente) e solved (resolvido). Observação: o #assignee (atribuído) deve ser definido para que se possa definir um ticket como solved (resolvido). Sintaxe curta: #solved só funciona para tickets que não têm campos obrigatórios que o agente deve preencher antes de o ticket ser resolvido. |
#requester
|
Define o solicitante do ticket. Pode ser a ID do usuário em sua conta ou apenas o endereço de e-mail dele. Caso ainda não existam em sua conta, o Zendesk irá criá-los para você. Este comando não está disponível para agentes light. |
#group
|
Atribui o ticket a um grupo. Os valores válidos são o nome do grupo ou a ID de um grupo.
Este comando é útil principalmente para e-mails encaminhados. Quando um agente encaminha um e-mail para a Zendesk, por padrão, o ticket resultante não é atribuído ou é atribuído ao grupo padrão do agente (consulte Envio de e-mail para seu endereço de suporte). Os agentes podem usar este comando para atribuir automaticamente o ticket encaminhado ao grupo especificado. |
#assignee |
Atribui o ticket a um agente. Os valores válidos são o endereço de e-mail do atribuído ou a ID do Zendesk Support do atribuído (obtido, por exemplo, por meio de uma integração REST). A utilização deste comando o torna, automaticamente, um colaborador (cc) no ticket. |
#priority
|
Define a prioridade do ticket. Os valores válidos são low (baixa), normal (normal), high (alta) e urgent (urgente). Observação: para definir uma prioridade, é necessário também definir um tipo de ticket (veja abaixo) Sintaxe curta: |
#type |
Os valores válidos são incident (incidente), question (pergunta), task (tarefa) e problem (problema). Sintaxe curta: |
|
Define quaisquer tags no ticket, que podem ser separadas por espaços ou vírgulas. Observação: a definição das tags remove todas as tags definidas anteriormente no ticket. |
#public
|
Define uma atualização de comentário em um ticket como pública. Utilizável apenas ao atualizar um ticket. O valor padrão para testes públicos é true (verdadeiro), indicando que o solicitante verá todas as outras informações inseridas no corpo do e-mail. O valor padrão para tickets privados, como os tickets criados por agentes light, é false. Sintaxe curta: |
Comandos inválidos
Se você inserir comandos ou valores inválidos, eles serão ignorados pelo Zendesk.
Exemplo
Neste exemplo, o agente usa todos os comandos.
O e-mail faz o seguinte com o ticket #178:
- Define o status para open (aberto)
- Define o grupo para "Support" (Suporte) e o atribui para o agente com o endereço de e-mail “jake@zendesk.com”
- Define a prioridade como "normal" (normal)
- Define o tipo para "question" (pergunta)
- Define as tags para "help" (ajuda) e "api"
- Define a visibilidade do comentário como "private" (privado)
- Adiciona um novo comentário com "Olá Mundo!" ao ticket que, combinado com o comando acima, não será visível para o solicitante.
27 comentários
Julian
On Dec 22, 2021, Jeff C said:
Yet, the article says
What would be, now, a turnaround to this scenario:
Goal:
When a partner company forwards a user request to my Zendesk, the forwarded email often includes internal information meant only for my agents and not for the requester.
Need:
I want the first message in the conversation (the forwarded email) to be created automatically as an internal note, so it is not visible to the end user.
Thank you for your ideas.
0
Axel de Jong
This is something we too would really appreciate: some kind of trigger to allow to set the organization on email tickets for users with multiple organisations.
1263792605130 did you ever find a way to achieve this?
0
Justin Near
We have several clients with multiple organizations. I'm not seeing “Organization” in the placeholder list, but I'm also not seeing a way to change organization on a ticket with a trigger. Is there a way to change the organization using a placeholder and/or some other method while forwarding an email?
0
Dainne Kiara Lucena-Laxamana
Hi 5094134994970
That's rather odd. I went ahead & created a ticket to look into that Email trail using the latest comment placeholder. Please keep an eye out for our Email
0
Kiran Yadav
Hi Team, if we are replying to the requester about the ticket and the requester is replying back through their email, is it possible that the requester see only the latest comment and not the other trail mail comments. I have tried using the latest comment placeholder in the trigger but still if the agent replies back the comments are visible in the trail mail
0
Sriram Parthasarathy
Support team, are you planning on getting html-formatted tags to work? We are not able to ask our agents (who all use Outlook) to make sure they switch to plain text email every single time they want to reply to a ticket and use mail api for changing the assignee, status, or adding a note.
0
Patrick Lanwehr
Hi Mike,
just check my comment from the 29.06.2023
I have already added the link.
0
Mike DR
0
Joyce
#brand
is not a supported command for Mail API. All the supported Mail API commands are listed in the Command reference topic of this article.As a workaround, you can use the
#tags
command to add a ticket tag and use this tag as a condition in a trigger to set the ticket brand.Hope this helps.
1
Patrick Lanwehr
Hallo Jennifer,
ich möchte gerne eine E-Mail, die bisher ohne Ticketbezug ist, als internen Kommentar einem bestehenden Tickets hinzufügen.
Im Jahr 2015 gab es dazu mal einen Community-Post mit sehr viel Feedback. Ist das nun die Lösung ?
https://support.zendesk.com/hc/de/community/posts/4409217600666-Ability-to-forward-emails-into-an-existing-ticket
0
Entrar para comentar.