Zendesk API でチケットにカスタマー満足度評価をつける

テスト時に使える、Zendesk API でチケットにカスタマー満足度評価をつける方法をご紹介します。
2020.06.25

こんばんは!新居で仕事部屋を貰えてハッピーな です。

はじめに

最近、Zendesk 関連の改善業務に取り組んでいます。 取り組んでいる改善業務の一つに、 カスタマー満足度評価(CSAT) の結果をトリガーに使うものがあるのですが、 テスト用に都度、GUI でチケット評価をするのが大変だったので、Zendesk API を使用してチケットを評価する方法を確認しました。

今回はこちらの方法をご紹介します。なお、以下を前提とします。

  • カスタマー満足度評価を利用できるプランを利用
  • カスタマー満足度評価を使うための設定が有効化済

上記の前提に不明点がありましたら カスタマー満足度評価(CSAT) を確認してください。

やってみた

情報整理

今回の API 実行時に必要となる情報を整理します。

{subdomain}

Zendesk sandbox 環境のサブドメインです。 自身の環境の確認方法は以下を参照ください。

どこで自分のZendeskのサブドメインを確認できますか? | Zendesk Support ヘルプ


{ticket_id}

テスト用チケットのチケット ID です。


{score}

満足評価をつけたい時は good , 不満足評価をつけたい時は bad を選択します。


{comment}

チケットのコメントです。 こちらはご自由にどうぞ。


{email_address}

テスト用のエンドユーザのメールアドレスです。 チケット起票時に使ったエンドユーザである必要があります。


{token}

作成した API トークンです。 API トークンの作成方法は以下を参照ください。

APIトークンを作成して管理する

コマンド実行

コマンド実行前のテスト用チケットは下図の状態です。 ステータスは「解決済み」にしておいてください。

以下のコマンドの{}部分を、上記で整理した情報に置き換えて実行します。

curl https://{subdomain}.zendesk.com/api/v2/tickets/{ticket_id}/satisfaction_rating.json \
  -X POST -d '{"satisfaction_rating": {"score": "{score}", "comment": "{comment}"}}' \
  -v -u {email_address}/token:{token} -H "Content-Type: application/json"

参考:

Create a Satisfaction Rating | Zendesk developers

API token | Zendesk developers

無事、テスト用のチケットをチケット評価できました。

おわりに

いかがだったでしょうか。上記通りに進めればスムーズにできるかと思います。参考までに個人的に少しハマったとこを紹介しておきます。

  • コマンドの {email adress} をエンドユーザのメールアドレスにしないとコマンドエラーが発生する
  • チケットのステータスが「解決済み」でないとコマンドエラーが発生する
  • {score}に、 good_with_comment を指定するとコマンドエラーが発生する

今後も引き続き、改善業務で得た知識をアウトプットしていきたいと思います。 それでは良い夜を!