メインコンテンツにスキップ

Intercom開発者FAQ

開発者向けドキュメント、APIs、webhooks、アプリに関するよくある質問への回答。

対応者:Phil Moore

この記事では、Intercom開発環境の設定、SSL付きのカスタムHelp Centerドメインの構成、アクセス・トークンまたはOAuthによるアプリ認証、Intercom APIを使った連絡先、会話、ticketsの管理方法を説明します。また、webhooks、ページネーション、MessengerおよびInboxアプリの構築、一般的なAPIおよびSSLエラーのトラブルシューティングも扱います。Intercomとの統合を構築する開発者向けです。


Intercomの設定

開発者アカウントはどう作成しますか?

アプリ開発用に新しい開発者ワークスペースを作成できます。開発者ワークスペースは無料で、開発目的専用です。作成後はこのガイドに従い、アプリを作成して最初のAPIコールを行えます。

本番ワークスペース用に新しいアプリを作成し、アクセス・トークンを取得するには、https://app.intercom.com/a/apps/{your-workspace-id}/developer-hub/にアクセスしてください。

カスタムhelp centerドメインはどう設定しますか?

Articles Help Centerを有効にすると、コンテンツはデフォルトでintercom.help経由で利用可能になります。URLは次のようになります:intercom.help/exampleapp。

別のURLを使いたい場合は、カスタムドメインを手動で設定して作成できます。Help Center設定でカスタムドメインを入力し、カスタムCNAMEレコードを作成し、必要に応じてSSLを設定します。設定手順はdeveloper documentationにあります。 カスタムドメイン設定後にHelp Centerで「not found」エラーが出る場合は、CNAMEレコードが正しいIntercomホストを指しているか確認してください: • HTTPS Quick Setupの場合:us.intercomhelpcenter.com(米国リージョン) • 手動/HTTP設定の場合:custom.intercom.help(米国リージョン) また、Help Center設定のセキュリティプロトコルがDNS設定と一致しているかも確認してください。

SSLはどう設定しますか?

SSL(またはTLS)は、サーバーとブラウザ間の接続を安全にする最も一般的な方法です。接続が暗号化され安全であることを保証し、HTTPSとして表示されます。

カスタムドメインのArticlesでSSLを設定する方法は2つあります:

  • 柔軟なSSLを使用する(CloudFlareやAWS CloudFrontなどのサードパーティDNSプロバイダーを利用)

  • 独自のSSL証明書を使用する(TLS終了プロキシを利用)

IntercomはカスタムドメインのSSL証明書を管理しますか?

