メインコンテンツまでスキップ

Helpshift API

Helpshiftでは、お客様の要件に応じてSDKの各機能を個別に使用する方法を提供しています。 アプリで公開する機能に基づいて、 SDKから特定の画面のみを呼び出すことができます。

注意

SDKに含まれているすべてのパブリックAPIは、Helpshift installWithPlatformId APIを介してSDKを初期化した後に呼び出す必要があります

お問い合わせとアプリ内メッセージの統合​

API呼び出しshowConversationWithConfig:を使用することで、ユーザーが最初にFAQを閲覧することなく直接フィードバックを送信したり、新しい会話を開始したりすることができるようになります。ユーザーが新しい会話を開始すると、このAPI呼び出しは会話画面を表示します。会話は、エージェントによって解決されるか、または拒否されるまで継続されます。

定義showConversationWithConfig:
サンプルコード[Helpshift showConversationWithConfig:configDictionary];では、configDictionaryは会話に設定する必要のある構成を表すNSDictionaryです。
使用方法「お問い合わせ」または「フィードバックを送信」ボタン

これらの APIオプションに対応しています。

FAQの統合​

API呼び出しshowFAQsWithConfig:を使用することで、ユーザーがアプリ内に設けられたヘルプ/サポートセクションを呼び出すことができるようになります。シンプルで直感的なインターフェースにHelpshift SDKのすべての機能がバンドルされているため、これがアプリでヘルプを有効にする場合の最も簡単なアプローチとなります。このAPI呼び出しは、アプリのヘルプまたはサポートアクションに結び付けることができます。

このビューコントローラーは、FAQ機能、検索機能、お問い合わせ機能を1つのインターフェースに統合したものです。このビューでは、ユーザーはFAQで特定の質問を検索し、見つからなかった場合には問題を報告することができます。Helpshiftエージェントダッシュボードから相手の質問に返信すると、その返信はお問い合わせの横にカウント数として表示され、クリックすると会話が開始されます。

定義showFAQsWithConfig:
サンプルコード[Helpshift showFAQsWithConfig:configDictionary];では、configDictionaryはFAQ画面に設定する必要のある構成を表すNSDictionaryです。
使用方法「ヘルプ」または「サポート」ボタン

これらの APIオプションに対応しています。

特定のFAQセクションの表示​

API呼び出しshowFAQSection:withConfig:を使用することで、特定のFAQセクションのFAQを表示できるようになります。

このAPIを使用するには、以下のようにFAQセクションのpublish-idが必要となります。

この機能は、アプリ内で特定のFAQセクションを文脈依存ヘルプとして表示させるパーマリンクのようなものとして機能します。たとえば、ユーザーがメールアドレスやFacebook、Twitterを使用してあなたのアプリにログインしなければならない場合、ログイン画面にヘルプアクションを紐づけて、ログイン方法に関する質問が複数記載されている「ログインのヘルプ」という名前のHelpshiftのFAQセクションにリンクさせることができます。

定義showFAQSection:withConfig:
サンプルコード[Helpshift showFAQSection:sectionId withConfig:configDictionary];では、sectionIdはセクションのpublishIdであり、configDictionaryはFAQ画面に設定する必要のある構成を表すNSDictionaryです。

これらの APIオプションに対応しています。

特定のFAQの表示​

APIshowSingleFAQ:withConfig:を使用することで、個別のFAQを表示できるようになります。

このAPIを使用するには、以下のようにFAQのpublish-idが必要となります。

定義showSingleFAQ:withConfig:
サンプルコード[Helpshift showSingleFAQ:faqId with:self config:configDictionary];では、faqIdは特定のFAQのpublishIdであり、configDictionaryはFAQ画面に設定する必要のある構成を表すNSDictionaryです。

これらの APIオプションに対応しています。

開いているSDKセッションを終了する​

アクティブなSDKセッションを終了するには、closeSession APIを使用します。このAPIを呼び出すと開いているSDKの画面が閉じられ、対応するライフサイクルデリゲートメソッドが呼び出されます。アクティブなSDKセッションが存在しない場合には、このAPIを呼び出しても何の効果もありません。

[Helpshift closeSession];

SDKのバージョンを取得する​

Helpshift SDKの現在のバージョンを取得するには、sdkVersion APIを使用します。

NSString *sdkVersion = [Helpshift sdkVersion];

SDKの言語を設定する​

このAPIと言語の詳細については、こちらを参照してください。