ユーザータグと画面共有の例

この使用例では、API を使用して、Web アプリケーションにログインしているユーザーと画面共有通話を開始する手順の例を説明します。

ユーザがサインインしているページで、アプリケーションから利用可能なユーザーデータを使って、タグ付け方式を呼び出します。これにより、既存のブラウザセッションにユーザ情報が追加されます。

CV.user.tag({
    "email": "[email protected]",
    "firstname": "John",
    "lastname": "Doe",
    "labels": []
})

サポートエージェントまたはアプリケーションのユーザーと画面共有通話を開始できる特別な権限を持つユーザーのみが利用できる UI 要素をアプリケーション内に作成します。

有効なユーザーに関する情報を取得するために、Chatvisor API に対して認証を行う必要があります。これは、情報を要求する前に CV.rest.auth メソッドにユーザートークンを提供することで行われます。

CV.rest.auth("[email protected]", "my-user-token")

ユーザートークンは、REST APIを使用して取得できます。

スクリーン共有ページで、スクリーン共有するユーザーを選択するUIを追加します。以下のオプションのいずれかを選択できます：

このページでは、有効なユーザーのリストを要求し、そのリストをアプリケーションのUI内に表示します：

有効なユーザー

CV.user.list(result => {
  result.forEach(user => addTableRow(user))
})

アプリケーション内で利用可能な既存ユーザー（例えばユーザープロファイル）が既に存在する場合、単一ユーザーのブラウザセッションに関する情報を取得する必要があります。

John Doe

スクリーン共有開始

次に、JavaScript APIを使用して、指定された情報を持つユーザーを検索します。

CV.user.status("[email protected]", status => {
  if(status.visitorId) {
    startButton.show();
  }
})

結果オブジェクトには、タグが作成されたときに提供された情報と、訪問者IDが含まれます。この訪問者IDは、呼び出しAPIを使用してスクリーン共有セッションを開始するために使用できます。

function onClickStart(result) {
  var visitorId = result["visitorId"];
  CV.calling.startScreen(visitorId);
}

ユーザーが正常にタグ付けされた後（ログイン後、オプションでエージェントに割り当てられた後）、タグ関数の id プロパティが設定されている場合、ID なしで会議を開始することができます。

CV.conference.start();

ナレッジベース