電話拡張SDKの概要をご紹介します。
demo-minimal-js
の場合:demo-react-ts
の場合:npm start
コマンドを実行すると、https://localhost:9025/に接続された新しいブラウザータブが自動的に開きます。アプリケーションにアクセスするには、「接続がセキュリティーで保護されていない」ことを通知するメッセージをバイパスする必要があります。demo-minimal-js
またはdemo-react-ts
のインストール手順が完了している場合:demo-minimal-js
の場合:demo-react-ts
の場合:eventHandlers
を介して受信されます。利用可能なイベントを網羅したリストが、「イベント」セクションに記載されています。
イベントの説明は次のとおりです。
engagementId
をアプリに送信します。engagementId
によってエンゲージメントをフェッチ(取得)し、その他の通話の詳細とエンゲージメントをマージして更新します。APIを介したコールエンゲージメントの更新、またはSDKを介したコールエンゲージメントの更新について詳細をご確認ください。CallingExtensions
オブジェクトのインスタンスを作成します。拡張機能インスタンスを作成するときにオプションのオブジェクトを指定することで、拡張機能の動作を定義できます。このオプションのオブジェクトは、拡張機能の動作を指定できるeventHandlers
フィールドを提供します。次のコードブロックは、使用可能なオプションと定義可能なイベントハンドラーを示しています。
isReady
フラグは、アプリが本番環境用に準備できているかどうかを示します。テスト中は、このフラグをfalse
に設定する必要があります。isReady
をtrueに変更します。
extensions
オブジェクトは、HubSpotにメッセージを送信したり、他の動作を指定して関連付けたりするために呼び出すことができる、次のイベントハンドラーを提供します。以下の例を参照してください。
プロパティー | 型 | 説明 |
---|---|---|
isLoggedIn | ブール値 | ユーザーがログインしているかどうかをチェックします。 |
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
isAvailable | 数値 | ユーザーが対応可能かどうかをチェックします。 |
プロパティー | 型 | 説明 |
---|---|---|
externalCallId | 文字列 | コールアプリによって作成されるコールID。ヘルプデスクでの通話を有効にするために使用されます。 |
callStartTime | 数値 | コールの開始時刻(ミリ秒単位)。 |
createEngagement | ブール値 | HubSpotにコールのエンゲージメントを作成させるかどうかを指定します。Trueの場合、HubSpotはonCreateEngagementSucceededまたはonCreateEngagementFailedを返します。 |
fromNumber | 文字列 | 発信者の電話番号。必須パラメーター |
toNumber | 文字列 | 受信者の電話番号。 |
プロパティー | 型 | 説明 |
---|---|---|
callStartTime | 数値 | コールの開始時刻(ミリ秒単位)。 |
createEngagement | ブール値 | HubSpotにコールのエンゲージメントを作成させるかどうかを指定します。Trueの場合、HubSpotはonCreateEngagementSucceededまたはonCreateEngagementFailedを返します。 |
toNumber | 文字列 | 受信者の電話番号。 |
fromNumber | 文字列 | 発信者の電話番号。必須パラメーター |
dialingContext | オブジェクト | 該当する場合、チケットやエンゲージメントの作成にダイヤルコンテキストが使用されます。このオブジェクトには、onDialNumber ペイロードのすべてのプロパティーが含まれます。このプロパティーにより、HubSpotとサード パーティー アプリの間で完全なダイヤルコンテキストが戻され、データの一貫性が確保されます。 |
プロパティー | 型 | 説明 |
---|---|---|
externalCallId | 文字列 | コールアプリによって作成されるコールID。ヘルプデスクでの通話を有効にするために使用されます。 |
プロパティー | 型 | 説明 |
---|---|---|
externalCallId | 文字列 | コールアプリによって作成されるコールID。ヘルプデスクでの通話を有効にするために使用されます。 |
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
callEndStatus | 列挙 | 終了時のコールのステータス。有効なステータス:
|
Call
タスクタイプのタスクキューに入っている場合、hideWidget
プロパティーは無視されます。プロパティー | 型 | 説明 |
---|---|---|
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
hideWidget | ブール値 | 通話の終了時にウィジェットを非表示にするかどうかを指定します。任意指定のパラメーターです。デフォルトではtrueに設定されます。 |
engagementProperties | 文字列 | プロパティーを追加して、HubSpot所有のエンゲージメントにオプトインします。これにより、HubSpotはonUpdateEngagementSucceededまたはonUpdateEngagementFailedを返するようになります。 |
externalCallId | 文字列 | コールアプリによって作成されるコールID。ヘルプデスクでの通話を有効にするために使用されます。 |
プロパティー | 型 | 説明 |
---|---|---|
externalCallId | 文字列 | コールアプリによって作成されるコールID。ヘルプデスクでの通話を有効にするために使用されます。 |
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
プロパティー | 型 | 説明 |
---|---|---|
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
objectCoordinates | オブジェクト座標 | portalId 、objectId 、objectTypeID を参照します。 |
プロパティー | 型 | 説明 |
---|---|---|
message | 文字列 | アラートポップアップに表示されるエラーメッセージ。 |
プロパティー | 型 | 説明 |
---|---|---|
height | 数値 | 望ましいコールウィジェットの高さ。 |
width | 数値 | 望ましいコールウィジェットの幅。 |
extensions
オブジェクトは、HubSpotでメッセージを受信した際や、または他の関連する動作を指定するために呼び出すことができる、次のイベントハンドラーを提供します。以下の例を参照してください。
プロパティー | 型 | 説明 |
---|---|---|
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
iframeLocation | 列挙 | widget :コールアプリが インバウンドコールをサポートしていない場合コールレコードページに表示されるドラッグ&ドロップウィジット。remote :コールアプリがインバウンドコールをサポートしている場合にナビゲーション バーの枠に表示されるフレーム。window :コールアプリがインバウンドをサポートしている場合にコールウィンドウに表示されるフレーム。 |
ownerId | 文字列または数値 | HubSpotにログインしているユーザーのID。 |
PortalId | 数値 | HubSpotアカウントのID。 |
userId | 数値 | HubSpotユーザーのID。 |
onDialNumber
イベントのペイロードには、コールに関連付けられている全てのフィールドが含まれます。これらのフィールドについて、以下の表で詳しく説明します。
プロパティー | 型 | 説明 |
---|---|---|
phoneNumber | 文字列 | HubSpotユーザーが電話をかけた相手の電話番号。 |
ownerId | 文字列または数値 | (HubSpotに)ログインしているユーザーのID。 |
subjectId | 数値 | 件名のID。 |
objectId | 数値 | 電話番号のオブジェクトタイプ。 |
objectType | 文字列 | ダイヤルされた電話番号(コンタクトまたは会社の電話番号など)に関連付けられているオブジェクトタイプ。ここで考えられる値は、"CONTACT" または"COMPANY" です。 |
portalId | 数値 | HubSpotポータルのID。 |
countryCode | 文字列 | 電話番号の国コード。 |
calleeInfo | 配列 | 着信者に関する情報。以下を含める必要があります。
|
startTimestamp | 数値 | 通話開始時のタイムスタンプ。 |
toPhoneNumberSrc | 文字列 | ’ HubSpotでの電話番号のプロパティー名。プロパティーには、標準のプロパティー値またはカスタムプロパティーを指定できます。例えば、コンタクトに3つの連絡先電話番号がある場合、それぞれ「Office」、「Personal」、「Mobile」という関連付けラベルを設定できます。 |
プロパティー | 型 | 説明 |
---|---|---|
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
プロパティー | 型 | 説明 |
---|---|---|
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
objectCoordinates | オブジェクト座標 | portalId 、objectId 、objectTypeID を参照します。 |
プロパティー | 型 | 説明 |
---|---|---|
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
externalCallId | 文字列 | コールアプリによって作成されるコールID。ヘルプデスクでの通話を有効にするために使用されます。 |
プロパティー | 型 | 説明 |
---|---|---|
engagementId | 数値 | HubSpotによって作成されるエンゲージメントID。 |
externalCallId | 文字列 | コールアプリによって作成されるコールID。ヘルプデスクでの通話を有効にするために使用されます。 |
outgoingCall
イベントでHubSpotに通知されることを確認する必要があります。
まず、outgoingCallイベントでエンゲージメントを作成するのに、連携で電話拡張SDKが使用されていることを確認します。
createEngagement
がtrueの場合、こちらからアプリ情報を更新する方法をご覧ください。
outgoingCall
イベント全体の例を以下に示します。