Intercom
Intercomで連絡先、企業、会話、チケット、メッセージを管理する
Intercomは、連絡先、企業、会話、チケット、メッセージとのやり取りを一か所で管理・自動化できる主要な顧客コミュニケーションプラットフォームです。SimのIntercom統合により、エージェントは自動化されたワークフローから顧客関係、サポートリクエスト、会話をプログラムで直接管理できます。
Intercomツールでは、以下のことができます:
- 連絡先管理: 連絡先の作成、取得、更新、一覧表示、検索、削除—CRMプロセスを自動化し、顧客記録を最新の状態に保ちます。
- 企業管理: 新しい企業の作成、企業詳細の取得、ユーザーやビジネスクライアントに関連するすべての企業の一覧表示。
- 会話処理: 会話の取得、一覧表示、返信、検索—エージェントが進行中のサポートスレッドを追跡し、回答を提供し、フォローアップアクションを自動化できます。
- チケット管理: プログラムでチケットを作成および取得し、カスタマーサービス、サポート問題の追跡、ワークフローのエスカレーションを自動化します。
- メッセージ送信: ワークフロー自動化内からオンボーディング、サポート、マーケティングのためにユーザーやリードにメッセージをトリガーします。
IntercomツールをSimに統合することで、ワークフローがユーザーと直接通信し、カスタマーサポートプロセスを自動化し、リードを管理し、大規模なコミュニケーションを効率化する能力を与えます。新しい連絡先の作成、顧客データの同期、サポートチケットの管理、パーソナライズされたエンゲージメントメッセージの送信など、Intercomツールはインテリジェントな自動化の一部として顧客とのやり取りを管理するための包括的な方法を提供します。
Intercomをワークフローに統合します。連絡先の作成、取得、更新、一覧表示、検索、削除;企業の作成、取得、一覧表示;会話の取得、一覧表示、返信、検索;チケットの作成と取得;およびメッセージの作成が可能です。
メール、external_id、または役割を使用してIntercomに新しい連絡先を作成する
| パラメータ | 型 | 必須 | 説明 |
|---|
role | string | いいえ | 連絡先の役割。「user」または「lead」を指定可能。未指定の場合は「lead」がデフォルト |
email | string | いいえ | 連絡先のメールアドレス |
external_id | string | いいえ | クライアントが提供する連絡先の一意の識別子 |
phone | string | いいえ | 連絡先の電話番号 |
name | string | いいえ | 連絡先の名前 |
avatar | string | いいえ | 連絡先のアバター画像URL |
signed_up_at | number | いいえ | ユーザーが登録した時刻(Unixタイムスタンプ) |
last_seen_at | number | いいえ | ユーザーが最後に確認された時刻(Unixタイムスタンプ) |
owner_id | string | いいえ | 連絡先のアカウント所有権が割り当てられた管理者のID |
unsubscribed_from_emails | boolean | いいえ | 連絡先がメールの配信停止をしているかどうか |
custom_attributes | string | いいえ | カスタム属性(JSONオブジェクト形式、例:{"attribute_name": "value"}) |
company_id | string | いいえ | 作成時に連絡先を関連付ける会社ID |
| パラメータ | 型 | 説明 |
|---|
contact | object | 作成された連絡先オブジェクト |
IDからIntercomの単一の連絡先を取得する
| パラメータ | 型 | 必須 | 説明 |
|---|
contactId | string | はい | 取得する連絡先ID |
| パラメータ | 型 | 説明 |
|---|
contact | object | 連絡先オブジェクト |
Intercomの既存の連絡先を更新する
| パラメータ | 型 | 必須 | 説明 |
|---|
contactId | string | はい | 更新する連絡先ID |
role | string | いいえ | 連絡先の役割。「user」または「lead」を指定可能 |
external_id | string | いいえ | クライアントが提供する連絡先の一意の識別子 |
email | string | いいえ | 連絡先のメールアドレス |
phone | string | いいえ | 連絡先の電話番号 |
name | string | いいえ | 連絡先の名前 |
avatar | string | いいえ | 連絡先のアバター画像URL |
signed_up_at | number | いいえ | ユーザーが登録した時刻(Unixタイムスタンプ) |
last_seen_at | number | いいえ | ユーザーが最後に確認された時刻(Unixタイムスタンプ) |
owner_id | string | いいえ | 連絡先のアカウント所有権が割り当てられた管理者のID |
unsubscribed_from_emails | boolean | いいえ | 連絡先がメールの配信停止をしているかどうか |
custom_attributes | string | いいえ | カスタム属性(JSONオブジェクト形式、例:{"attribute_name": "value"}) |
company_id | string | いいえ | 連絡先を関連付ける会社ID |
| パラメータ | 型 | 説明 |
|---|
contact | object | 更新された連絡先オブジェクト |
ページネーションをサポートしてIntercomからすべての連絡先をリストする
| パラメータ | 型 | 必須 | 説明 |
|---|
per_page | number | いいえ | ページあたりの結果数(最大:150) |
starting_after | string | いいえ | ページネーション用カーソル - 開始するIDの後 |
| パラメータ | 型 | 説明 |
|---|
contacts | array | 連絡先オブジェクトの配列 |
クエリを使用してIntercomで連絡先を検索する
| パラメータ | 型 | 必須 | 説明 |
|---|
query | string | はい | 検索クエリ(例:{"field":"email","operator":"=","value":"user@example.com"}) |
per_page | number | いいえ | ページあたりの結果数(最大:150) |
starting_after | string | いいえ | ページネーション用カーソル |
sort_field | string | いいえ | ソート対象のフィールド(例:"name"、"created_at"、"last_seen_at") |
sort_order | string | いいえ | ソート順:"ascending"(昇順)または"descending"(降順) |
| パラメータ | 型 | 説明 |
|---|
contacts | array | 一致する連絡先オブジェクトの配列 |
IDでIntercomから連絡先を削除する
| パラメータ | 型 | 必須 | 説明 |
|---|
contactId | string | はい | 削除する連絡先ID |
| パラメータ | 型 | 説明 |
|---|
id | string | 削除された連絡先のID |
deleted | boolean | 連絡先が削除されたかどうか |
metadata | object | 操作メタデータ |
Intercomで企業を作成または更新する
| パラメータ | 型 | 必須 | 説明 |
|---|
company_id | string | はい | 企業の一意の識別子 |
name | string | いいえ | 企業名 |
website | string | いいえ | 企業のウェブサイト |
plan | string | いいえ | 企業のプラン名 |
size | number | いいえ | 企業の従業員数 |
industry | string | いいえ | 企業が事業を展開する業界 |
monthly_spend | number | いいえ | 企業があなたのビジネスに生み出す収益額。注:このフィールドは小数点以下を切り捨てて整数にします(例:155.98は155になります) |
custom_attributes | string | いいえ | JSONオブジェクトとしてのカスタム属性 |
remote_created_at | number | いいえ | あなたが企業を作成した時刻(Unixタイムスタンプ) |
| パラメータ | 型 | 説明 |
|---|
company | object | 作成または更新された企業オブジェクト |
IDによってIntercomから単一の企業を取得する
| パラメータ | 型 | 必須 | 説明 |
|---|
companyId | string | はい | 取得する企業ID |
| パラメータ | 型 | 説明 |
|---|
company | object | 企業オブジェクト |
ページネーションをサポートしてIntercomからすべての企業を一覧表示します。注:このエンドポイントはページネーションを使用して返すことができる企業数が10,000社に制限されています。10,000社を超えるデータセットの場合は、代わりにスクロールAPIを使用してください。
| パラメータ | 型 | 必須 | 説明 |
|---|
per_page | number | いいえ | ページあたりの結果数 |
page | number | いいえ | ページ番号 |
starting_after | string | いいえ | ページネーション用カーソル(ページベースのページネーションより推奨) |
| パラメータ | 型 | 説明 |
|---|
companies | array | 企業オブジェクトの配列 |
IDによりIntercomから単一の会話を取得
| パラメータ | 型 | 必須 | 説明 |
|---|
conversationId | string | はい | 取得する会話ID |
display_as | string | いいえ | プレーンテキストでメッセージを取得する場合は「plaintext」に設定 |
include_translations | boolean | いいえ | trueの場合、会話パーツは会話の検出言語に翻訳されます |
| パラメータ | 型 | 説明 |
|---|
conversation | object | 会話オブジェクト |
ページネーションサポート付きでIntercomからすべての会話を一覧表示
| パラメータ | 型 | 必須 | 説明 |
|---|
per_page | number | いいえ | ページあたりの結果数(最大:150) |
starting_after | string | いいえ | ページネーション用カーソル |
sort | string | いいえ | ソートするフィールド(例:「waiting_since」、「updated_at」、「created_at」) |
order | string | いいえ | ソート順:「asc」(昇順)または「desc」(降順) |
| パラメータ | 型 | 説明 |
|---|
conversations | array | 会話オブジェクトの配列 |
管理者としてIntercomで会話に返信する
| パラメータ | 型 | 必須 | 説明 |
|---|
conversationId | string | はい | 返信する会話ID |
message_type | string | はい | メッセージタイプ:「comment」または「note」 |
body | string | はい | 返信のテキスト本文 |
admin_id | string | いいえ | 返信を作成する管理者のID。指定しない場合、デフォルトの管理者(Operator/Fin)が使用されます。 |
attachment_urls | string | いいえ | カンマ区切りの画像URL一覧(最大10個) |
created_at | number | いいえ | 返信が作成されたときのUnixタイムスタンプ。指定しない場合、現在時刻が使用されます。 |
| パラメータ | 型 | 説明 |
|---|
conversation | object | 更新された会話オブジェクト |
クエリを使用してIntercomで会話を検索する
| パラメータ | 型 | 必須 | 説明 |
|---|
query | string | はい | JSONオブジェクトとしての検索クエリ |
per_page | number | いいえ | ページあたりの結果数(最大:150) |
starting_after | string | いいえ | ページネーション用カーソル |
sort_field | string | いいえ | ソートするフィールド(例:「created_at」、「updated_at」) |
sort_order | string | いいえ | ソート順:「ascending」または「descending」 |
| パラメータ | 型 | 説明 |
|---|
conversations | array | 一致する会話オブジェクトの配列 |
Intercomで新しいチケットを作成する
| パラメータ | 型 | 必須 | 説明 |
|---|
ticket_type_id | string | はい | チケットタイプのID |
contacts | string | はい | 連絡先識別子のJSON配列(例:[{"id": "contact_id"}]) |
ticket_attributes | string | はい | _default_title_と_default_description_を含むチケット属性のJSONオブジェクト |
company_id | string | いいえ | チケットに関連付ける会社ID |
created_at | number | いいえ | チケットが作成された時間(Unixタイムスタンプ)。提供されない場合、現在時刻が使用されます。 |
conversation_to_link_id | string | いいえ | このチケットにリンクする既存の会話のID |
disable_notifications | boolean | いいえ | trueの場合、チケット作成時の通知を抑制します |
| パラメータ | 型 | 説明 |
|---|
ticket | object | 作成されたチケットオブジェクト |
IDによりIntercomから単一のチケットを取得する
| パラメータ | 型 | 必須 | 説明 |
|---|
ticketId | string | はい | 取得するチケットID |
| パラメータ | 型 | 説明 |
|---|
ticket | object | チケットオブジェクト |
Intercomで管理者が開始した新しいメッセージを作成して送信する
| パラメータ | 型 | 必須 | 説明 |
|---|
message_type | string | はい | メッセージタイプ:アプリ内メッセージの場合は「inapp」、メールメッセージの場合は「email」 |
template | string | はい | メッセージテンプレートスタイル:プレーンテキストの場合は「plain」、パーソナライズスタイルの場合は「personal」 |
subject | string | いいえ | メッセージの件名(emailタイプの場合) |
body | string | はい | メッセージの本文 |
from_type | string | はい | 送信者タイプ:「admin」 |
from_id | string | はい | メッセージを送信する管理者のID |
to_type | string | はい | 受信者タイプ:「contact」 |
to_id | string | はい | メッセージを受信する連絡先のID |
created_at | number | いいえ | メッセージが作成された時間(Unixタイムスタンプ)。提供されない場合、現在時刻が使用されます。 |
| パラメータ | 型 | 説明 |
|---|
message | object | 作成されたメッセージオブジェクト |
- カテゴリー:
tools
- タイプ:
intercom
Intercomで新しい管理者主導のメッセージを作成して送信します。API準拠のフィールドのみを返します。
| パラメータ | 型 | 必須 | 説明 |
|---|
message_type | string | はい | メッセージタイプ:アプリ内メッセージの場合は「inapp」、メールメッセージの場合は「email」 |
template | string | はい | メッセージテンプレートスタイル:プレーンテキストの場合は「plain」、パーソナライズスタイルの場合は「personal」 |
subject | string | いいえ | メッセージの件名(メールタイプの場合) |
body | string | はい | メッセージの本文 |
from_type | string | はい | 送信者タイプ:「admin」 |
from_id | string | はい | メッセージを送信する管理者のID |
to_type | string | はい | 受信者タイプ:「contact」 |
to_id | string | はい | メッセージを受信する連絡先のID |
created_at | number | いいえ | メッセージが作成された時刻(Unixタイムスタンプ)。未指定の場合は現在時刻が使用されます |
| パラメータ | 型 | 説明 |
|---|
message | object | 作成されたメッセージオブジェクト |
↳ id | string | メッセージの一意の識別子 |
↳ type | string | オブジェクトタイプ(message) |
↳ created_at | number | メッセージが作成された時刻(Unixタイムスタンプ) |
↳ body | string | メッセージの本文 |
↳ message_type | string | メッセージのタイプ(in_appまたはemail) |
↳ conversation_id | string | 作成された会話のID |
↳ owner | object | メッセージの所有者 |
messageId | string | 作成されたメッセージのID |
success | boolean | 操作の成功ステータス |
ワークスペースのすべての管理者のリストを取得
| パラメータ | 型 | 説明 |
|---|
admins | array | 管理者オブジェクトの配列 |
↳ id | string | 管理者の一意の識別子 |
↳ type | string | オブジェクトタイプ(admin) |
↳ name | string | 管理者の名前 |
↳ email | string | 管理者のメールアドレス |
↳ job_title | string | 管理者の役職 |
↳ away_mode_enabled | boolean | 管理者が離席モードかどうか |
↳ away_mode_reassign | boolean | 離席時に会話を再割り当てするかどうか |
↳ has_inbox_seat | boolean | 管理者が有料の受信トレイシートを持っているかどうか |
↳ team_ids | array | 管理者が所属するチームIDのリスト |
↳ avatar | object | アバター情報 |
↳ email_verified | boolean | メールアドレスが確認済みかどうか |
type | string | オブジェクトタイプ(admin.list) |
Intercomで会話をクローズする
| パラメータ | 型 | 必須 | 説明 |
|---|
conversationId | string | はい | クローズする会話のID |
admin_id | string | はい | アクションを実行する管理者のID |
body | string | いいえ | 会話に追加するオプションのクローズメッセージ |
| パラメータ | 型 | 説明 |
|---|
conversation | object | クローズされた会話オブジェクト |
↳ id | string | 会話の一意の識別子 |
↳ type | string | オブジェクトタイプ(conversation) |
↳ state | string | 会話の状態(closed) |
↳ open | boolean | 会話がオープンかどうか(false) |
↳ read | boolean | 会話が既読かどうか |
↳ created_at | number | 会話が作成されたUnixタイムスタンプ |
↳ updated_at | number | 会話が最後に更新されたUnixタイムスタンプ |
conversationId | string | クローズされた会話のID |
state | string | 会話の状態(closed) |
Intercomでクローズまたはスヌーズされた会話をオープンする
| パラメータ | 型 | 必須 | 説明 |
|---|
conversationId | string | はい | オープンする会話のID |
admin_id | string | はい | アクションを実行する管理者のID |
| パラメータ | 型 | 説明 |
|---|
conversation | object | オープンされた会話オブジェクト |
↳ id | string | 会話の一意の識別子 |
↳ type | string | オブジェクトタイプ(conversation) |
↳ state | string | 会話の状態(open) |
↳ open | boolean | 会話がオープンかどうか(true) |
↳ read | boolean | 会話が既読かどうか |
↳ created_at | number | 会話が作成されたUnixタイムスタンプ |
↳ updated_at | number | 会話が最後に更新されたUnixタイムスタンプ |
conversationId | string | オープンされた会話のID |
state | string | 会話の状態(open) |
会話をスヌーズして将来の時刻に再開する
| パラメータ | 型 | 必須 | 説明 |
|---|
conversationId | string | はい | スヌーズする会話のID |
admin_id | string | はい | アクションを実行する管理者のID |
snoozed_until | number | はい | 会話が再開される時刻のUnixタイムスタンプ |
| パラメータ | 型 | 説明 |
|---|
conversation | object | スヌーズされた会話オブジェクト |
↳ id | string | 会話の一意の識別子 |
↳ type | string | オブジェクトタイプ(conversation) |
↳ state | string | 会話の状態(snoozed) |
↳ open | boolean | 会話が開いているかどうか |
↳ snoozed_until | number | 会話が再開されるUnixタイムスタンプ |
↳ created_at | number | 会話が作成された時刻のUnixタイムスタンプ |
↳ updated_at | number | 会話が最後に更新された時刻のUnixタイムスタンプ |
conversationId | string | スヌーズされた会話のID |
state | string | 会話の状態(snoozed) |
snoozed_until | number | 会話が再開されるUnixタイムスタンプ |
Intercomで会話を管理者またはチームに割り当てる
| パラメータ | 型 | 必須 | 説明 |
|---|
conversationId | string | はい | 割り当てる会話のID |
admin_id | string | はい | 割り当てを実行する管理者のID |
assignee_id | string | はい | 会話を割り当てる管理者またはチームのID。割り当てを解除するには「0」を設定 |
body | string | いいえ | 割り当て時に追加するオプションのメッセージ(例:「サポートチームに引き継ぎます」) |
| パラメータ | 型 | 説明 |
|---|
conversation | object | 割り当てられた会話オブジェクト |
↳ id | string | 会話の一意の識別子 |
↳ type | string | オブジェクトタイプ(conversation) |
↳ state | string | 会話の状態 |
↳ open | boolean | 会話がオープンかどうか |
↳ admin_assignee_id | number | 割り当てられた管理者のID |
↳ team_assignee_id | string | 割り当てられたチームのID |
↳ created_at | number | 会話が作成された時刻(Unixタイムスタンプ) |
↳ updated_at | number | 会話が最後に更新された時刻(Unixタイムスタンプ) |
conversationId | string | 割り当てられた会話のID |
admin_assignee_id | number | 割り当てられた管理者のID |
team_assignee_id | string | 割り当てられたチームのID |
ワークスペース内のすべてのタグのリストを取得する
| パラメータ | 型 | 説明 |
|---|
tags | array | タグオブジェクトの配列 |
↳ id | string | タグの一意の識別子 |
↳ type | string | オブジェクトタイプ(tag) |
↳ name | string | タグの名前 |
type | string | オブジェクトタイプ(list) |
新しいタグを作成するか、既存のタグ名を更新する
| パラメータ | 型 | 必須 | 説明 |
|---|
name | string | はい | タグの名前。見つからない場合は新しいタグを作成し、IDが指定されている場合は名前を更新します。 |
id | string | いいえ | 更新する既存のタグのID。新しいタグを作成する場合は省略します。 |
| パラメータ | 型 | 説明 |
|---|
id | string | タグの一意の識別子 |
name | string | タグの名前 |
type | string | オブジェクトタイプ (tag) |
特定の連絡先にタグを追加する
| パラメータ | 型 | 必須 | 説明 |
|---|
contactId | string | はい | タグを付ける連絡先のID |
tagId | string | はい | 適用するタグのID |
| パラメータ | 型 | 説明 |
|---|
id | string | タグの一意の識別子 |
name | string | タグの名前 |
type | string | オブジェクトタイプ (tag) |
特定の連絡先からタグを削除する
| パラメータ | 型 | 必須 | 説明 |
|---|
contactId | string | はい | タグを削除する連絡先のID |
tagId | string | はい | 削除するタグのID |
| パラメータ | 型 | 説明 |
|---|
id | string | 削除されたタグの一意の識別子 |
name | string | 削除されたタグの名前 |
type | string | オブジェクトタイプ(tag) |
特定の会話にタグを追加する
| パラメータ | 型 | 必須 | 説明 |
|---|
conversationId | string | はい | タグを付ける会話のID |
tagId | string | はい | 適用するタグのID |
admin_id | string | はい | タグを適用する管理者のID |
| パラメータ | 型 | 説明 |
|---|
id | string | タグの一意の識別子 |
name | string | タグの名前 |
type | string | オブジェクトタイプ(tag) |
特定の連絡先にメモを追加する
| パラメータ | 型 | 必須 | 説明 |
|---|
contactId | string | はい | メモを追加する連絡先のID |
body | string | はい | メモのテキスト内容 |
admin_id | string | いいえ | メモを作成する管理者のID |
| パラメータ | 型 | 説明 |
|---|
id | string | ノートの一意の識別子 |
body | string | ノートのテキストコンテンツ |
created_at | number | ノートが作成された時刻(Unixタイムスタンプ) |
type | string | オブジェクトタイプ(note) |
author | object | ノートを作成した管理者 |
↳ type | string | 作成者タイプ(admin) |
↳ id | string | 作成者ID |
↳ name | string | 作成者名 |
↳ email | string | 作成者のメールアドレス |
contact | object | ノートが作成された連絡先 |
↳ type | string | 連絡先タイプ |
↳ id | string | 連絡先ID |
Intercomで連絡先のカスタムイベントを追跡する
| パラメータ | 型 | 必須 | 説明 |
|---|
event_name | string | はい | イベントの名前(例:「order-completed」)。可読性のため過去形の動詞-名詞形式を使用してください。 |
created_at | number | いいえ | イベントが発生した時刻のUnixタイムスタンプ。一意性のため強く推奨されます。 |
user_id | string | いいえ | ユーザーの識別子(external_id) |
email | string | いいえ | ユーザーのメールアドレス。アプリがメールを使用してユーザーを一意に識別する場合のみ使用してください。 |
id | string | いいえ | Intercomの連絡先ID |
metadata | string | いいえ | イベントに関する最大10個のメタデータキーと値のペアを含むJSONオブジェクト(例:{"order_value": 99.99}) |
| パラメータ | 型 | 説明 |
|---|
accepted | boolean | イベントが受け入れられたかどうか(202 Accepted) |
Intercomで連絡先を会社に関連付ける
| パラメータ | 型 | 必須 | 説明 |
|---|
contactId | string | はい | 会社に関連付ける連絡先のID |
companyId | string | はい | 連絡先を関連付ける会社のID |
| パラメータ | 型 | 説明 |
|---|
company | object | 連絡先が関連付けられた会社オブジェクト |
↳ id | string | 会社の一意の識別子 |
↳ type | string | オブジェクトタイプ(company) |
↳ company_id | string | 定義した会社ID |
↳ name | string | 会社名 |
↳ created_at | number | 会社が作成されたUnixタイムスタンプ |
↳ updated_at | number | 会社が更新されたUnixタイムスタンプ |
↳ user_count | number | 会社内のユーザー数 |
↳ session_count | number | セッション数 |
↳ monthly_spend | number | 月間支出額 |
↳ plan | object | 会社のプラン詳細 |
companyId | string | 会社のID |
name | string | 会社名 |
Intercomで連絡先を企業から削除する
| パラメータ | 型 | 必須 | 説明 |
|---|
contactId | string | はい | 企業から切り離す連絡先のID |
companyId | string | はい | 連絡先を切り離す企業のID |
| パラメータ | 型 | 説明 |
|---|
company | object | 連絡先が切り離された企業オブジェクト |
↳ id | string | 企業の一意の識別子 |
↳ type | string | オブジェクトタイプ(company) |
↳ company_id | string | 定義した企業ID |
↳ name | string | 企業名 |
companyId | string | 企業のID |
name | string | 企業名 |