CRMからの問い合わせデータ連携設定と仕様

2023年5月23日更新

本機能は現在、ご希望のお客様にのみ開放しています。詳しくはサクセス担当までお問い合わせください。

概要

お客様のCRMから問い合わせデータをRightSupportに取り込む際の設定と仕様を説明します。(問い合わせデータ連携の概要についてはこちら。)

なお、Zendeskをご利用の場合、別途設定をご案内いたしますのでサクセス担当までご連絡ください。

また、KARTE Talkをご利用の場合、こちらをご覧ください。

設定手順

手順1. データ送信の設定

データ送信には、大きく分けて、A. 自動API連携　B. 手動CSV連携　があります。

API連携の方が設定の手間はかかりますが、その後の運用負荷がほぼ掛からなくなるため、基本的にはこちらを推奨しています。

API連携がシステム要件的に難しい、またはスモールスタートで設定負荷低く本機能を試したい、などの場合にCSV連携をご利用ください。

A. 自動API連携

API連携では、下図のように、お客様側のCRMシステムに、RightSupportにデータを送信する設定を行っていただく必要があります。

データ送信は、KARTEのAPI v2という仕組みを利用したAPIリクエストにより行います(なお、利用には事前に申し込みが必要です)。

以下、設定手順を説明します。

CRM側要件の確認

データ送信にあたって、まずお客様のCRMが下記要件を満たすことをご確認ください。

KARTEのサーバ(ドメイン名: api.karte.io)にHTTPリクエストを送信できること
KARTEのビジターIDもしくはユーザーIDのどちらかをCRMで取得可能で、それらが各問い合わせデータに紐付いていること

認証トークンの発行

APIリクエストには、認証トークンの発行が必要です。

KARTE管理画面のグロナビから、「ストア」→「API v2設定」とたどります。
API v2設定画面の右上の「作成」ボタンから新規アプリを作成します。
下記の設定情報を入力し、「保存」を押します。

アプリの種類: token
アプリ名: 任意の名前
説明: 任意の説明
Scope: beta.rightsupport.contactData.upsert および beta.rightsupport.contactData.deleteById

保存後、発行されたアクセストークンを安全な場所に控えておきます。

※ 上記手順で、アプリの作成ができない・Scopeが表示されないなどの場合、弊社サクセス担当までお問い合わせください。

APIリクエスト

トークンの発行ができたら、実際にAPIリクエストを行い、RightSupportにデータを送信します。

APIのヘッダやフィールドなどの詳しい仕様については、こちらのドキュメントをご覧ください。

基本的に、送信側のCRMシステムで採番された値をそのまま送信できます。
センシティブなテキスト情報を送りたくない場合は、問い合わせ本文を送らず、CRMの問い合わせ管理画面URLだけ送ることもできます。
任意項目のフィールドのうち、ビジターIDとユーザーIDのどちらかは、web行動との紐付けに必要になるため、必ず送ってください。
データの送信タイミングは任意ですが、問い合わせチケットが解決したタイミングで送信するのがわかりやすいです。

送信されたデータは、RightSupport管理画面グロナビの「設定」→「外部連携問い合わせデータ管理」から確認できます。

※ 「外部連携問い合わせデータ管理」が表示されない場合、弊社サクセス担当までお問い合わせください。

B. 手動CSV連携

CSV連携では、問い合わせデータのCSVを管理画面から都度手動でアップロードします。

なお、一度にアップロードできるデータに制限がありますのでご注意ください。

ファイルサイズ: 5 MBまで
データ行数: 1000行まで

まず、RightSupport管理画面グロナビの「設定」→「外部連携問い合わせデータ管理」と辿ります。

画面右上の「CSVインポート」をクリックすると、下記モーダルが開きます。

「カテゴリのひな形CSVファイルをダウンロード」より、以下のようなサンプルをダウンロードできます。

id	contactedAt	channel	contactPointId	userId	visitorId	reasonId	urlToContactDetail	text	additionalNote
c1	2022-11-21T01:40:24.612Z	chat	cp1	u1	v1	r1	https://example.com/c1	サンプル問い合わせ本文	サンプル追加メモ
c2	2022-11-21T01:40:24.612Z	call	cp2	u2			https://example.com/c2

各フィールドの仕様は、上記「APIリクエスト」セクションで説明されているものと全く同一ですので、そちらをご参照ください。

CSVファイルが準備できたらファイルをアップロードして完了です。

手順2. 問い合わせ窓口の設定

CRMの問い合わせデータ上での「問い合わせ窓口」に当たる情報を、RightSupportの内部で持っている窓口情報と紐づけるための設定です。

この設定を行うことによって、RightSupportの各種レポートで、問い合わせ窓口別の分析が可能になります。

データ取り込み窓口の作成

まず、KARTE管理画面のグロナビから、「ライトサポート」→「その他の機能・問い合わせ窓口」とたどります。
サイドバーの「データ取り込み窓口」を選択し、右上の「新規作成」ボタンを押します。
下記の設定情報を入力し、「保存」を押します。
- 窓口名: 任意の名前
- 外部ID: 問い合わせデータ送信APIの「contactPointId」フィールドにセットする値
- チャネル: 窓口のチャネル

複数の問い合わせ窓口がある場合は、上記手順を全ての窓口で行なってください。

既存の「サイト内の窓口」の削除 (必要な場合のみ)

APIで送信するデータと同じ問い合わせに紐づく「サイト内の窓口」がすでに設定されている場合は、データ送信を開始するタイミングで削除してください。

サイト内の窓口が残っていると、ユーザーが問い合わせした際に、問い合わせ発生が二重カウントされてしまうためです。

(二重カウントが発生しても、RightSupportでの問い合わせ発生数は基本的にセッション単位でカウントされるため、全体の問い合わせ数が2倍になることはありません。ただし、窓口別に問い合わせを絞り込むなどした場合に、集計結果が実態と食い違う状態になる場合があります。)

参考: Webセッションと問い合わせユーザーの紐付けの仕様

RightSupportに取り込まれた問い合わせデータは、1日一回午前9時ごろに、自動でwebセッションとの紐付けが行われ、ページ詳細レポートで閲覧可能な状態となります。

紐付けにあたっては、問い合わせデータに入っている、

KARTEのユーザーIDもしくはビジターID
問い合わせ時刻

をKARTEのイベントデータと突合して、問い合わせデータに紐付くwebイベントを特定します(下図)。