Action

Prev Next

Classic/VPC環境で利用できます。

チャットボット返答のレスポンスコンポーネントのうち、アクション(Action)について説明します。アクションはすべてのコンポーネント(構成要素)の共通データで、コンポーネントをクリックすると実行する作業を定義します。

アクション(Action)は、次の5つの基本コンポーネントで構成されます。

上記のコンポーネントはそれぞれの特徴に合わせてチャットボットのレスポンスをチャットボットビルダで設定することができ、チャットボットビルダで設定したレスポンス結果を JSON形式で返します。

Postbackコンポーネント

Postbackコンポーネントはテキスト(postbackText)をチャットボットにポストバックし、ポストバックテキストをユーザーのチャットに表示します。

Postbackコンポーネントのレスポンスボディ

Postbackコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • Postbackコンポーネントの場合、postbackのみ使用可能
data Object Required ポストバックコンポーネントの構成情報
data.postback String Required ユーザーのチャットに表示されるテキスト
  • チャットボットに送信時、既存の機能には影響しないが、一部の新機能をサポートしない場合がある
data.postbackFull String Required チャットボットに送る全ポストバックテキスト

Postbackコンポーネントのレスポンス例

Postbackコンポーネントのレスポンスのサンプルコードは次の通りです。

{
    "action": 
    {
        "type": "postback",
        "data": 
        {
            "postback": "Button Name",
            "postbackFull": "_T_Button Name" 
         }
    }
}

Utteranceコンポーネント

Utteranceコンポーネントはテキスト(postbackText)をチャットボットにポストバックし、発話テキストをユーザーのチャットに表示します。

Utteranceコンポーネントのレスポンスボディ

Utteranceコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • Utteranceコンポーネントの場合、utteranceのみ使用可能
data Object Required 発話(Utterance)コンポーネントの構成情報
data.utteranceId Integer Required 発話 ID
data.text String Required ユーザーの入力によりチャット画面に表示されるテキスト
data.postback String Required チャットボットに送るポストバックテキスト

Utteranceコンポーネントのレスポンス例

Utteranceコンポーネントのレスポンスのサンプルコードは次の通りです。

{
    "type": "utterance",
    "data" : 
    {
        "utteranceId" : 1,
        "text" : "text show in chat window",
        "postback" : "postback text"
    }
}

Linkコンポーネント

Linkコンポーネントは、コンポーネントをクリックするとその URLに移動します。

Linkコンポーネントのレスポンスボディ

Linkコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • Linkコンポーネントの場合、linkのみ使用可能
data Object Required リンク(Link)コンポーネントの構成情報
data.url String Required URLアドレス
data.mobileUrl String Required モバイル URLアドレス

Linkコンポーネントのレスポンス例

Linkコンポーネントのレスポンスのサンプルコードは次の通りです。

{
    "type": "link",
    "data" : 
    {
        "url" : "http://www.ncloud.com",
        "mobileUrl" : "http://m.ncloud.com"
    }
}

Phoneコンポーネント

Phoneコンポーネントは、コンポーネントをクリックするとダイヤルページに移動します。

参考

Phoneコンポーネントはモバイル環境でのみサポートします。

Phoneコンポーネントのレスポンスボディ

Phoneコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • Phoneコンポーネントの場合、phoneのみ使用可能
data Object Required 電話(Phone)コンポーネントの構成情報
data.number String Required 電話番号
data.name String Optional 電話帳に登録されている名前

Phoneコンポーネントのレスポンス例

Phoneコンポーネントのレスポンスのサンプルコードは次の通りです。

{
    "type": "phone",
    "data" :   
    { 
        "number" : "400-1111-1111", 
        "name" : "Customer service" 
    }
}

Welcomeコンポーネント

Welcomeコンポーネントは、コンポーネントをクリックするとオープンイベント(Open Event)を送信します。

Welcomeコンポーネントのレスポンスボディ

Welcomeコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • Welcomeコンポーネントの場合、welcomeのみ使用可能
data Object Required ウェルカム(Welcome)コンポーネントの構成情報
data.postback String Required オープンイベント(Open Event)からチャットボットに送信されたポストバックテキスト

Welcomeコンポーネントのレスポンス例

Welcomeコンポーネントのレスポンスのサンプルコードは次の通りです。

{ 
    "type": "welcome", 
    "data" : 
    { 
        "postback" : "postback text, optional" 
    } 
}