SDK参考資料

SDKグローバルメソッド

イニシャル

ダイヤラー API インスタンスを取得し、ダイヤラーインターフェイスが準備できていることを確認します。 ( SDKダイヤラー・インスタンス・メソッド)

パラメータ タイプ 説明
dialerConfig [オブジェクト] ダイヤラーの設定オプション。
callback 機能 コールバック関数。

セットプロバイダー

ダイヤラー・インターフェイスがロードされた後、プロバイダ(CC/UC)の切り替えを許可する。 を切り替えることができます。

  • SDKは、初期ロード中にプロバイダを設定するための他のメソッドを提供します。 ロード中にプロバイダを設定するための Open ContactPad SDKの読み込み)
パラメータ タイプ 説明
provider "cc" / "uc"
  • CCはVonage Call Center ContactPadをダイヤラーインターフェイス/VCC/としてロードします。
  • UCはVonage Business Communicatons ContactPadをダイヤラーインターフェイス/VBC、VBE/として読み込みます。
ccDomain (オプション) [文字列] カスタムVCC領域ドメインを使用する。よく知られているオプションは
  • nam.newvoicemedia.com(デフォルト)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (オプション) [文字列] カスタムVCCアカウント名を使用する。

プレースコール

ダイヤラのインスタンスメソッド placeCall へのショートカットエイリアス (統合でカスタム初期化ができない場合に使用します)。 へのショートカットエイリアスです)。

  • あまりに早く呼ばれた場合、結果は保証されない。
パラメータ タイプ 説明
phoneNumber [文字列] ダイヤルする電話番号
contactable (オプション) [entityRef]。 オプションで、相互作用イベントに添付する優先コンタクトを渡します。

セットプロバイダー

ダイヤラー・インターフェイスがロードされた後、プロバイダ(CC/UC)の切り替えを許可する。 を切り替えることができます。

  • SDKは、初期ロード中にプロバイダを設定するための他のメソッドを提供します。 ロード中にプロバイダを設定するための Open ContactPad SDKの読み込み)
パラメータ タイプ 説明
provider "cc" / "uc"
  • CCはVonage Call Center ContactPadをダイヤラーインターフェイス/VCC/としてロードします。
  • UCはVonage Business Communicatons ContactPadをダイヤラーインターフェイス/VBC、VBE/として読み込みます。
ccDomain (オプション) [文字列] カスタムVCC領域ドメインを使用する。よく知られているオプションは
  • nam.newvoicemedia.com(デフォルト)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (オプション) [文字列] カスタムVCCアカウント名を使用する。

有効ClickToDial

電話番号アノテーションのSDKビルドを有効/無効にする ライブラリを使用します。

パラメータ タイプ 説明
enabled [ブーリアン] ClickToDial アイコンで現在の WEB ページの電話番号を注釈。

国コード

国別電話番号のデフォルト国の設定 を認識します。

  • ClickToDialアノテーション・ライブラリおよびUC ダイヤラーインターフェースの生産性ヘルパーで使用されています。
パラメータ タイプ 説明
countryCode [文字列] 2文字の国コード (ISO 3166-1 alpha-2規格).

SDKダイヤラー・インスタンス・メソッド

VonageDialer.init({ debug: true }, (dialer) => {
  dialer // <- dialer instance 
});

セットビジビリティ

DOTモードでダイヤラーフレームの表示/非表示をプログラムする。 モードで表示/非表示をプログラムします。このメソッドは、ダイアラがコンテナ内にロードされている場合は機能しません。

  • DOT モードでは、ユーザーは Vonage ボタンをクリックすることで ContactPad フレームを呼び出します。 をクリックするとContactPadフレームが起動し、周囲のページ領域のどこかをクリックするとフレームが非表示になります。
パラメータ タイプ 説明
visible [ブーリアン] ダイヤラーフレームの表示/非表示。

setOnDialerEvent

ダイヤラーイベントが発生したときに実行されるコールバック関数を登録します。

パラメータ タイプ 説明
callback 機能 イベント処理コールバック関数。コールバック関数に送られるパラメータは、"type "というプロパティを持つポリモーフィックモデルオブジェクトである。各イベントタイプは独自のプロパティ構造を持っています。

登録SvgIcon

(UCダイヤラーのみ)設定と連絡先の視覚化にカスタム統合アイコンを設定します。

