Zendesk アプリのインストール ガイド

このドキュメントでは、Contact Center AI プラットフォーム(CCAI プラットフォーム)を使用した Zendesk アプリケーションのインストール手順について説明します。

前提条件

  • CCAI プラットフォーム ポータルへの管理者アクセス権がある。

  • Professional プランまたは Enterprise プランの Zendesk アカウントを持っている。

  • Zendesk アプリファイルをダウンロードしている。

使ってみる

Zendesk アプリは非公開です。一般公開の Zendesk アプリ マーケットプレイスには掲載されません。Zendesk の担当者にお問い合わせのうえ、取得して Zendesk アカウントにインストールしてください。

インストール

以下の手順に沿って、Zendesk アプリサイトのZendesk での限定公開アプリのアップロードとインストールを参照してください。

Zendesk Support で限定公開アプリをアップロードしてインストールする

  1. [設定] をクリックして、管理センターに移動します。

  2. [Apps and Integrations] > [Zendesk Support App] > [Private App] を選択します。

  3. [Upload Private App] をクリックします。

  4. アプリの名前を入力します。例: (通話 V1.4)、(チャット V1.3)

  5. [ファイルを選択] をクリックし、プライベート アプリの zip ファイル(ujet-zendesk-call-v1.4.zip または ujet-zendesk-chat-v1.3.zip)を選択します。

  6. [アップロード] をクリックします。

  7. 表示されたウィンドウで [同意してこのアプリをアップロード] をクリックします。

  8. アカウントのサブドメインを入力します。

  9. メッセージが表示されたら、[インストール] をクリックします。

プロセスが完了すると、プライベート アプリが [アプリの管理] ページのインストール済みアプリのリストに表示されます。

通話アプリとチャットアプリの両方をインストールする必要がある場合は、手順を繰り返します。

次の構成項目を設定する必要があります。

  • アプリ名: 通話とチャットを使用することをおすすめします。

  • アプリの構成

    • Subdomain: アカウントのサブドメインを入力します。例: インスタンス(instance.uc1.ccaiplatform.com など)。

    • ドメイン名: デフォルト値の ue1.ccaipplatfrom.com のままにします。

アプリを管理

申請は Zendesk ポータルから管理できます。

アプリの設定を変更する

インストールしたアプリの設定を変更したり、アプリを更新したりするには、Zendesk の次のリンク(インストールしたアプリの管理)をご覧ください。

アプリの設定(タイトルを含む)を変更するには:

  1. [マイアプリ > 現在インストールされているアプリ] ページで、変更するアプリを見つけます。

  2. 設定を変更するアプリのオプション メニューをクリックし、[設定を変更] を選択します。

  3. 必要な変更を行い、[更新] をクリックします。変更内容は保存されています。

アプリを更新することもできます。

  1. [マイアプリ > 非公開アプリ] ページで、更新するアプリを見つけます。

  2. [オプション] メニューをクリックし、[更新] を選択します。

  3. 更新した zip ファイルをアップロードします。

OAuth クライアントの設定

Zendesk アプリは OAuth 2.0 を使用して、Zendesk への API リクエストを認証します。Zendesk アプリの OAuth クライアントを設定する必要があります。

次の手順に沿って操作するか、Zendesk の次のリンク(アプリケーションで OAuth 認証を使用する)を参照してください。

アプリケーションの登録

  1. Zendesk Support 管理センターで、[アプリとインテグレーション > Zendesk API] をクリックします。

  2. [チャネル/API] ページの [OAuth クライアント] タブをクリックし、クライアント リストの横にある [OAuth クライアントを追加] をクリックします。

  3. 次のフィールドに入力してクライアントを作成します。

    • クライアント名: アプリの名前を入力します。この名前は、ユーザーがアプリケーションへのアクセス権の付与を求められたときや、Zendesk へのアクセス権を持つサードパーティ製アプリのリストを確認するときに表示されます。

    • 説明: 省略可。これは、ユーザーがアプリへのアクセス権の付与を求められたときに表示される、アプリの簡単な説明です。

    • 会社: 省略可。これは、ユーザーがアプリへのアクセス権の付与を求められたときに表示される会社名です。この情報により、ユーザーはアクセス権を付与する相手を把握できます。

    • ロゴ: 省略可。このロゴは、ユーザーがアプリケーションへのアクセス権の付与を求められたときに表示されます。画像は JPG、GIF、PNG のいずれかの形式で指定できます。最適な結果を得るには、正方形の画像をアップロードしてください。認証ページに合わせてサイズが変更されます。

    • 固有の識別子: このフィールドには、アプリに指定した名前を再フォーマットしたものが自動的に入力されます。この値は変更できます。

    • リダイレクト URL: ユーザーがアプリケーションへのアクセスを許可したことを Zendesk が送信する際に使用する URL を入力します。URL は絶対 URL でなければなりません(相対 URL は不可)。また、https でなければなりません(localhost または 127.0.0.1 の場合を除く)。URL は改行で区切る必要があります。

    • クライアントの種類: この設定は [機密] に設定する必要があります。これが [公開] に設定されている場合、CCAI Platform ポータルまたはエージェント アダプタで承認または認証しようとすると、無効な承認リクエスト エラー メッセージが表示されます。

  4. [保存] をクリックします。

    ページが更新されると、新しい事前入力済みの [シークレット] フィールドが表示されます。これは、OAuth2 仕様で指定された「client_secret」値です。

  5. [Secret] の値をクリップボードにコピーし、安全な場所に保存します。

