Catalyst

by Zoho
×
キャンセル

このページにアクセス
  • チュートリアル
  • FAQ
  • 開発者ツール
    CLI
    SDK
    Java Node.js Python Web Android iOS Flutter
    REST API
    ユーティリティ
    拡張機能 ツール インテグレーション
    • コンソールへ

    お知らせ：

    当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

    Deluge Object Reference

    Deluge Object Referenceドキュメントは、ConvoKraftにおけるDelugeファンクションのさまざまな要素について詳細に説明することを目的としています。ConvoKraftがサポートするコアオブジェクトには、データアクセスオブジェクト、入力オブジェクト、およびレスポンスオブジェクトが含まれます。このセクションでは、それぞれについて詳しく説明します。

    sessionData

    クライアントの現在のチャットセッションに関する詳細です。このデータは、sessionData引数の下ですべてのファンクションで利用可能です。

    Delugeデータ型 利用可能範囲
    Map すべてのファンクション

    この引数は以下のキーで構成されます:

    キー名 Delugeデータ型 説明 サンプル値
    medium Text ユーザーがBotと対話する通信モードです。取りうる値はcallまたはchatです。 chat
    client_host Text Botをホストするクライアントアプリケーションの種類です。取りうる値はmobileまたはwebです。 web
    client_identifier Text クライアントの一意の識別子です。
    client_identifierがwebの場合、Webアプリケーションの URLです。
    client_identifierがmobileの場合、モバイルアプリケーションのパッケージ名バンドル識別子です。     		https://zylker.com
    client_data Map セッション開始時にクライアントからConvoKraftに渡されるデータです。 { "user_email": "todd@hmail.com" }

    cache

    cacheオブジェクトは、一時的なストレージ変数として機能します。このオブジェクトにキーと値のペア形式で保存されたデータは、現在実行中のActionのすべてのファンクションで、そのActionの実行が完了するまでアクセス可能です。

    Delugeデータ型 利用可能範囲
    Map すべてのファンクション

    broadcast

    Botに現在実行中のActionに関連する情報を記憶させたい場合、その情報をbroadcastオブジェクトに保存できます。この値は現在のActionの実行後も保持され、現在のチャットセッションが終了するまで、以降のすべてのActionで利用可能です。後続のActionは、ビジネスロジックの必要に応じてこの値を使用できます。

    Delugeデータ型 利用可能範囲
    Map すべてのファンクション

    messageData

    messageDataオブジェクトには、各トランスクリプト（Botの会話内のメッセージ）リクエストに対してクライアントがdataキーで送信したカスタムメッセージが含まれます。

    Delugeデータ型 利用可能範囲
    Map すべてのファンクション

    param

    ユーザーが各静的paramに対して提供した入力値は、Delugeファンクション全体で同じparam名のオブジェクトの下にキャプチャされます。

    Delugeデータ型 利用可能範囲
    対応するparamのデータ型 Context handlerファンクションおよびAction executionファンクション

    previousParam

    previousParamオブジェクトには、ユーザーに最後にプロンプトされたparamが含まれます。ユーザーの最新の返答がこのparamの値として設定されます。

    Delugeデータ型 利用可能範囲
    対応するparamのデータ型 Context Handlerファンクションのみ

    card

    cardは、ユーザーへの返答として視覚的にフォーマットされたメッセージを提供するために使用できます。cardは、テーブルや画像などの視覚要素のコレクションです。このキーの値は、mapオブジェクトのリストです。各mapオブジェクトは、card内のUI要素を表します。1つのcardには、同じ種類の複数の要素を含めることができます。card内のすべての要素は、返信メッセージ内で上から順に表示されます。

    Bold、Italic、Underline、Strikethrough、Link、およびHighlightなどのインラインフォーマットオプションは、card要素にも適用できます。したがって、上記のフォーマットオプションのいずれかを、以下のcardのテキスト値で使用できます。

    ConvoKraftの返信メッセージcardでは、以下のUI要素がサポートされています:

    要素 フォーマット
    Note 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{
"type" : "note",
"content" : "&lt;Text content that needs to be displayed as a note.&gt;"

    }

    View more
    Title 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{
"type" : "title",
"content" : "&lt;Text content that needs to be displayed as the title&gt;"

    }

    View more
    List - Bullet & Numbered 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{ 
"type" : "list",
"format" : "bullet" or "numbered" 
"elements" : [
{
"label" : "&lt;element_label&gt;"
"preview" : {
"header" : {
"title" : "&lt;title_content&gt;"
"description" : "&lt;description_content&gt;",
"subheading" : "&lt;subheading_content&gt;",
"image" : {
"url" :"&lt;image_url&gt;"

    } }, “fields” :[ { “label” : “<field labels>” “value” : “<field values>” } //add other fields as necessary ] } } //add other elements as necessary ] }

    View more

    注意: list cardでは、previewオブジェクトに最大7つのフィールドを設定できます。
    Table 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{

    “type”: “table”, “heading” : “<Table Heading>”, “columns”: [ “<column1 header>”. “<column2 header>” “<column3 header>” ], “rows”: [ [ “<value al>” “<value a2>” “<value a3>” ], [ “<value b1>” “<value b2>” “<value b3>” ] ] }

    View more
    Image 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{

    “type” : “image”, “content” : “<image url>” }

    View more
    File 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{

    “type” : “file”, “name” : “<file_name>”, “format” : “pdf”, //file extension “content”: “<file url>” }

    View more
    Contact card 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{

    “type” : “vcard”, “info” : { “image” : “”, “fields” : [ { “First Name” : “Smith” }. { “Last Name” : “Gibbs” }, { “Company”: “ABC Corp” }, { “Website” : “https://” } ] } }

    View more
    Link 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{

    “type” : “label”, “content” : “<URL link>” }

    View more
    Button 
        <div class="code-block-toolkit">
        <div class="copytoclipboard" onclick="copyToClipboard(this)">copy</div>
        <div class="theme-btn" onclick="codeblockThemeChange(this)">
            <div class="theme-icon"></div>
        </div>
    </div>
</div>
<div id="codeBlockHeightAdjust" class="code-block-body fadecontent" onclick="codeBlockHeightAdjust(this)">
     <pre ><code>{

    “type” : “button”, “label” : “<button label>”. “theme” : “<button theme>” “id” : “<button id>”, “onclick” : { “execute” : “function (or)clienthook”, “function”:"<button click function name>", “data” : {} } }

    View more

    1. themeキーの値は、positive、negative、またはneutralのいずれかを指定できます。
    2. executeキーの値は、以下のいずれかを指定できます:

    • function - 定義されたButton Clickファンクションを実行します。

    • clienthook - クライアントアプリケーションが実装したhookを実行します。

      clienthookがexecuteキーの値として設定されている場合、functionキーは不要です。

    1. dataキーには、Button Clickファンクションに渡す必要のある値を設定します。
    注意: button cardを使用して、1つのActionに最大3つのボタンを設定できます。

    最終更新日 2026-03-30 13:40:30 +0530 IST

    前へ

    次へ

    このページについて