インテグレーションビルダーを使用することで、AIエージェントとの会話をもとにZendeskチケットを作成できます。この記事では、その方法を順を追って説明します。
参考として、関連するZendeskの開発者向けドキュメントはこちらからご覧いただけます。
この記事では、以下のトピックについて説明します。
- 前提条件
- インテグレーションの作成
- 環境とエンドポイント
- 認証
- リクエストパラメータ
- 本文
- Chatの会話ログのフォーマット:標準とHTML本文
- 標準フィールドとカスタムフィールドの値
- 対話ビルダーでの構築
前提条件
セットアップに必要なもの:
- ご利用のZendeskサブドメイン
- 認証トークン(詳細については以降のセクションを参照)
インテグレーションの作成
- APIインテグレーションで新しいインテグレーションを作成します。
- 作成したインテグレーションに「Create Zendesk Ticket」などの名前を付け、説明を入力します。
環境とエンドポイント
ZendeskチケットAPIにアクセスするには、次のエンドポイントにPOSTリクエストを送信する必要があります:http://[ご利用のZendeskサブドメイン].zendesk.com/api/v2/tickets
Zendeskのサブドメインを使用して、ZendeskインスタンスへのエンドポイントURLを作成できます。このURLは、インテグレーションビルダーの「環境」セクションで、POSTリクエストを送信する際に使用されます。
- インテグレーションビルダーの「環境」セクションに移動します。
- 「メソッドタイプ」で、「POST」を選択します。
- チケットAPI用に構築したURLエンドポイントを追加します。
認証
Zendesk APIにアクセスするには、管理センターでトークンを作成する必要があります。
- 管理センターで、「アプリおよびインテグレーション」に移動し、「アプリ」>「Zendesk API」を選択します。
以下の画面が表示されたら、新しいトークンを追加することができます。 - 「APIトークンを追加」をクリックします。
- 追加するトークンに「Create Ticket」などの名前を付けます。
- トークンをコピーして安全な場所に保管します。このトークンはインテグレーションビルダーでインテグレーションを設定する際に必要になります。
これらの設定を完了すると、インテグレーションビルダーでインテグレーションに追加できます。
- 「環境」セクションで「認証」タブをクリックします。
- 「認証タイプ」で「基本認証」を選択します。
- 管理者のメールアドレスを、末尾に「/token」を付けて入力します。
- 作成したトークンをパスワードとして貼り付けます。
- 「ヘッダー」タブをクリックし、手動でリクエストに認証トークンを含めます。
リクエストパラメータ
ここでは、AIエージェントの会話からインテグレーションにデータを渡してチケットを作成します。
ライブのインテグレーションを使用する場合は、対話でパラメータを設定し、インテグレーションビルダーのリクエストパラメータと一致させる必要があります。テスト目的であれば、実際の会話データは使わず、リクエストパラメータにテスト用の値を設定できます。
リクエストパラメータ名は、対話(アクションを使用)で設定したパラメータ名と一致させる必要があります。詳細については、「対話ビルダーでの構築」を参照してください。
本文
チケットAPIを通じてチケットを作成する際は、この本文部分に会話から取得したすべてのデータを送信します。この本文の構造は、チケットAPIのスキーマと一致する必要があります。
スキーマの詳細およびチケットで作成可能なフィールドを確認するには、こちらのZendesk開発者ドキュメントを参照してください。
以下に示すのは、前のセクションで作成したリクエストパラメータを含むリクエスト本文の例です。
「本番をテストする」をクリックしてインテグレーションをテストします。
その後、新しく作成されたチケットはZendeskダッシュボードで確認できます。
チャットの会話ログのフォーマット:標準の本文とHTMLの本文
チケットAPIでは、コメントに body または html_body のいずれかを使用できます。bodyを使う場合、連続するスペースは1つにまとめられ、複数の改行(/n)も1行に圧縮されます。一方、html_body を使用すれば、HTML構文を使ってコメントのフォーマットを自由に指定できます。
詳細については、こちらのZendesk開発者ドキュメントを参照してください。
作成するチケットでいずれかを使用するには、リクエスト本文の comment に使用したいほうを構造化して指定します。
メモ:どちらかを選択し、以下のデモのように両方を同時に使用しないでください。
チャットの会話ログを送信する場合は、ログをより読みやすくするために「値のフォーマット変換ツール」の使用をおすすめします。各メッセージが1つの大きなテキストブロックにならないように、各メッセージの先頭に改行を追加することができます。
HTML本文を送信する場合は、「値のフォーマット変換ツール」を使ってHTMLを挿入できます。
値のフォーマット変換ツールの使用方法については、「高度なAIエージェントのためのリクエストパラメータの値のフォーマット変換」を参照してください。
以下のスクリーンショットでは、チャットの会話ログをフォーマット変換し、クリック可能なURLを追加して、<br>で改行を挿入しています。
標準フィールドとカスタムフィールドの値
リクエストの本文で作成して送信できる標準フィールドに加え、カスタムフィールドの値を作成することもできます。カスタムフィールドを本文に設定する方法については、こちらのZendesk開発者ドキュメントを参照してください。
対話ビルダーでの構築
- APIノードを追加し、前の手順で作成した「Zendeskチケットの作成」インテグレーションを選択します。
- 会話からのパラメータを設定するAPIノードにアクションを作成します。
次の画面のような構成になります。 - 成功シナリオおよびフォールバックシナリオ用のメッセージを追加します。