リダイレクト URL

OAuth クライアントのリダイレクト URL を次のように設定します。

https://INSTANCE.ccaiplatform.com/v1/zendesk/oauth_callback

INSTANCE は、CCAI Platform の実際のサブドメインに置き換えてください。

一意の ID とシークレット

新しい OAuth クライアントを追加すると、[Unique Identifier] フィールドと [Secret] フィールドに自動的に値が入力されます。これらは、OAuth2 仕様の client_id 値と client_secret 値です。

必要に応じて [一意の識別子] を編集できますが、[シークレット] は編集できません。

シークレットは、新しいクライアントを追加するときに 1 回だけ完全に表示されます。安全に保管してください。

アプリケーションの設定を構成する

このセクションでは、特定のアプリケーション設定について説明します。

OAuth の構成

  1. 管理者ユーザーとして CCAI Platform ポータルにログインします。

  2. [設定] > [デベロッパー向けの設定] に移動します。

  3. [CRM] セクションで、[エージェント プラットフォーム] Zendesk を選択します。

  4. [Zendesk サブドメイン] を Zendesk アカウントのサブドメインに設定します。

    https://your_zendesk_subdomain.zendesk.com

  5. [OAuth Client ID] を Zendesk OAuth クライアントの一意の識別子に設定します。

  6. [OAuth Client Secret] を Zendesk OAuth クライアントの [Secret] に設定します。

  7. [保存] をクリックします。

 API トークンを生成する**

Zendesk で API トークンを生成する手順は次のとおりです。

  1. Zendesk Support 管理センターで、[アプリとインテグレーション > Zendesk API] をクリックします。

  2. [設定] タブをクリックし、[トークン アクセス] が有効になっていることを確認します。

  3. [アクティブ API トークン] の右側にある [API トークンを追加] ボタンをクリックします。

  4. 必要に応じて、[API トークンの説明] に説明を入力します。トークンが生成され、次のように表示されます。

    トークン表示

  5. トークンをコピーして、安全な場所に貼り付けます。

  1. [Save] をクリックして API ページに戻ります。トークンの切り捨てバージョンが表示されます。

API トークンを構成する

以降のセクションでは、Zendesk API トークンを構成する方法について説明します。

管理設定で API トークンを割り当てる

  1. 管理者アカウントで CCAI Platform ポータルにログインし、[設定] > [デベロッパー設定] に移動します。

  2. [API トークン] に、Zendesk クライアントからコピーした API トークンを設定します。

顧客フィールドとチケット フィールドを作成する

アプリケーションはカスタム フィールドを作成し、値を入力します。管理者ロールとエージェント ロールの両方を持つアカウントを作成する必要があります。

  1. CCAI Platform ポータルで、[Settings > Agent & Manager Team] に移動します。

  2. [管理者を追加] を選択します。

  3. [This admin is also an agent] をオンにします。

  4. 招待メールからアカウントを有効にします。

  5. 現在の管理者アカウントからログアウトし、新しいアカウントでログインします。

  6. 管理者ロール(エージェント ロールではない)で Zendesk にログインします。

  7. Zendesk で、エージェント ロールを持つ管理者である認証情報を使用してウィジェットにログインします。

  8. [承認] をクリックします。

  9. CCAI Platform ポータルで、[Settings] > [Developer Settings] に移動します。

  10. [CRM] > [Customer fields for Contact and Ticket] セクションに移動します。

  11. [作成] をクリックします。

  12. Zendesk からカスタム チケット フィールドが作成されたかどうかを確認するには、以下を参照してください。

    • [管理] > [管理] > [ユーザー フィールド]

    • [Admin] > [Manage] > [Ticket Fields]

フィールド

  • ユーザー フィールド

    • 識別子
  • チケット フィールド

    • 確認(チェックボックス)

    • お客様のテキスト フィードバック(複数行のテキスト)

    • 顧客満足度(数値): 1 ~ 5

    • 共有されたお客様の評価(テキスト): Twitter または Facebook

ドメインベースのアクセス制御

ドメインに基づいてプラットフォームへのアクセスを制限する手順と、CRM 固有のドメインに関連する詳細については、ドメインベースのアクセス制御をご覧ください。