/
■WhatYa仕様書

■WhatYa仕様書

Owned by 空色　小鮒 俊太朗
Last updated: 2024/12/04 by 尾関沙紀
3 min read

WhatYaの基本的な仕様をこのページにまとめています。

 

概要

この資料について

この資料について

こちらの記事は、WhatYaでどのような事ができるか？どう利用するか？を
仕様書としてまとめています。こちらの仕様を参考に、
プロダクトの導入や運用のヒントにしていただけれと思います。

本記事の内容

項目

内容

概要

この資料とWhatYaの概要についての情報

前提条件

WhatYaを導入する為に必要な前提条件

機能

チャットボットの会話タイプや
ダッシュボード機能・会員情報連携機能

導入

タグ埋め込み/CSSなど、WhatYaを導入する際に必要な作業

よくある質問

不明点を解消する為のヒント

概要

項目

詳細

項目

詳細

WhatYaとは？

WhatYaとは「愉快性・役に立つ」というモットーから作られた
チャットサービスです。

ボットが文字だけで回答するだけではなく、多くのお客様が、
多彩な表現や機能を活用してデジタル接客を実現しています。

・多彩なメッセージタイプでの表現

・リストやチップボタンを利用した適切な回答への誘導

・有人とチャットボットを利用したハイブリットな接客の実現

・チャットに特化した傾向分析・CV計測

・レコメンドの様な表示の商品紹介機能
　（スペシャルタグ・アタッチメント）

※AIエンジンにはWatsonを利用しています。

自動応答と有人応答について

WhatYaは、AIチャットボットによる自動応対だけではなく、
有人応対も可能となります。

この連携により、自動応答と有人応答による、
ハイブリットな接客を実現しています。

※自動応答/有人応答の切り替えイメージ

 

 

前提条件

前提条件について

前提条件について

WhatYaを導入する為に必要な前提条件となります。

 

必要要件

詳細

必要要件

詳細

対応ブラウザ

対応ブラウザは以下となります。

・Google Chrome (PC & mobile)
・Safari (PC & mobile)
・Firefox (PC)
・Microsoft Edge (PC)

Internet Explorerには対応していません。
※詳細はこちらをご確認下さい。
https://solairo.atlassian.net/wiki/spaces/CDLAB/pages/661553186