パラメータ タイプ 説明
providerCode [文字列] カスタム統合プロバイダのプログラム名。
dataUrl [文字列] Base64データでエンコードされたSVG画像
* 任意のSVG画像(推奨サイズ64x64px)を オンラインツール.

プレースコール

電話をかける。

パラメータ タイプ 説明
phoneNumber [文字列] ダイヤルする電話番号。
contactable (オプション) [entityRef]。 オプションで、相互作用イベントに添付する優先コンタクトを渡します。

SDKデータモデル

ダイヤラーイベント

ダイアライベントは、タイプ別に分類されたポリモーフィックオブジェクトです。SDKは、統合コードからの応答を必要としない操作にイベントを使用します。

プロパティ タイプ 説明
type [文字列] 対話または操作のイベントタイプ:
  • CALL_START - 初登場コール
  • CALL_ANSWER (*UC のみ) - 通話が接続されました。
  • CALL_END - 通話は最終状態に達した
  • CALL_HISTORY (*UCのみ) - ユーザーが履歴ダイアログインターフェイスからインタラクションを選択しました。
  • CHAT_START (CCのみ)
  • CHAT_END (CCのみ)
  • READY - ユーザーはインターフェイスにログインしている。
  • LOGOUT - ユーザーがログアウトした。
  • HEALTH - テレフォニーサービスの状態(電話をかけたり受けたりする能力)。
data [オブジェクト] イベントデータ。それぞれのタイプは異なるデータスキーマを持っている。

イベントタイプ CALL_START

このイベントはSDKによって一度だけ生成されます。 イベントはSDKによって一度だけ生成されます。 ダイヤラーがリロードされた後にアクティブな通話があったとき。

プロパティ タイプ 説明
id [文字列] テレフォニープロバイダのインタラクション識別子。この識別子はシステムで一意ではありません。サードパーティのストレージでVonageインタラクションとの関連付けを維持するためには、代わりにuidを使用してください。
uid [文字列] 複合インタラクション識別子(システム全体で真の一意性を保証する)。
direction "インバウンド" / "アウトバウンド" 交流の方向性
phoneNumber [文字列] インタラクション・リモート・パーティの電話番号
state [文字列] 相互作用の細かいライフサイクル状態(INITIALIZING -> RINGING -> ACTIVE -> 最終処分)。
internal [ブーリアン/未定義] これがVonageアカウントの内部通信である場合、TRUE。
tag (オプション) [文字列] *VBCのみ。 コールタギング
contact (オプション) [接触可能] 付属のコンタクト。コンタクトは プレースコール アクションだ。
activity (オプション) [entityRef]。 未完成/現在のサードパーティの活動リファレンスを添付。

イベントタイプ CALL_ANSWER

