現在のプランを確認
Suite すべてのプラン
Support すべてのプラン

メールAPIでは、通知に対する返信メールや新規チケットを作成するメールの本文にコマンドを追加することで、チケットのプロパティを設定できます。メールAPIを使用できるのはエージェントだけです。これらのコマンドをエンドユーザーが使用しても無視されます。

以下の例では、エージェントは、メール通知に対する返信の中でチケットのステータスと担当者を設定しています。

また、エージェントは、サポートアドレスに送信する新規のメール内でもコマンドを使用できます。この種のメールは新規チケットを作成します。

Zendesk Supportでは、エージェントからのメールが届くと、メール本文の先頭にコマンドがあるかどうか確認し、見つかった場合はそのチケットに対してコマンドを実行します。
メモ:そのチケットのメール通知に回答するだけで既存のチケットが更新されます。つまり、別のメールメッセージを新規作成し、既存のチケットを参照させることはできません。これは、返信先アドレスに含まれているチケットIDをZendesk Supportが必要としているからです(上図を参照)。

シンタックス

メールAPIは、実行するコマンドがあるかどうか、メール本文の先頭を調べます。

コマンドはHTMLではなく、プレーンテキストで、次のパターンで記述します。

#command value

たとえば、チケットのステータスを設定したい場合、以下のコマンドを使用します。

#status solved

各行は、改行で区切る必要があります。たとえば、チケットのステータスと担当者を設定したい場合、以下のコマンドを使用します。

#status solved


#assignee jake@zendesk.com

メールの本文はコマンドブロックの下に入力します。

メモ:コマンドと値の間に入力するスペースは1つだけです。

コマンドリファレンス

以下は、有効なメールの本文に含めることができる全コマンドのリストです。各コマンドは、1行に1個ずつ記述します。リストには、ショートコマンドも含まれます。これは、よく使われる1語のコマンドで、値を必要としません。たとえば、#status solvedではなく、ショートコマンド#solvedを使用します。

メモ:カスタムフィールド名をコマンドとして使用することはできません。
コマンド 説明
#status


有効な値は、open、pending、solvedです。メモ:チケットを「解決済み」(solved)に設定するには、#assigneeが設定されている必要があります。

ショートコマンドのシンタックス:#open #pending #solved

メモ:#solvedコマンドは、チケットを解決するためにエージェントが入力しなければならないフィールドを必要としないチケットに対してのみ機能します。
#requester


チケットのリクエスタを設定します。値は、自社アカウントでのユーザーID、またはメールアドレスのいずれかを指定できます。アカウント内にリクエスタが存在しない場合、そのリクエスタが新規ユーザーとして作成されます。

ライトエージェントはこのコマンドを使用できません。

#group
 チケットをグループに割り当てます。有効な値は、グループ名またはグループIDです。

このコマンドは、転送されたメールに対して特に有効です。エージェントがZendeskにメールを転送した場合、デフォルトでは、転送されたチケットは未割り当てになるか、エージェントのデフォルトグループに割り当てられます。(サポートアドレスへのメールの回送」を参照。) エージェントはこのコマンドを使用して、転送されたチケットを、指定したグループに自動的に割り当てることができます。

#assignee チケットをエージェントに割り当てます。有効な値は、担当者のメールアドレスか、担当者のZendesk Support ID(RESTインテグレーションなどを経由して取得)です。

このコマンドを使用すると、コマンドを使用したエージェントが自動的にチケットのコラボレータ(CC)として追加されます。

#priority


チケットの優先度を設定します。有効な値は、low、normal、high、urgentです。メモ:ただし、優先度を設定するには、併せてチケットタイプを設定する必要があります(下の項目を参照)。

ショートコマンドのシンタックス:#low #normal #high #urgent

#type

有効な値は、incident、question、task、problemです。

ショートコマンドのシンタックス:#incident #question #task #problem

#tags


チケットに任意のタグを設定します。複数設定する場合は、スペースまたはカンマで区切ります。

メモ:コマンドでタグを設定すると、そのチケットの既存のタグはすべて削除されます。

#public


チケットのコメントの更新をパブリックに設定します。チケットの更新時にのみ使用できます。

パブリックチケットのデフォルトの値はtrueです。つまり、メール本文に記載した他のすべての内容がリクエスタに表示されます。プライベートチケットのデフォルト値はfalseです(例:ライトエージェントが作成したチケットなど)。

ショートコマンドのシンタックス:#note(そのエージェントからの今後のコメントを、そのチケットで非公開にします。ただし、個々のコメントに#publicがあると取り消されます)

無効なコマンド

無効なコマンドまたは値が入力された場合、Zendeskに無視されます。

例

この例では、エージェントはすべてのコマンドを使用します。

チケットNo.178に対して次のことを行います。

  • ステータスを「オープン」に設定する
  • グループを「サポート」グループに設定し、jake@zendesk.comというメールアドレスのエージェントが担当者として設定する
  • 優先度をnormalに設定する
  • タイプをquestionに設定する
  • 「ヘルプ」と「API」というタグを設定する
  • コメントの公開属性を「プライベート」に設定する
  • 「Hello world!」ではじまる新規のコメントをチケットに追加し、リクエスタに表示されない上記のコマンドと結合する
Powered by Zendesk