メールAPIでは、通知へのメール返信の本文にコマンドを追加することで、チケットのプロパティを設定できます。メールAPIを使用できるのはエージェントだけです。これらのコマンドをエンドユーザーが使用しても無視されます。
以下の例では、エージェントは、メール通知に対する返信の中でチケットのステータスと担当者を設定しています。
また、エージェントは、サポートアドレスに送信する新規のメール内でもコマンドを使用できます。この種のメールは新規チケットを作成します。
シンタックス
メールAPIは、実行するコマンドがあるかどうか、メール本文の先頭を調べます。
コマンドはHTMLではなく、プレーンテキストで、次のパターンで記述します。
#コマンド 値
たとえば、チケットのステータスを設定したい場合、以下のコマンドを使用します。
#status solved
各行は、改行で区切る必要があります。たとえば、チケットのステータスと担当者を設定したい場合、以下のコマンドを使用します。
#status solved
#assignee yamada@zendesk.com
メールの本文はコマンドブロックの下に入力します。
コマンドリファレンス
以下は、有効なメールの本文に含めることができる全コマンドのリストです。各コマンドは、1行に1個ずつ記述します。リストには、ショートコマンドも含まれます。これは、よく使われる1語のコマンドで、値を必要としません。たとえば、ショートコマンド#solvedを#status solved。
コマンド | 説明 |
---|---|
#status |
有効な値は、open、pending、solvedです。メモ:チケットを「解決済み」(solved)に設定するには、#assigneeが設定されている必要があります。 ショートコマンドのシンタックス:#open #pending #solved メモ:この#solvedコマンドは、チケットを解決するためにエージェントが入力しなければならないフィールドを必要としないチケットに対してのみ機能します。 |
#requester | チケットのリクエスタを設定します。値は、自社アカウントでのユーザーID、またはメールアドレスのいずれかを指定できます。アカウント内にリクエスタが存在しない場合、そのリクエスタが新規ユーザーとして作成されます。 |
#group |
チケットをグループに割り当てます。有効な値は、グループ名またはグループIDです。 |
#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です。つまり、このコマンド以外のメール本文に挿入したテキストはすべて、リクエスタに閲覧されます。 ショートコマンドのシンタックス:#note(プライベートコメントを示す) |
無効なコマンド
無効なコマンドまたは値を入力した場合、Zendeskによって無視されます。
例
この例では、エージェントはすべてのコマンドを使用します。
チケットNo.178に対して次のことを行います。
- ステータスを「オープン」に設定する
- グループを「サポート」グループに設定し、jake@zendesk.comというメールアドレスのエージェントが担当者として設定する
- 優先度をnormalに設定する
- タイプをquestionに設定する
- 「ヘルプ」と「API」というタグを設定する
- コメントの公開属性を「プライベート」に設定する
- 「Hello world!」ではじまる新規のコメントをチケットに追加し、リクエスタに表示されない上記のコマンドと結合する
0 コメント
サインインしてコメントを残してください。