現在のプランを確認
Suite Professional、Enterprise、またはEnterprise Plus
メモ：会話のインテグレーションを作成するには、Zendesk Suite Professionalプラン以上が必要です。Sunshine Conversationsの価格についてはこちらをご覧いただくか、は営業にお問い合わせください。

会話のインテグレーションは、企業があらゆるチャネル、チャットボット、サードパーティアプリからのメッセージを1つの会話に統合し、あらゆる場所にインタラクティブなエクスペリエンスを構築するのに役立ちます。

会話のインテグレーションは、ビジネスとSunshine Conversationsとの間の双方向の対話です。インテグレーションは以下のもので構成されます。
  • Webhook。
  • （オプション）インテグレーションのスコープを持つパブリックAPIと対話するためのAPIキーのセット。APIキーの作成について詳しくは、「Conversations APIキーの使用」を参照してください。

メモ：会話のインテグレーションは、以前はSunshine ConversationsダッシュボードでWebhookと呼ばれていました。

会話のインテグレーションは、管理センターの「会話のインテグレーション」ページで作成することができます。

また、curlやPostmanを使ってインテグレーションを作成することもできます。

この記事では、次のトピックについて説明します。

  • 管理センターでの会話の作成と設定
  • その他のインテグレーション方法

管理センターでの会話の作成と設定

「会話のインテグレーション」ページで、次のことができます。

  • 新しいインテグレーションの作成
  • APIキーの追加
  • インテグレーションの表示、編集、削除

新しいインテグレーションの作成

管理センターで会話のインテグレーションを作成するには
  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「インテグレーション」>「会話のインテグレーション」を選択します。「会話のインテグレーション」ページが開きます。以前に作成した会話がリストに表示されます。

    管理センターで初めてインテグレーションを作成する場合は、「インテグレーションを作成」をクリックして「会話のインテグレーション」ページを表示します。

  2. 「インテグレーションを作成」をクリックします。「インテグレーションを作成」ページが開きます。
  3. インテグレーションを識別しやすい一意の名前を入力します。
  4. 「Webhook」セクションで、次の情報を入力します。
    • WebhookのエンドポイントURL：ターゲットURL。トリガイベントが発生すると、Webhookはそのイベントを確認し、ターゲットURLにデータを送信します。ターゲットURLは、https://www.yourdomain.com/pathの形式で指定します。
    • Webhookのボディデータ：チェックボックスを使用して、ユーザースキーマおよびクライアントとデバイスの情報をWebhookデータに含めるかどうかを指定します。
    • Webhookサブスクリプション：通知を受けたいイベントを選択します。
  5. 「保存」をクリックします。「共有シークレットのコピー」ウィンドウが開きます。
  6. （オプション）Webhook IDおよび共有シークレットをコピーします。これらは、開発者が別の認証層を追加するために使用するもので、必須ではありません。
  7. 「次へ」をクリックします。インテグレーションの設定ページが開きます。ここで、必要に応じてAPIキーを追加できます。

APIキーの追加

「APIキー」タブでは、インテグレーションの認証を設定することができます。アプリケーションまたはユーザーを識別して認証するAPIキーは、次の3つの部分から構成されます。

  • アプリID：Zendeskアカウントを識別します。
  • キーID：シークレットキーと一緒に使用することで、JWTやAPIコールの認証に使用される資格情報です。
  • シークレットキー：認証パスワードです。
メモ：会話のインテグレーションの編集ページで設定されるAPIキーは、カスタムインテグレーション用のものです。これらは特定のカスタムインテグレーションを対象としており、他のインテグレーションを変更することはできません。アプリレベルのAPIキーについては、Sunshine Conversationsの「Authentication」のページを参照してください。

APIキーを作成して共有するには

  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「インテグレーション」>「会話のインテグレーション」を選択します。「会話のインテグレーション」ページが開きます。
  2. 「APIキー」タブをクリックします。
  3. 「APIキーを作成」をクリックします。このボタンは、初めてキーを作成する場合はページの下部に表示され、以前にキーを作成したことがある場合は右上に表示されます。
  4. 「新規キーを作成」ダイアログで、わかりやすいキー名を入力し、「次へ」をクリックします。
  5. 「共有シークレットのコピー」ダイアログで各IDと共有キーについて「コピー」をクリックしてクリップボードに保存し、「次へ」をクリックします。APIウィンドウに戻ると、新しいキーがリストに表示されます。

新しいキーを生成して最大10個の上限を超えた場合、未使用のキーを削除するよう求める通知が表示されます。

未使用のキーを削除するには

  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「インテグレーション」>「会話のインテグレーション」を選択します。
  2. 「APIキー」タブをクリックします。
  3. 削除するビューにカーソルを合わせ、オプションメニュー（）をクリックして「削除」を選択します。
「削除」をクリックして、操作を確定します。

インテグレーションの表示、編集、削除

既存のインテグレーションを使用するには

  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「インテグレーション」>「会話のインテグレーション」を選択します。「会話のインテグレーション」ページが開きます。
  2. 削除するインテグレーションにカーソルを合わせて、オプションアイコン（）をクリックし、次のいずれかのオプションを選択します。
    • 詳細を表示：インテグレーションの詳細ページを表示し、アプリ、インテグレーション、Webhook IDのほか、共有シークレット、Webhookの情報、APIキーに関する情報を確認できます。
    • 編集：「インテグレーションを作成」ページを開き、インテグレーションの名前やWebhookの情報を更新できます。
    • 削除：削除ウィザードを開きます。ウィザードは、いつでもキャンセルして終了することができます。

その他のインテグレーション方法

これらの方法は、Zendesk Suite Professional以上に付属するライセンスではなく、別途Sunshine Conversationsのライセンスを持つユーザーだけが利用できます。

cURLを使用して会話のインテグレーションを作成するには

  1. Create Integration APIを使用してインテグレーションを作成し、typeをcustomに設定します。
  2. APIの指定に従って、必要なパラメータを入力します。ターゲットはサーバーのURLで、トリガのリストによって、どのイベントを受信するかが決まります。

Postmanを使用して会話のインテグレーションを作成するには

  1. Create Integration APIを使用してインテグレーションを作成し、typeをcustomに設定します。
  2. Postmanアプリケーションをダウンロードしてインストールします。
  3. Sunshine ConversationsのPostmanコレクションをダウンロードし、環境を設定します。
  4. Postmanで、「Smooch」>「Integrations」>「Create Integrations」を選択します。
  5. インテグレーションタイプで指定されている必要なパラメータを入力します。

Sunshine Conversations APIの詳細については、「Integrations」を参照してください。

また、「Sending Messages」と「Receiving Messages」のページの説明も参照してください。REST APIを使用してWebhookを設定するとよいでしょう。

Powered by Zendesk