はい!Help Center設定で「HTTPS(quick setup)」を有効にすると、Intercomがカスタムドメイン(例:https://help.ourdomain.com)のSSL証明書を自動的に発行・管理します。手動でのSSL設定は不要です。CNAMEをus.intercomhelpcenter.comに向けるだけで、残りはIntercomが対応します。

注意:HTTPS(quick setup)はすべてのワークスペースでデフォルトで利用できるわけではありません。サポートチームが有効化できます。有効化されると、Help Center設定にHTTPS(quick setup)オプションが表示されます。以下のDNS設定手順に従って設定を完了してください。

カスタムドメインでHTTPS(quick setup)を有効にする方法

カスタムドメインをHTTPSに切り替えたい場合:

  1. 設定 > Help Center > Configure & Styleに移動します。

  2. Domain セクションに進みます。

  3. セキュリティプロトコルとしてHTTPS(quick setup)を選択し、変更を保存します。

  4. 有効化後、CNAMEレコードがドメインプロバイダーで[us.intercomhelpcenter.com](https://us.intercomhelpcenter.com)(またはEUリージョンの場合は[eu.intercomhelpcenter.com](https://eu.intercomhelpcenter.com))を指していることを確認してください。設定成功時には通常48時間以内に確認メールが届きます。

カスタムドメインのSSLを設定して機密情報を暗号化できます。これを行う場合は、CloudflareのようなSSL対応のDNSプロバイダーでCNAMEを設定してください。

SSL設定についてはdeveloper documentationのガイドに従ってください。プロバイダーによって設定手順が異なる場合があります。

高度なトラブルシューティング

標準のSSLおよびHTTPS設定で問題が解決しない場合、カスタムHelp Centerドメインの一般的な例外ケースを以下に示します:

  • HTTPSが手動設定にデフォルトされる場合:正確な設定手順はCustom Domains Guideを参照してください。

  • ドメインが「Not Secure」と表示される場合:HTTPでホストされているhelp centerを保護するには、以下を検討してください:

    • CloudflareやAWS CloudFrontなどのサードパーティDNSプロバイダーを使った柔軟なSSLプロキシの利用。

    • 高度なSSL証明書管理のためのTLS終了プロキシの利用。

一般的なHTTPS/SSLの問題とトラブルシューティング

1. ドメインが安全でない

  • ドメインに対してIntercomのSSL証明書のみが有効であることを確認してください。ホストやCDN(Content Delivery Network)にある追加の証明書は削除または無効にしてください。

  • CloudflareなどのCDNを使用している場合は、プロキシステータスを「DNSのみ」(グレーの雲アイコン)に設定してください。

  • DNSのCNAMEレコードが正しいIntercomエンドポイント(米国はus.intercomhelpcenter.com、EUはeu.intercomhelpcenter.com)を指していることを確認してください。

ERR_SSL_VERSION_OR_CIPHER_MISMATCH エラー

  • CNAME(Canonical Name)レコードが[us.intercomhelpcenter.com](https://us.intercomhelpcenter.com)を指していることを確認してください。

  • 競合するDNS(Domain Name System)レコードが存在しないことを確認してください。ドメインエントリにはCNAMEが1つだけ有効であるべきです。重複は削除してください。

  • DNSの伝播には最大72時間かかる場合があります。whatsmydns.netなどのツールで世界中の伝播状況を確認できます。

2. HTTPS設定が保留のまま進まない

  • CNAMEレコードの書式エラー(例:誤って.yourdomain.comを付加)や誤ったレコードタイプ(例:Aレコードの代わりにCNAMEを使う)など、一般的なDNS設定の問題を確認してください。

  • CNAMEレコードがus.intercomhelpcenter.com(EU地域の場合はeu.intercomhelpcenter.com)を指していることを確認してください。

  • 修正後、DNSの伝播には最大72時間かかることがあります。再テスト前にwhatsmydns.netでグローバル伝播を確認してください。

3. HTTPS(クイックセットアップ)オプションが利用できない

  • HTTPSクイックセットアップをワークスペースで有効にするにはFinサポートに連絡してください。デフォルトでは利用できません。

  • ドメインが他のIntercomアカウントで既に使用されていないことを確認してください。

  • DNSプロバイダーにCNAMEレコードが追加され、us.intercomhelpcenter.comを指していることを確認してください。

4. アクセス拒否エラー

  • CNAMEレコードが正しくus.intercomhelpcenter.comを指していることを確認してください。

  • Cloudflareを使用している場合は、SSLを「Flexible」または「Full」に設定してください。「Full(Strict)」は避けてください。

  • SSL構成を一度オフにしてから再度オンにして、SSLプロビジョニングシーケンスを再起動してください。


Help CenterのURLとドメイン管理

移行後の壊れたURL

コンテンツをIntercomに移行した後、記事のURLが機能しなくなった場合:

  • 壊れたURLの代わりに新しい公開記事を作成してください。

  • コンテンツ内のすべての行動喚起やリンクを新しい記事のURLに更新してください。

記事が内部で正常に見えても「Not found」エラーが発生する場合

Help Centerの公開URLで「Not found」エラーが表示されるが、ワークスペース内で記事が正しく表示される場合:

  • 設定でHelp Centerがライブになっているか確認してください。

  • 設定 > Help Centerに移動し、ステータスをライブに設定して公開URLをアクセス可能にしてください。


Intercom API

APIの現在のバージョンは何ですか?

APIの現在のバージョンは2.18です。APIのドキュメントはdeveloper documentation siteで確認できます。Developer Hubでこのガイドの手順に従って使用するバージョンを変更することも可能です。

Intercom APIを使用している場合は、リクエストのHTTPヘッダー内でもバージョンを変更できます。

注意:開発者ドキュメントにはレガシー1.x API(/docs/references/1.0/や/docs/references/1.1/を含むURL)のリファレンスページもあります。これらのページはバージョン2.xで使用されない/usersや/leadsなどのエンドポイントを説明しています。必ず現在のバージョンのリファレンスページ(/docs/references/rest-api/)を参照してください。

APIの現在のバージョンで利用可能なエンドポイントは何ですか?

Intercom APIバージョン2.18で利用可能な主なエンドポイントは以下の通りです。Folders、Dynamic Content、Roles、Auth Tokens、Granted Companiesなどの新しいAPIも2.18で利用可能です。完全なリストはAPI referenceをご覧ください。

ボタンからMessengerで記事を開くことはできますか?

はい、Messengerで記事を開くトリガーを設定したい場合は、JavaScript APIのshowArticle メソッドを使用できます。記事はMessenger内で開き、Messengerの戻るボタンをクリックすると前の画面に戻ります。メソッド呼び出し時にMessengerが閉じている場合は、最初にMessengerが開き、その後記事が表示されます。これはMessengerのすべてのプラットフォームで利用可能です。

HTMLから記事をトリガーする方法

# You can add a link anywhere on your site to open an article in the Messenger: 

<a href="#" onclick="Intercom('showArticle', 123)">Open article</a>


連絡先

/usersエンドポイントと/contactsエンドポイントのどちらを使うべきですか?

/contactsを使用してください。現在のAPIでは、usersとleadsは両方ともcontactsであり、Create a contact(POST /contacts)およびUpdate a contact(PUT /contacts/{id})エンドポイントで作成または更新します。POST /usersはレガシーな1.xエンドポイントであり、現在のAPIバージョンでは動作しません。

メールアドレスなしで連絡先を作成するには?

連絡先には少なくともメールアドレスかexternal_idが必要です。メールなしでユーザーを作成するには、独自の一意識別子をexternal_idとして送信してください。/contactsエンドポイントではこのフィールドはexternal_idと呼ばれ、user_idではありません。メールなしでuser_idを送信すると、either_email_or_user_id_present validation failedエラーが返されます。

POST https://api.intercom.io/contacts

{
"external_id": "cust_001",
"name": "Jane Doe",
"custom_attributes": {
"Currency": "EUR"
}
}

設定したカスタム属性は設定 > データ > 人々に既に存在している必要があります。存在しない場合、リクエストは属性が存在しないというエラーを返します。

APIを使ってユーザーを一括作成できますか?

はい。Intercomではユーザーはcontactsのラベルに含まれます。Bulk create contacts endpointを使って、一度のリクエストで多くのcontactsを作成できます。あるいは、create contact endpointをスクリプトで使い、ユーザーを一人ずつインポートすることも可能です。また、このチュートリアルでコードサンプルを確認できます。

レート制限チェックを設定して、制限に達していないことを確認してください。適用される制限については下記の現在のレート制限は?を参照してください。

一括操作とその制限

大量のcontactsをインポートするには、Bulk create contacts endpointまたはcreate contact endpointをループで使い、適切なレート制限処理を行ってください。スクリプトはレート制限を遵守する必要があります。

以下の一括操作はAPIでは利用できません。ループ処理の単一アイテムリクエストか手動のエクスポート/インポートで対応してください。

  • 一括会話エクスポート(会話データのエクスポートにはData Export endpointを使用)

  • 一括ノート削除(ノートはワークスペースUIから一つずつ削除する必要があります)

アーカイブされたユーザーのデータを取得するには?

アーカイブされたcontactのデータを取得するには、まずcontactをアンアーカイブする必要があります。contactのIDがあればunarchive contact API endpointで可能です。

その後、get a contact API endpointでcontactのデータにアクセスでき、retrieve a conversation API endpointで会話にアクセスできます。

UIからユーザーやcontactをアンアーカイブすることはできません。API経由で行う必要があります。

API経由でcontactのノートを削除できますか?

いいえ、現在APIで個別のノート削除や一括削除はできません。この機能が重要な場合はProduct Wishlistで機能リクエストを作成、コメント、投票してください。ノートはワークスペース内で手動で一つずつ削除可能です。


会話

APIを使って会話をチームに割り当てるには?

APIで会話をチームに割り当てるには2つの方法があります。

1つ目はmanage a conversation API endpointを使い、会話を直接管理者またはチームに割り当てる方法です。会話のIntercomプロビジョニングID、admin_id、assignee_idが必要です。

もう1つはrun assignment rules on a conversation API endpointを使い、既に設定済みの割り当てルールを会話に適用する方法です。会話のIntercomプロビジョニングIDが必要です。

機能は開発者ドキュメントの「Try It」機能、Intercom Postmanコレクション、またはご自身のターミナルやIDEで試せます。Intercomアクセストークンをベアラートークンとして使用するのを忘れないでください。

APIを使って会話にノートを追加するには?

ノートはチームメイトだけが見られる内部コメントです。会話にノートを追加するにはreply to a conversation API endpointを使います。message_typeにnoteを、typeに「admin」を選び、ノートの発信元となるadmin_idを指定してください。

機能は開発者ドキュメントの「Try It」機能、Intercom Postmanコレクション、またはご自身のターミナルやIDEで試せます。Intercomアクセストークンをベアラートークンとして使用するのを忘れないでください。

APIを使って会話にタグを追加するには?

UIで既にタグを作成していれば、そのタグを会話に適用できます。またAPIで新しいタグを作成することも可能です。

add tag to a conversation API endpointを使うには、タグ付けする会話のconversation_id、タグのIntercomプロビジョニングID、admin_idが必要です。

機能は開発者ドキュメントの「Try It」機能、Intercom Postmanコレクション、またはご自身のターミナルやIDEで試せます。Intercomアクセストークンをベアラートークンとして使用するのを忘れないでください。

APIを使って会話を作成するには?

APIから、contact(ユーザーまたはlead)が開始した会話を作成できます。create a conversation API endpointを使用します。会話はアプリ内メッセージのみ可能です。

リクエスト時にはcontactのIntercomプロビジョニングIDとメッセージ本文のテキストが必要です。

機能は開発者ドキュメントの「Try It」機能、Intercom Postmanコレクション、またはご自身のターミナルやIDEで試せます。Intercomアクセストークンをベアラートークンとして使用するのを忘れないでください。

デフォルトでは、この方法で作成された会話はcontactが返信するまでInboxに表示されず、会話検索でも見つかりません。返信を待たずにすぐInboxに表示するには、リクエストペイロードに「create_conversation_without_contact_reply」: trueを含めてください。指定しない場合はfalseがデフォルトです。

IDがあっても会話が全く表示されない場合は?

リクエストペイロードのbodyフィールドが欠落、空、または不正な場合、APIは成功レスポンスを返し、メッセージ内容なしの会話シェルを作成することがあります。Inboxはメッセージなしの会話を表示できないため、UIで開くと404(「会話を読み込めませんでした」)が返されますが、APIではIDで取得可能です。この場合、統合のbodyフィールドが存在し空でないこと、message_typeが正しく設定されていること(例:inappまたはemail)を確認してください。この種の壊れた会話は復元できず、修正したペイロードで再作成する必要があります。

APIで会話を削除するには?

APIで会話を閉じるにはmanage a conversation API endpointを使用します。会話のIntercomプロビジョニングID、admin_idが必要で、message_typeに「close」を指定してください。

会話の一部だけを編集する必要がある場合はredact a conversation part API endpointを使用してください。

機能は開発者ドキュメントの「Try It」機能、Intercom Postmanコレクション、またはご自身のターミナルやIDEで試せます。Intercomアクセストークンをベアラートークンとして使用するのを忘れないでください。

チームメイトが会話に割り当てられたときのカスタム通知を設定するには?

チームメイトが会話に割り当てられたなどのアクション時にカスタム通知を設定するには、webhooksを使用できます。

conversation.admin.assigned会話トピックを使用してください。すべての会話トピックは開発者ドキュメントで確認できます。

このwebhookトピックにはこのガイドの手順に従って開発者ハブで購読してください。通知を届けるために、webhookがヒットした際に動作する公開可能なエンドポイントURLも必要です。

APIを使ってサイド会話にアクセスするには?

サイド会話には専用のエンドポイントがないため、直接取得することはできません。ただし、サイド会話が添付されている会話を取得すると、"part_type": "side_conversation_reply" と表示される会話パーツがあり、そこにサイド会話内のユーザーのメッセージ内容が含まれています。


Tickets

APIを使ってチケットを作成するにはどうすればよいですか?

Intercom APIを使ってチケットを作成するには、まず新しいチケットにラベル付けするチケットの種類を作成または取得する必要があります。その後、curlリクエストやお好きなプログラミング言語でチケットを作成できます。

開発者向けドキュメントのこのガイドに従って、チケットタイプを作成し、新しいチケットを作成してください。

APIを使う際にバックオフィスのticketsをカウントしないようにフラグを付けるにはどうすればよいですか?

APIでticketsやticketデータを取得する場合は、search tickets API endpointを使用できます。バックオフィスのticketタイプを除外するには、フィールドにticket_type_idを設定し、!=演算子を使ってバックオフィスticketタイプに割り当てられたticket_type_idを除外してください。

APIを使って会話を取得したり、会話を一覧表示したりする際に、バックオフィスのticketsが関連付けられている場合、それらを除外したい場合は、同様にバックオフィスticketタイプを属性として持つ結果をフィルタリングできます。リンクされたticketsはレスポンスのticketsパラメータまたはlinked_objectsにあります。

もう一つの方法として、APIを使って会話にバックオフィスticketをタグ付けすることができます。そうすれば、そのタグを使ってticketカテゴリでフィルタリングできます。


エラーコードとメッセージ

レスポンスで403 API Plan restrictedエラーメッセージが表示されるのはどういう意味ですか?

レスポンスで403 API Plan restrictedメッセージが表示される場合、それは使用しようとしているAPIがあなたのアプリのプランで利用できないことを意味します。

APIにアクセスするにはプランをアップグレードする必要があります。Intercomのプランについてはこちらのページをご覧ください。エラーコードの完全なリストはこちら、HTTPレスポンスのリストはこちらの開発者ドキュメントにあります。

レスポンスで409 conflictエラーメッセージが表示されるのはどういう意味ですか?

レスポンスで409 conflictメッセージが表示される場合、それはIntercomワークスペース内にリクエストデータと衝突する既存データがあることを意味します。例えば連絡先を作成しようとして、そのメールアドレスの連絡先がすでにアプリ内に追加されている場合などです。

このエラーを避けるには、代わりに更新エンドポイントを使うか、external_idで新しい連絡先を作成してください。エラーコードの完全なリストはこちら、HTTPレスポンスのリストはこちらの開発者ドキュメントにあります。

レスポンスで429エラーメッセージが表示されるのはどういう意味ですか?

429メッセージが表示される場合、それはクライアントがレート制限に達したか超過したか、またはサーバーが過負荷状態であることを意味します。デフォルトのパブリックおよびプライベートアプリの制限については現在のレート制限とは?をご覧ください。レート制限の詳細は開発者ドキュメントにあります。

このエラーを避けるには、レート制限チェックを設定して、制限に達していないことを確認してください。エラーコードの完全なリストはこちら、HTTPレスポンスのリストはこちらの開発者ドキュメントにあります。

現在のレート制限とは?

プライベートアプリは、ワークスペースごとに1分あたり10,000 APIコールのデフォルトレート制限があり、ワークスペース内のすべてのプライベートアプリで共有されます。つまり、ワークスペースに複数のプライベートアプリがインストールされている場合、それぞれが同じ合計に寄与します。

パブリックアプリは、各アプリごとに1分あたり10,000 APIコール、ワークスペースごとに1分あたり25,000 APIコールのデフォルトレート制限があります。つまり、ワークスペースに複数のパブリックアプリがインストールされている場合、それぞれが独自のリクエスト制限を持ち、他のアプリの制限に影響を与えません。レート制限の詳細は開発者ドキュメントにあります。


レポート

APIから取得したレポートとUIのレポートが異なるのはなぜですか?

APIを使って独自のレポートを作成する場合、両者のレポートに違いがあることがあります。これはいくつかの理由によるものです。

よくある問題の一つは、日付と時間が一致しないことです。これは、Intercomワークスペースで使用しているタイムゾーンとAPIクエリで使用しているタイムゾーンが異なるために起こります。これを修正するには、APIクエリパラメータをワークスペースのタイムゾーンに合わせるか、カスタムレポートのタイムゾーンを変更してください。

もう一つの問題は、APIで使用している指標がIntercomのレポーティングUIの指標と一致しない場合です。レポーティングUIで利用可能な一部の指標は計算済み指標であるため、APIでは利用できません。それらの一部はAPIを使って取得し、こちらで計算することで作成可能です。Intercom開発者ドキュメントの独自レポート作成ガイドをご覧ください。

APIからレポートを取得する際にバックオフィスのticketsは統計に含まれますか?

UIで利用可能な会話レポートと会話APIで取得したレポートを比較すると、会話数に違いがあることがあります。これは、APIから取得した際に会話に関連付けられたバックオフィスのticketsが含まれるためです。

これを解決するには、list conversations、retrieve a conversation、またはsearch for conversations APIで取得後に結果をフィルタリングし、会話APIレスポンスのticketフィールドを使ってticketsと会話を分けてください。ticketフィールドはチケットの場合はオブジェクトが入り、会話の場合はnullになります。


Webhook

利用可能なwebhookは何ですか?

Webhookを使うと、連絡先が作成されたり受信メッセージが届いたりするなど、Intercomで発生するイベントのリアルタイム通知を購読できます。

各バージョンで利用可能なwebhookは当社の開発者ドキュメントで確認できます。必要なwebhookがわかったら、このガイドに従って設定してください。

新しいwebhookを追加する予定はありますか?

新しいwebhookを追加する予定はロードマップにはありませんが、チームで必要なwebhookがあればリクエストを送るか、Intercomコミュニティの製品ウィッシュリストに追加してください。

Webhookの信頼性と配信

Intercomのwebhookを構築する際は、以下を考慮してください。

  • 再試行ポリシー:Intercomはwebhook配信失敗時に再試行します。エンドポイントが2xx以外のレスポンスを返すと、Intercomはリクエストを再試行します。エンドポイントは重複配信に対応できるよう設計してください(冪等性を持たせる)。

  • タイムアウト:エンドポイントは短時間で応答する必要があります。タイムアウトすると配信失敗とみなされ、再試行されます。

  • 順序:Webhookイベントは発生した正確な順序で届く保証はありません。イベントのタイムスタンプを使ってシステム内で正しく順序付けしてください。

  • デバッグ:Developer Hubではwebhook配信履歴や送信されたペイロードは表示されません。見逃したり不正なイベントをデバッグするには、エンドポイントで受信リクエストをログに記録し、トピック、通知ID、返すレスポンスコードを含めてください。Developer Hubのアプリのwebhook設定で各トピックのサンプルペイロードをプレビューでき、設定保存時にテストリクエストがエンドポイントURLに送信され通知受信を確認します。特定の配信調査が必要な場合はFin Supportにお問い合わせください。


ページネーション

ページネーションはどのように機能しますか?

IntercomのAPIはリストや検索リソースにカーソルベースのページネーションを提供しています。大量のデータ(多くの会話とその全パーツなど)をリクエストする際に、小分けに受け取り処理できるようにするためです。

IntercomのリストAPI(パスパラメータ使用)と検索API(クエリパラメータ使用)の両方でページネーションを使う例は、当社のページネーションガイドをご覧ください。

starting_afterフィールドはどう使いますか?

カーソルベースのページネーションでは、Intercomはリクエストごとに指定したページ数の制限に基づいて特定のレコードを指すポインタを使用します。

オブジェクトで返される場合、ポインタは「WzXXXXXXXXXXXXXX」のように見えます。

その後、レスポンスのポインタを使って次のデータバッチのリクエストを行えます。

リクエストのページネーションのフォーマットはlist APIとsearch APIでわずかに異なりますが、レスポンスは同じように動作します。

curlリクエストの例はPagination pageで確認でき、list APIやsearch APIの使い方チュートリアルもあります。


認証

パブリックアプリにはどのタイプの認証が必要ですか?

サードパーティのworkspaceデータと連携するアプリやCanvas Kitで作成されたアプリはOAuthが必要です。ユーザーにアクセス トークンを尋ねることはせず、OAuthのみを使ってデータにアクセスしてください。

OAuth設定の手順はドキュメントをご覧ください。

アプリにOAuthを使う必要がありますか?

他人のIntercomデータにアクセスする統合を作る場合はOAuthの設定が必要です。これはIntercomアプリストアに掲載予定のパブリックアプリや、自社サイト経由でユーザーにインストールを促すアプリや統合も含みます。詳しくは開発者ドキュメントをご覧ください。

自分のIntercom workspace内のデータにのみアクセスする場合はアクセス トークンを使えます。

プライベートアプリにはどのタイプの認証が必要ですか?

自分のIntercom workspace内のデータにのみアクセスするプライベートアプリの場合は、Intercomアクセス トークンを認証に使えます。開発者ハブでアクセス トークンを見つけて、認証について詳しく学んでください。

Intercomアクセス トークンはどこで見つけられますか?

APIで自分のIntercom workspaceのデータにアクセスする場合はIntercomアクセス トークンを使えます。開発者ハブでアクセス トークンを見つけて、認証について詳しく学んでください。

APIアクセス トークンを見つけるには、以下の手順に従ってください:

  1. Intercom Developer Hubを開きます。

  2. Developer Hub > Settings > Your AppsのYour Appsに移動します。workspaceに関連付けられたアプリの一覧が表示されます。

  3. プライベートアプリを探します。workspace名や「Access Token App」という接尾辞が付いていることがあります。

  4. アプリ名をクリックして詳細を開きます。

  5. Authenticationセクションでトークンを見つけます。このトークンはパスワードのように扱い、秘密にして共有しないでください。

OAuthクライアントシークレットをローテーションまたは変更できますか?

アプリのOAuthクライアントシークレットは自分でローテーションできませんが、サポートチームに依頼すれば対応します。ローテーション後は古いシークレットは即座に無効になり、新しいシークレットはDeveloper Hubで利用可能です。

重要:ローテーションすると古いシークレットは即座に無効になります。サービス停止を避けるため、ローテーション後すぐに統合設定を更新できるよう準備してください。

ローテーションを依頼するにはMessengerでメッセージを送り、サポートチームと話してください。アプリ名とクライアントIDを伝え、ローテーションの時間を決めて、チームが新しいシークレットで統合設定をすぐに更新できるようにしてください。


アプリのインストールと公開

Inbox用のアプリはどう作りますか?

Canvas Kitを使ってIntercom Inbox用のアプリを作れます。Canvas KitはIntercom UI内で直接動作するアプリを作るためのツールキットです。

このチュートリアルで最初のInboxアプリの作り方を学べます。Canvas Kitの詳細やリファレンスは開発者ドキュメントにあります。

Messenger用のアプリはどう作りますか?

Canvas Kitを使ってIntercom Messenger用のアプリを作れます。Canvas KitはIntercom UI内で直接動作するアプリを作るためのツールキットです。

カスタマイズはCanvas Kitで可能な範囲に限られ、Messenger内で作成する必要があります。Messengerの再現やスキン変更はできません。

このチュートリアルで最初のInboxアプリの作り方を学べます。Canvas Kitの詳細やリファレンスは開発者ドキュメントにあります。

アプリはどうやってインストールしますか?

Developer HubのTest & Publish > Your Workspacesページにアクセスすると、あなた(Intercomチームメンバー)が所属するすべてのworkspaceが表示されます。

インストールしたいworkspaceの横にある「Install app」をクリックすると、そのworkspaceにアプリがインストールされます。API経由でデータにアクセスできるように、そのworkspace用のAccess Tokenも提供されます。

サードパーティのインストール手順は開発者ドキュメントをご覧ください。

Intercomアプリストアにアプリを公開するには?

公開準備ができたら、開発者ハブの手順に従ってください。開発者ドキュメントに公開方法のガイドがあります。


Messenger

iOS用Messengerはどうやってインストールしますか?

iOS用Intercom SDKを使うと、アプリ内でIntercom Messengerを利用し、顧客と会話したり、リッチな送信メッセージを送ったり、Help Centerを表示したり、イベントを追跡できます。

Intercom for iOSはCocoapods、Swift Package Manager、手動でインストールできます。完全なiOSインストールガイドをお読みください。GitHubのIntercom for iOSとサンプルアプリもご覧いただけます。

Android用Messengerはどうやってインストールしますか?

Android用Intercom SDKを使うと、アプリ内でIntercom Messengerを利用し、顧客と会話したり、リッチな送信メッセージを送ったり、Help Centerを表示したり、イベントを追跡できます。

Intercom for AndroidはGradleまたは手動でインストールできます。完全なAndroidインストールガイドをお読みください。GitHubのIntercom for Androidとサンプルアプリもご覧いただけます。

React Native用Messengerはどうやってインストールしますか?

Intercom React Nativeラッパーを使うと、React NativeアプリでiOS用IntercomとAndroid用Intercomを利用できます。React Nativeインストールガイドに従って始めてください。

こちらの回答で解決しましたか?