ドキュメント

連絡先プロパティ

アカウント種別、地域、契約ティアなど、連絡先向けのカスタムフィールドを定義し、ウィジェット経由で渡します。プロパティは連絡先のプロフィールに表示され、担当者が編集でき、受信トレイでフィルタリングできます。

概要#

連絡先プロパティを使うと、組み込みフィールド(email、name、userId)を超えた構造化データを会話に付与できます。自由形式の metadata とは異なり、プロパティは型・ラベル・検証を備えた定義済みスキーマを持ちます。HubSpot や Salesforce のカスタムフィールドに似ています。

スキーマを定義

string、number、enum、boolean、date、url などの型で、エージェント設定にプロパティ定義を作成します

ウィジェットから渡す

Respondo.identify() でプロパティ値を送信します。値は自動的に保存・表示されます

フィルタ & 編集

受信トレイでプロパティ値によって会話をフィルタリングできます。担当者は連絡先プロフィールで連絡先の属性を確認・編集できます。

プロパティの定義#

プロパティは エージェント設定 → 連絡先プロパティ でエージェントごとに定義します。各プロパティには次の項目があります:

フィールド説明
keyコード内で使う一意の識別子。ラベルから自動生成されます(編集可能)。小文字の英字・数字・アンダースコアのみで、先頭は英字、2〜63 文字。システムキー(user_id、 visitor_id、 timezone、 page_url など)は予約済みです。例: account_type
labelダッシュボードに表示される人間が読める名前。例: "Account Type"
type値の型: string, number, boolean, enum, date, url
enum_valuesenum 型の場合 — 許可される値のリスト。例: ["starter", "pro", "enterprise"]
is_filterable将来のフィルター制御のために予約されています。定義とともに保存されますが、現在の受信トレイのフィルターピッカーは定義済みのすべてのプロパティを一覧表示します(デフォルト: true)
is_visible将来の表示制御のために予約されています。定義とともに保存されますが、UI ではまだ適用されていません(デフォルト: true)
エージェントごとに最大 50 個のプロパティを設定できます。プロパティは設定 UI 上でドラッグ&ドロップにより並べ替えできます。

ウィジェットから渡す#

プロパティ値は Respondo.identify() の properties フィールドで渡します。キーはエージェント設定のプロパティ定義と一致している必要があります。

ウィジェット連携javascript
Respondo.identify({
  email: 'user@example.com',
  name: 'Jane Smith',
  userId: 'usr_456',
  properties: {
    account_type: 'enterprise',   // enum
    region: 'eu-west',            // string
    monthly_spend: '15000',       // number(文字列として渡す)
    is_partner: 'true',           // boolean(文字列として渡す)
    contract_end: '2026-12-31',   // date
    dashboard_url: 'https://app.example.com/org/123'  // url
  }
});
すべてのプロパティ値は文字列として渡されます。ダッシュボードが型ごとの表示を処理します(例: boolean → Yes/No、url → クリック可能なリンク、enum → バッジ)。

連携スニペット#

連携スニペット は、プロパティを 1 つ以上定義すると、エージェント設定 → 連絡先プロパティの下に自動的に表示され、すべてのプロパティキーがあらかじめ入力されています。 コピー をクリックして取得し、アプリケーションに貼り付けてください。生成されたスニペットには、本人確認(HMAC-SHA256)用の userHash プレースホルダーも含まれます。

値の保存方法#

プロパティ値は、会話の metadata JSONB フィールドに cp_ というプレフィックス付きで保存されます。例えば、キー account_type のプロパティは cp_account_type として保存されます。

プロパティはメッセージごとに更新されます。ウィジェットが新しい値を送ると、既存の値が上書きされます。つまりプロパティ値は常にアプリケーションの最新データを反映します。

受信トレイでのフィルタリング#

受信トレイのフィルターバーまたは保存済みビューを使って、プロパティ値で会話をフィルタリングできます。 プロパティ 条件を追加し、名前でプロパティを選び — ピッカーはすべてのエージェントにわたる定義を一覧表示し、定義のない生のキーも受け付けます — 値を選択します。値フィールドは、入力に応じて観測された値と enum の値を候補として表示します。

API では、会話リストのエンドポイントが cp.<key>=<value> クエリパラメータ(attr.<key> の完全なエイリアス)を受け付けます。フリーテキストのクエリ構文はありません:

GET /api/v1/conversations?cp.account_type=enterprise

値の編集#

プロパティ値はあなたのアプリケーションによって — ウィジェット連携または API 経由で — 設定され、会話詳細パネルでは読み取り専用です。パネルには連絡先プロフィールへのリンクがあり、担当者はそこで連絡先の属性を確認・編集できます(Contacts → 連絡先 → 属性)。

プロパティ vs メタデータ

機能propertiesmetadata
スキーマエージェント設定で型付きで定義自由形式のキーと値のペア
フィルタ可能可能。フィルターバー / 保存済みビュー経由(API: cp.<key> パラメータ)不可
担当者による編集不可 — 値はアプリケーションから取得されます。連絡先の属性は連絡先プロフィールで編集します不可
型付き表示可能(バッジ、リンク、日付、真偽値)プレーンテキストのみ
オートコンプリート可能。フィルターの値フィールドでの値候補不可
フィルタリングや型付き表示が不要なアドホックなフィールドには metadata を使ってください。チームがセグメンテーションやワークフローで積極的に使う構造化データには properties を使ってください。