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.