` (UCのみ) このイベントは、通話が接続されたときにSDKによって生成されます。

プロパティ CALL_STARTイベントスキーマ) タイプ 説明
answerDate 日時 回答時間

イベントタイプ CALL_END | CALL_HISTORY

ENDイベントは、対話が最終状態に達したときにSDKによって生成される。HISTORYイベントは、ユーザーが履歴から完了した通話を選択したときに生成されます。

プロパティ CALL_STARTイベントスキーマ) タイプ 説明
answerDate (オプション) 日時 アンサー・タイム(継続時間がゼロの状態を除く)。
endDate 日時 リリース時間
  • カスタムインテグレーションが細かいコールステートロジックに興味がある場合 のために、可能なすべてのコールステートとそのライフサイクルを含むヘルプ定 数を以下に示す:
const ACTIVE_CALL_STATES = ['INITIALIZING', 'RINGING', 'ACTIVE', 'HELD', 'REMOTE_HELD'];
const TALKING_CALL_STATES = ['ACTIVE', 'HELD', 'REMOTE_HELD'];
const RELEASED_CALL_STATES = ['ANSWERED', 'CANCELLED', 'MISSED', 'REJECTED', 'DETACHED', 'DISCONNECTED'];
const ZERO_DURATION_STATES = ['CANCELLED', 'MISSED', 'REJECTED', 'DISCONNECTED'];

ダイヤラコンフィグ

SDK initメソッドの設定オプション。

プロパティ タイプ 説明
debug [ブーリアン]
デフォルト:false
ブラウザのJSコンソールに追加のデバッグ情報を表示する。
provider "cc" / "uc"
デフォルト:"uc"
  • CCはVonage Call Center ContactPadをダイヤラーインターフェイス/VCC/としてロードします。
  • UCは、ダイヤラーインターフェイス/VBC、VBE/としてVonage Integration Platform (VGIP)をロードします。
ccDomain (CCのみ) [文字列] カスタムVCC領域ドメインを使用する。よく知られているオプションは
  • nam.newvoicemedia.com(デフォルト)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (オプション) [文字列] カスタムVCCアカウント名を使用する。
features (UCのみ) [ダイヤラー機能] UCダイヤラーインターフェースのカスタマイズ(余分なUIコントロールの表示/非表示)。

ダイヤラーの特徴

UCダイヤラーインターフェースの追加コントロールの表示/非表示。

プロパティ タイプ 説明
contactsProvider [ブーリアン]
デフォルト:false
有効にすると、ダイヤラは、ユーザーがダイヤルパッドに電話番号を入力すると、設定されたsearchContactablesコールバックを実行し、結果を連絡先の候補として表示します。
openContact [ブーリアン]
デフォルト:false
有効にすると、ダイヤラはインターフェイス内の連絡先の近くに「外部リンクを開く」アイコンを表示します。アイコンをクリックすると、実装されているopenContactコールバックが実行されます。
openActivity [文字列] この値は、カスタム統合で選択した providerCode である必要があります。Vonage Integrationsは、異なる統合ソースからのアクティビティをインタラクションイベントにアタッチします。この値は、カスタム統合プロバイダによって生成されたアクティビティのみをフィルタリングするためのスコープとして使用されます。有効にすると、UCダイヤラーは、対話履歴およびアクティブな通話中に追加の「新規/オープンノート」アイコンを表示します。アイコンをクリックすると、実装されているopenActivityコールバックが実行されます。
eventsHistory [ブーリアン]
デフォルト:true
有効にすると、ダイアラは、ユーザーが対話履歴ダイアログから完了した通話をクリックしたときに、「CALL_HISTORY」タイプの追加イベントを生成します。

接触可能

名前と電話番号を持つ任意のサードパーティのエンティティを表す統一されたオブジェクトで、対話の相手を表すことができます。

プロパティ タイプ 説明
provider [文字列] (必須) カスタム統合コード。連絡先を視覚化する際、UIは同じプロバイダコードを持つ登録されたSVGアイコンで連絡先を装飾します。
id [文字列] (必須) 外部識別子。カスタム統合コンタクトの一意性は、provider+id+typeに基づいている必要があります。
type [文字列] (必須) 外部エンティティのプログラムタイプ。
*一般的なCRMタイプ連絡先、リード、アカウント、候補者など。
label [文字列] (必須) ユーザーがそのオブジェクトが目的のものであることを認識するのに十分な、人間が読めるテキストとして外部エンティティを表す文字列。
*通常、CRMでは、姓と名、および統合のための特別な情報が必要です。
電話番号 [文字列] (必須) 連絡先電話番号。推奨はE.164形式ですが、国コードが正しく設定されていれば、各国の形式にも対応しています。
phoneType [文字列] (オプション) 視覚化のための追加ラベル。統合に2つの番号(自宅と携帯)を持つコンタクトがある場合、phoneNumberとphoneTypeのみが異なる2つの同一のcontactableを使用する必要があります。
typeLabel [文字列] (オプション) 可視化を目的とした、プログラム・エンティティ・タイプのヒューマン・ラベル。

エンティティレフ

統合コードを持つサードパーティエンティティを表す統一オブジェクト。 コード、一意な識別子、およびタイプ

注:オブジェクトはcontactableにもなりえますが、目的はVisualizationではありません(電話番号を必要としません)。リファレンスはインタラクションイベントと一緒に運ばれ、カスタムロジックに使用することができます。

プロパティ タイプ 説明
provider [文字列] (必須) カスタム統合コード。
id [文字列] (必須) 外部識別子。カスタム統合コンタクトの一意性は、provider+id+typeに基づいている必要があります。
type [文字列] (必須) 外部エンティティのプログラムタイプ。*のようなCRMタイプ:ケース、キャンペーン、タスクなど。
label [文字列] (オプション) ユーザーがそのオブジェクトが目的のものであることを認識するのに十分な、人間が読めるテキストとして外部エンティティを表す文字列。
typeLabel [文字列] (オプション) 可視化を目的とした、プログラム・エンティティ・タイプのヒューマン・ラベル。