導入可能な環境

  1. 以下JavaScript形式の、タグが埋め込める環境をご用意下さい。
    <script src="https://whatya.solairo-api.com/xxxx/chat.js"></script>
    ※xxxxの部分は導入企業様ごとに異なります。

  2. チャットボタン、チャットウインドウのデザインは、
    ・WebサイトのCSSで編集
    ・WhatYa管理画面の「カスタムCSS」から編集

    どちらかのパターンにて、CSSを記載していただく事でデザインを変更できます。
    ※弊社にてサンプルも用意しておりますのでご活用ください。
    【カスタムCSS】CSSサンプル

  3. 空色側のホワイトリストにドメイン許可がされていないと、
    タグを埋め込んでもチャットボットへ接続ができません。

    ドメイン(FQDN）の許可を行う場合は、担当者まで登録依頼をお願いします。
    例：https://www.solairo.co.jp/

    ※ステージング環境をご利用の場合は
    ステージング環境のドメインも合わせてお知らせください。

    上記項目の詳細はこちらのガイドをご確認下さい。
    WhatYaデザインベンダー向け導入資料

※タグを埋め込むと、Webサイトの右下にチャットアイコンが表示されます

準備するもの

 

準備に必要なもの ※以下資料のp.5〜7を参照下さい。
WhatYaデザインベンダー向け導入資料

変更可能なUI

 

接客管理画面（OKSKY）との連携

接客管理画面（OK SKY）と連携される機能については、以下をご確認下さい。
【WhatYa】接客管理画面(OKSKY)と連携される機能

機能

機能について

機能について

チャットボットの会話タイプやダッシュボード機能・会員情報連携について

自動投稿文

自動投稿文の種類

詳細

自動投稿文の種類

詳細

init_bot

チャットボットを
開いたときの自動投稿文

init_botは、チャットボタンをクリックして、
チャットボットが起動した時、最初に表示される自動投稿文です。
テキストだけではなく、
様々なメッセージタイプを指定する事ができます。

※このinit_botは「list」で作成しています。

 

init_op

オペレーターに接続した
ときの自動投稿文

init_opは、有人接客に切り替えた時、表示される自動投稿文です。
テキストだけではなく、
色々なメッセージタイプを指定する事ができます。

※このinit_opは「text」で作成しています。

 

ボタン設定　
　＞　初期化メッセージ

WhatYa管理画面からボタンを設定する際に、
自由に自動投稿メッセージを変更することができます。
初期化メッセージ設定欄にて送信値を設定することで、
上記のinit_botやinit_op、その他自由に設定が可能です。

メッセージタイプ

メッセージタイプ

詳細

WhatYa管理画面
ダイアログ機能対応

メッセージタイプ

詳細

WhatYa管理画面
ダイアログ機能対応

テキスト

テキストのみの表示

※テキストの改行：〇

○

画像

テキスト＋画像の表示

※テキストの改行：〇

○

リスト

選択式のリストの表示

※テキストの改行：〇
　ただしリスト内テキストの改行は×

○

チップ（値なし）

選択式のボタンの表示

※テキストの改行：〇
※ボタン押下後、テキストが投稿される。

○

チップ（値付き）

選択式のボタンの表示

※テキストの改行：〇
※ボタン押下後、指定したメッセージタイプが投稿される。

○

リンクイメージスライダー

リンク付きの複数画像をスライド式で表示

※テキストの改行：〇

○

アイテムイメージスライダー

複数の画像をスライド式で表示

※テキストの改行：〇

○

テレフォン

電話番号のリンクの表示

※テキストの改行：×

×

メール

メールアドレスのリンクの表示

※テキストの改行：×

×

イメージカード

テキスト＋リンク付きの画像の表示

※テキストの改行：×
※ただしカード内のテキストの改行は〇

○

オペレータ接続

※テキスト記入不可

○

YouTube

動画（YouTube）のストリーミング再生

※テキストの改行：〇
※デフォルトで機能がオンになっています。
　YouTubeのプラグインを取得するため、
　ボタン表示時点でwww.youtube.comにアクセスします。

○

スペシャルタグ

【スペシャルタグ】画面の解説

○

アタッチメント

スペシャルタグ同様の画面表示ですが、Webサイトの商品を連携し、
よりスムーズな商品検索が可能となります。

○

マークダウン

ハイパーリンクの表示

○

その他機能

関連機能

詳細

関連機能

詳細

API

WhatYaは公開したAPIをご用意しております。
チャット機能の一部を利用するためのAPI資料：
┗WhatYa APIs

※APIのみを利用して、WhatYaの機能(オペレーターと接続・会話）を利用する場合、会話を処理する別サーバー(UIや、メッセージ変換など)を必要とします。

この場合、通常の通信方式(WebSocket)とは異なり、Webhookを利用した連携接続となります。

特殊パラメーター

wy_opn=true

上記パラメータ付きのURLにアクセスした際、自動的にWhatYaのウィンドウを開きます。
このパラメーターを指定したときは、ボタンは表示されず、クリックしたことは記録されません。

wy_init_msg=任意のメッセージ

上記パラメータ付きのURLにアクセスした際、パラメーターの値（上記の例であれば「任意のメッセージ」）をWhatYaに送信します。
主に自動投稿文章を変更する際に使用します。

wy_event=任意の値

上記パラメーター付きのURLにアクセスした際、パラメータの値のチャットボット設定を参照します。（内部設定（answers）を参照します。）

※すべてのパラメーターは?や&をつけてご使用ください。

会員情報連携（データ連携）

WhatYaは、Webサイトと簡易的にデータ連携する機能をご用意しております。

大きく分けて以下2つの事が出来るようになります。

・デバイスやブラウザが変わっても同じルームで会話が出来る
・ルームに連携した情報を表示させる。

※詳細設定については、以下記事をご参照ください。
【WhatYa】会員情報連携のトラブルシューティング

ダッシュボード

ダッシュボードはチャットボタン利用統計のグラフや指標をWhatYa管理画面にてご確認いただけます。

※詳細はこちらをご覧ください。

チャット非表示機能

data-no-chat=”true” 属性を埋め込みタグに指定していただくことで、チャットボタンは非表示となります。

非表示タグが埋め込まれていれば、WhatYaよりTreasureDataへのデータ送信が可能になります。

利用例としては、サンクスページの様に、情報は取得したいが、
チャットボタンを表示させたくない場所などにご利用いただけます。

表示タグ例

 

非表示タグ例 ※<scrptの後にdata-no-chat=”true” 属性を追加

WhatYaクライアントAPI

オペレーター接続時に、来訪者が見ている商品、もしくは見ているサイトの情報を、任意のメッセージとしてオペレーターに自動送信できます。

※詳細はこちらをご確認ください。また、導入の際はベンダー様にお問い合わせください。

バッジ機能

オペレーターからのメッセージの未読件数をチャットボタンにバッジとして表示します。

以下の条件を満たしているいずれかのタイミングで表示されます。
※常時、リアルタイムで表示更新保証がなされる機能ではございません。

  • オペレーターへ接続中、かつ、チャットウィンドウを閉じていて（チャットボタンアイコン時）、オペレーターからの未読メッセージがある時。

もしくは

  • ページが読み込まれた最初のタイミング（チャットボタンアイコン時）で、オペレーターからの未読メッセージがある時。

※詳細はこちらをご確認ください。

導入

導入について

導入について

タグ埋め込み/CSSなど、WhatYaを導入する際に必要な作業

作業

詳細

作業

詳細

導入準備について

導入時に必要な項目については前提条件の項目を参照してください。
■WhatYa仕様書 | 準備するもの

よくある質問

よくある質問

よくある質問

WhatYaに関するよくある質問は以下にまとめております。
■よくある質問　記事一覧

WhatYaの埋め込みタグによって取得される情報について（サードパーティークッキー、ローカルストレージについて）
2022/03/30 弊社OK SKY、WhatYaの埋め込みタグにより取得される情報について