Zendesk Request API ブロックの使用方法
この記事では、Zendesk Request API シナリオブロックの主な使用ケースについて解説します。Zendesk チケットをエージェントに画面ポップ表示する方法、新規 Zendesk リクエストを作成してエージェントに画面ポップ表示する方法、Zendesk チケットを更新する方法、および他の Zendesk ユーザーに代わって新規 Zendesk チケットを作成する方法についてご説明します。
前提条件
- Bright Pattern Contact Center の管理者権限をお持ちであること。
- Bright Pattern Contact Center バージョン 5.5.x 以降を使用していること。
- コンタクトセンター用に設定済みの Zendesk 連携アカウント があること。
- 連携アカウントのプロパティで、認証タイプとして「OAuth アクセストークン」を設定してください。
- Zendesk のユーザーインターフェースおよび API への管理者アクセス権を持っていること。
ユースケース:特定の Zendesk チケットをエージェントにスクリーンポップする
「Zendesk API リクエスト」ブロックと「Zendesk スクリーンポップ」ブロックを組み合わせて使用することで、着信コールに合わせてエージェントにチケットをポップアップ表示させることができます。この手順を実行するには、シナリオブロックの「Raw JSON」フィールドに入力するための Zendesk チケット番号が必要です。
サンプルシナリオをダウンロードするには、こちらをクリックしてください: Zendesk Screen Pop a Ticket Example.zip
ステップ 1:音声シナリオを作成する
「コンタクトセンター管理者」アプリケーションの シナリオ > 音声セクションで、以下のシナリオブロックを含む新規の基本音声シナリオを作成します: Zendesk アカウントの選択、 Zendesk API リクエスト、および Zendesk スクリーンポップ。
ステップ 2: Zendesk 連携アカウントを指定する
「Zendesk アカウントの選択」ブロックプロパティで、コンタクトセンター用に設定済みの Zendesk 連携アカウントを選択してください。
ステップ 3: Zendesk API リクエストのプロパティを設定する
「Zendesk API リクエスト」シナリオブロックのプロパティで、以下を設定してください:
- 名前 - このブロックの名前を入力してください。
- リクエストタイプ - 「GET」に設定してください。
- URL - 空欄のままにしてください。
- 追加ヘッダー - 空のままにしてください。
- 生の JSON - チケットオブジェクトのプロパティを生の JSON として貼り付けてください(以下の「生の JSON の例」を参照してください):
- 結果 JSON の初期パス - 「id」に設定してください。
- JSON データのシナリオ変数プレフィックス - 「zendesk.id」に設定してください。
- GetNext ブロックを使用してデータをループ処理する - チェックを外したままにしてください。
生の JSON の例:
{
"id": 35436,
"created_at": "2009-07-20T22:55:29Z",
"updated_at": "2011-05-05T10:38:52Z",
"due_at": "2011-05-24T12:00:00Z",
"subject": "Help request",
"description": "This is my description.",
"status": "open",
"priority": "normal",
"type": "problem",
"organization_id": 509974,
"assignee_id": 72983,
"group_id": 8665,
"requester_id": 1462,
"collaborator_ids": [],
"can_be_solved_by_me": false,
"ticket_form_id": 2,
"via": {
"channel": "web"
}
}
ステップ 4: Zendesk スクリーンポップのプロパティを設定する
Zendesk スクリーンポップ ブロックのプロパティで、チケット オブジェクトがスクリーンポップされるように、以下を設定してください:
- 応答時にスクリーンポップを表示 - オプションです。
- オブジェクト - ラジオボタンを選択してください。
- オブジェクト ID - 変数 $(zendesk.id) を設定してください。
- オブジェクト タイプ - 「チケット」を選択してください。
ステップ 5: シナリオを保存する
音声シナリオの設定が完了したら、「保存」をクリックして変更を保存してください。
ステップ 6: シナリオのテスト
以下のステップに従って、シナリオが正常に動作するかテストしてください:
- Zendesk で、サービスコールに対応できるチームに割り当てられているエージェントとして、統合された「エージェントデスクトップ」ウィジェットにログインし、ステータスを「受付可能」にしてください。
- 別の電話から、コンタクトセンターのアクセス番号に電話をかけてください。Zendesk にログインしているため、通話はあなたに転送され、特定のチケットが画面にポップアップ表示されるはずです。
ユースケース:新規リクエストを作成し、エージェントにスクリーンポップする
Zendesk API リクエスト ブロックと Zendesk スクリーンポップ ブロックを組み合わせて使用することで、新規リクエストを作成し、着信コールに対応するエージェントにそのリクエストをスクリーンポップ表示させることができます。
サンプルシナリオをダウンロードするには、こちらをクリックしてください: Zendesk Create and Screen Pop a New Request Example.zip
ステップ 1:音声シナリオを作成する
「コンタクトセンター管理者」アプリケーションの シナリオ > 音声セクションで、以下のシナリオブロックを含む新規の基本音声シナリオを作成します: Zendesk アカウントの選択、 Zendesk API リクエスト、および Zendesk スクリーンポップ。
ステップ 2: Zendesk 連携アカウントを指定する
「Zendesk アカウントの選択」ブロックプロパティで、コンタクトセンター用に設定済みの Zendesk 連携アカウントを選択してください。
ステップ 3: Zendesk API リクエストのプロパティを設定する
「Zendesk API リクエスト」シナリオブロックのプロパティで、以下を設定してください:
- リクエストタイプ - 「POST」に設定してください。
- URL - 空欄のままにしてください。
- 追加ヘッダー - 空欄のままにしてください。
- 生の JSON - リクエストオブジェクトのプロパティを生の JSON として貼り付けてください(以下の「生の JSON の例」を参照してください):
- 結果 JSON の初期パス - subjectに設定してください。
- JSON データのシナリオ変数プレフィックス - zendesk.subjectに設定してください。
- GetNext ブロックを使用してデータをループ処理する - チェックを外したままにしてください。
生の JSON の例:
{
"request": {
"requester": {"name": "Anonymous customer"},
"subject": "Example",
"comment": {"body": "Example text." }
}
}
ステップ 4: Zendesk スクリーンポップのプロパティを設定する
Zendesk スクリーンポップ ブロックのプロパティで、チケット オブジェクトがスクリーンポップされるように、以下を設定してください:
- 応答時にスクリーンポップを表示 - オプションです。
- オブジェクト - ラジオボタンを選択してください。
- オブジェクト ID - 変数 $(zendesk.subject) を設定してください。
- オブジェクト タイプ - 「チケット」を選択してください。
ステップ 5: シナリオを保存する
音声シナリオの設定が完了したら、「保存」をクリックして変更を保存してください。
ステップ 6: シナリオのテスト
以下のステップに従って、シナリオが正常に動作するかテストしてください:
- Zendesk で、サービスコールに対応できるチームに割り当てられているエージェントとして、統合された「エージェントデスクトップ」ウィジェットにログインし、ステータスを「受付可能」にしてください。
- 別の電話から、コンタクトセンターのアクセス番号に電話をかけてください。通話はあなたに転送され、新しく作成されたリクエストが画面にポップアップ表示されるはずです。
ユースケース:着信時に Zendesk チケットを更新する
Zendesk API リクエスト ブロックを使用すると、コールがエージェントにルーティングされた際に、Zendesk チケットを更新することができます。
サンプルシナリオをダウンロードするには、こちらをクリックしてください: Zendesk Update a Ticket Example.zip
ステップ 1: 音声シナリオを作成する
「コンタクトセンター管理者」アプリケーションの シナリオ > 音声セクションで、以下のシナリオブロックを含む新規の基本音声シナリオを作成します: Zendesk アカウントの選択 および Zendesk API リクエスト。
ステップ 2: Zendesk 連携アカウントを指定する
「Zendesk アカウントの選択」ブロックプロパティで、コンタクトセンター用に設定済みの Zendesk 連携アカウントを選択してください。
ステップ 3: Zendesk API リクエストのプロパティを設定する
「Zendesk API リクエスト」シナリオブロックのプロパティで、以下を設定してください:
- リクエストタイプ - 「PUT」に設定してください。
- URL - 「requests/170.json」に設定してください。
- 追加ヘッダー - 空のままにしてください。
- 生の JSON - チケットオブジェクトのプロパティを生の JSON として貼り付けてください(以下の「生の JSON の例」を参照してください):
- 結果 JSON の初期パス - subjectに設定します。
- JSON データのシナリオ変数プレフィックス - zendesk.subject
- GetNext ブロックを使用してデータをループ処理する - チェックを外したままにしてください。
生の JSON の例:
{"request":
{"comment":
{"body": "Thanks!"}
}
}
ステップ 4: シナリオを保存する
音声シナリオの設定が完了したら、「保存」をクリックして変更を保存してください。
ステップ 5: シナリオのテスト
以下のステップに従って、シナリオが正常に動作するかテストしてください:
- Zendesk で、サービスコールに対応できるチームに割り当てられているエージェントとして、統合された「エージェントデスクトップ」ウィジェットにログインし、ステータスを「受付可能」にしてください。
- 別の電話から、コンタクトセンターのアクセス番号に電話をかけてください。通話はあなたに転送され、Zendesk のチケットが更新されます。
- Zendesk でチケットを検索し、適切に更新されていることを確認してください。
ユースケース:別の Zendesk ユーザーに代わって新規 Zendesk チケットを作成する
Zendesk API リクエストワークフローブロックを使用すると、任意のエンドユーザーに代わって API リクエストを行うことができます。また、認証済みの管理者であるため、エンドユーザーのメールアドレスの確認は不要です。レコードが作成、更新、または削除された場合、その変更はあなたではなく、そのエンドユーザーに関連付けられます。
この記事では、「Zendesk API リクエスト」ワークフローブロックを使用して、他のユーザーの代理で新規の Zendesk チケットを作成する方法について説明します。
サンプルシナリオをダウンロードするには、こちらをクリックしてください: Zendesk Create Ticket on Behalf of User Example.zip
ステップ 1: 音声シナリオを作成する
「コンタクトセンター管理者」アプリケーションの シナリオ > 音声セクションで、以下のシナリオブロックを含む新規の基本音声シナリオを作成します: Zendesk アカウントの選択 および Zendesk API リクエスト。
ステップ 2: Zendesk 連携アカウントを指定する
「Zendesk アカウントの選択」ブロックプロパティで、コンタクトセンター用に設定済みの Zendesk 連携アカウントを選択してください。
ステップ 3: Zendesk API リクエストのプロパティを設定する
「Zendesk API リクエスト」シナリオブロックのプロパティで、以下を設定してください:
- リクエストタイプ - 「POST」に設定してください。
- URL - 「tickets.json」に設定してください。
- 追加ヘッダー - クリックして、以下の名前(キー)と値を持つ追加ヘッダーを追加してください:
- 名前 - 「X-On-Behalf-Of」に設定します。
- 値 - Zendesk システム内でリクエストの対象となるユーザーのメールアドレスを設定します(例:「first.last@email.com」)。なお、この値は Zendesk システムに実在するユーザーである必要があります。
- 生の JSON - チケットオブジェクトのプロパティを生の JSON として貼り付けてください(以下の「生の JSON の例」を参照してください):
- 結果 JSON 内の初期パス - subjectに設定してください。
- JSON データのシナリオ変数プレフィックス - zendesk.subject
- GetNext ブロックを使用してデータをループ処理する - チェックを外したままにしてください。
生の JSON の例:
{
"ticket": {
"subject": "Behalf Of Header",
"comment": { "body": "first.last@email.com" },
"priority": "urgent"
}
}
ステップ 4: シナリオを保存する
音声シナリオの設定が完了したら、「保存」をクリックして変更を保存してください。
ステップ 5: シナリオのテスト
以下のステップに従って、シナリオが正常に動作するかテストしてください:
- Zendesk で、サービスコールに対応できるチームに割り当てられているエージェントとして、統合された「エージェントデスクトップ」ウィジェットにログインし、ステータスを「受付可能」にしてください。
- 別の電話から、コンタクトセンターのアクセス番号に電話をかけてください。通話はあなたに転送され、同時に、Zendesk システムには正しい情報を含む新規チケットが作成されるはずです。チケットのリクエスト者は、Zendesk Request API ブロックの追加ヘッダーで設定されたユーザーである必要があります。
- Zendesk でそのチケットを検索し、依頼者が正しいユーザーであることを確認してください。
< 前へ