Referencia de objetos Deluge

# Referencia de objetos Deluge

La documentación de referencia de objetos Deluge tiene como objetivo dar una idea detallada sobre los diversos elementos de las Deluge functions en ConvoKraft. Los objetos principales soportados por ConvoKraft incluyen los objetos de acceso a datos, objetos de entrada y objetos de respuesta. Discutiremos cada uno de ellos en detalle en esta sección.

# Objetos de acceso a datos

### sessionData

Los detalles sobre la sesión de chat actual del cliente. Estos datos estarán disponibles para todas las funciones bajo el argumento {{%badge%}}sessionData{{%/badge%}}.

<table class="content-table">
        <thead>
            <tr>
                <th>Tipo de dato Deluge</th>
                <th>Disponibilidad</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>{{%badge%}}Map{{%/badge%}}</td>
                <td>En todas las funciones</td>
            </tr>
            </tbody>
</table>

Este argumento comprende las siguientes claves:

<table class="content-table">
        <thead>
            <tr>
                <th>Nombre de la clave</th>
                <th>Tipo de dato Deluge</th>
                <th>Descripción</th>
                <th>Valor de ejemplo</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>{{%badge%}}medium{{%/badge%}}</td>
                <td>Text</td>
                <td>El modo de comunicación a través del cual el usuario interactúa con el bot. Los valores posibles son {{%badge%}}call{{%/badge%}} o {{%badge%}}chat{{%/badge%}}. </td>
                <td>chat</td>
            </tr>
            <tr>
                <td>{{%badge%}}client_host{{%/badge%}}</td>
                <td>Text</td>
                <td>La naturaleza de la aplicación cliente que aloja el bot. Los valores posibles son {{%badge%}}mobile{{%/badge%}} o {{%badge%}}web{{%/badge%}}.</td>
                <td>web</td>
            </tr>
            <tr>
                <td>{{%badge%}}client_identifier{{%/badge%}}</td>
                <td>Text</td>
                <td>El identificador único del cliente.
                <br>
                La URL de la aplicación web, si {{%badge%}}client_identifier{{%/badge%}} es {{%badge%}}web{{%/badge%}}.
                <br>
                El nombre del paquete o identificador del bundle de la aplicación móvil, si {{%badge%}}client_identifier{{%/badge%}} es {{%badge%}}mobile{{%/badge%}}.
                </td>
                <td>https://zylker.com</td>
            </tr>
            <tr>
                <td>{{%badge%}}client_data{{%/badge%}}</td>
                <td>Map</td>
                <td>Los datos pasados desde el cliente a ConvoKraft al inicio de la sesión.</td>
                <td>{
                    "user_email":
                    "todd@hmail.com"
                    }</td>
            </tr>
            </tbody>
</table>

### cache

El objeto {{%badge%}}cache{{%/badge%}} actúa como una variable de almacenamiento temporal. Cualquier dato almacenado en este objeto en forma de par clave-valor será accesible a través de todas las funciones de la acción en ejecución actual hasta que esa ejecución de acción se complete.

### broadcast

Si quieres que tu bot recuerde cualquier información relacionada con la acción en ejecución actual, la información puede almacenarse en el objeto {{%badge%}}broadcast{{%/badge%}}. Este valor se retendrá incluso después de la ejecución de la acción actual, y estará disponible para todas las acciones subsiguientes hasta que la sesión de chat actual termine. Las acciones subsiguientes pueden usar este valor, según lo requiera la lógica de negocio.

#### messageData

El objeto {{%badge%}}messageData{{%/badge%}} contiene el mensaje personalizado enviado por el cliente para cada solicitud de transcript (un mensaje en la conversación del bot) en la clave {{%badge%}}data{{%/badge%}}.

# Objetos de entrada

### param

Los valores de entrada proporcionados por el usuario para cada param estático serían capturados bajo los objetos con el mismo nombre de param a través de las Deluge functions.

<table class="content-table">
        <thead>
            <tr>
                <th>Tipo de dato Deluge</th>
                <th>Disponibilidad</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>Tipo de dato correspondiente al param</td>
                <td>En la Context handler function y la Action execution function</td>
            </tr>
            </tbody>
</table>

### previousParam

El objeto {{%badge%}}previousParam{{%/badge%}} contiene el param que fue solicitado por última vez al usuario. La última respuesta del usuario se establecerá como valor para este param.

<table class="content-table">
        <thead>
            <tr>
                <th>Tipo de dato Deluge</th>
                <th>Disponibilidad</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>Tipo de dato correspondiente al param</td>
                <td>Solo en la Context Handler function</td>
            </tr>
            </tbody>
</table>

# Objetos de respuesta

### card

La card puede usarse para dar un mensaje con formato visual como respuesta al usuario. Una card es una colección de elementos visuales, como tablas e imágenes. El valor de esta clave es una lista de objetos de mapa. Cada objeto de mapa representa un elemento de UI en la card. Una sola card puede contener más de un elemento del mismo tipo. Cada elemento en la card se mostrará uno debajo del otro en el {{%link href="/es/convokraft/help/actions/bot-logic/deluge-functions/execution-function/#message" %}}mensaje de respuesta{{%/link%}}.

Las opciones de formato en línea como {{%badge%}}Bold{{%/badge%}}, {{%badge%}}Italic{{%/badge%}}, {{%badge%}}Underline{{%/badge%}}, {{%badge%}}Strikethrough{{%/badge%}}, {{%badge%}}Link{{%/badge%}} y {{%badge%}}Highlight{{%/badge%}} también son aplicables a los elementos de la card. Por lo tanto, cualquiera de estas opciones de formato mencionadas anteriormente puede usarse en los valores de texto en cualquiera de las cards siguientes.

Los siguientes elementos de UI son soportados en la card de mensaje de respuesta de ConvoKraft:

<table class="content-table">
        <thead>
            <tr>
                <th class="w90p">Elemento</th>
                <th class="w70p">Formato</th>
            </tr>
        </thead>
        <tbody>
            <tr>
<td>{{%badge%}}Note{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{
    "type" : "note",
    "content" : "&lt;Text content that needs to be displayed as a note.&gt;"
}{{% /panel_with_adjustment %}}
</td>
            </tr>
            <tr>
 <td>{{%badge%}}Title{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{
    "type" : "title",
    "content" : "&lt;Text content that needs to be displayed as the title&gt;"
}{{% /panel_with_adjustment %}}</td>
            </tr>
            <tr>
<td>{{%badge%}}List - Bullet & Numbered{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{ 
    "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" : "&lt;field labels&gt;"
    "value" : "&lt;field values&gt;"
    } //add other fields as necessary
    ]
    }
    } //add other elements as necessary
    ]
}{{% /panel_with_adjustment %}}

{{%note%}}{{%bold%}}Nota: {{%/bold%}} En la card {{%badge%}}list{{%/badge%}}, se puede configurar un máximo de siete fields para un objeto {{%badge%}}preview{{%/badge%}}. {{%/note%}}
</td>
</tr>

<tr>
<td>{{%badge%}}Table{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{
"type": "table",
"heading" : "&lt;Table Heading&gt;",
"columns":
[
"&lt;column1 header&gt;".
"&lt;column2 header&gt;"
"&lt;column3 header&gt;"
], 
"rows":
[
[
"&lt;value al&gt;"
"&lt;value a2&gt;"
"&lt;value a3&gt;"
],
[
"&lt;value b1&gt;"
"&lt;value b2&gt;"
"&lt;value b3&gt;"
]
]
}
{{% /panel_with_adjustment %}}
</td>
</tr>

<td>{{%badge%}}Image{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{
"type" : "image",
"content" : "&lt;image url&gt;"
}{{% /panel_with_adjustment %}}
</td>
</tr>
<tr>
<td>{{%badge%}}File{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{
"type" : "file",
"name" : "&lt;file_name&gt;",
"format" : "pdf", //file extension
"content": "&lt;file url&gt;"
}{{% /panel_with_adjustment %}}
</td>
</tr>
<tr>
<td>{{%badge%}}Contact card{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{
"type" : "vcard",
"info" :
{
"image" : "<image url>",
"fields" :
[
{
"First Name" : "Smith"
}.
{
"Last Name" : "Gibbs"
},
{
"Company": "ABC Corp"
},
{
"Website" : "https://"
}
]
}
}
{{% /panel_with_adjustment %}}
</td>
</tr>
<tr>
<td>{{%badge%}}Link{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{
"type" : "label",
"content" : "&lt;URL link&gt;"
}
{{% /panel_with_adjustment %}}
</td>
</tr>
<tr>
<td>{{%badge%}}Button{{%/badge%}}</td>
<td>

{{% panel_with_adjustment header="" footer="button" %}}{
"type" : "button",
"label" : "&lt;button label&gt;".
"theme" : "&lt;button theme&gt;"
"id" : "&lt;button id&gt;",
"onclick" : 
{
"execute" : "function (or)clienthook",
"function":"&lt;button click function name&gt;",
"data" : {}
}
}
{{% /panel_with_adjustment %}}

1. Para la clave {{%badge%}}theme{{%/badge%}}, el valor puede ser {{%badge%}}positive{{%/badge%}}, {{%badge%}}negative{{%/badge%}} o {{%badge%}}neutral{{%/badge%}}.
2. Para la clave {{%badge%}}execute{{%/badge%}}, el valor puede ser cualquiera de los siguientes:
* {{%badge%}}function{{%/badge%}} - para ejecutar la Button Click function definida.
* {{%badge%}}clienthook{{%/badge%}} - para ejecutar el {{%link href="/es/convokraft/sdk/js/hooks/" %}}hook{{%/link%}} implementado por la aplicación cliente.

Si {{%badge%}}clienthook{{%/badge%}} se establece como valor de la clave {{%badge%}}execute{{%/badge%}}, entonces la clave {{%badge%}}function{{%/badge%}} no es requerida.
4. Para la clave {{%badge%}}data{{%/badge%}}, establece cualquier valor que necesite ser pasado a la button click function.
{{%note%}}{{%bold%}}Nota: {{%/bold%}} Se puede configurar un máximo de tres buttons para una acción usando la card {{%badge%}}button{{%/badge%}}.{{%/note%}}
</td>
</tr>
</tbody>
</table>

sessionData

Los detalles sobre la sesión de chat actual del cliente. Estos datos estarán disponibles para todas las funciones bajo el argumento sessionData.

Tipo de dato Deluge	Disponibilidad
Map	En todas las funciones

Este argumento comprende las siguientes claves:

Nombre de la clave	Tipo de dato Deluge	Descripción	Valor de ejemplo
medium	Text	El modo de comunicación a través del cual el usuario interactúa con el bot. Los valores posibles son call o chat.	chat
client_host	Text	La naturaleza de la aplicación cliente que aloja el bot. Los valores posibles son mobile o web.	web
client_identifier	Text	El identificador único del cliente. La URL de la aplicación web, si client_identifier es web. El nombre del paquete o identificador del bundle de la aplicación móvil, si client_identifier es mobile.	https://zylker.com
client_data	Map	Los datos pasados desde el cliente a ConvoKraft al inicio de la sesión.	{ "user_email": "todd@hmail.com" }

cache

El objeto cache actúa como una variable de almacenamiento temporal. Cualquier dato almacenado en este objeto en forma de par clave-valor será accesible a través de todas las funciones de la acción en ejecución actual hasta que esa ejecución de acción se complete.

Tipo de dato Deluge	Disponibilidad
Map	En todas las funciones

broadcast

Si quieres que tu bot recuerde cualquier información relacionada con la acción en ejecución actual, la información puede almacenarse en el objeto broadcast. Este valor se retendrá incluso después de la ejecución de la acción actual, y estará disponible para todas las acciones subsiguientes hasta que la sesión de chat actual termine. Las acciones subsiguientes pueden usar este valor, según lo requiera la lógica de negocio.

Tipo de dato Deluge	Disponibilidad
Map	En todas las funciones

messageData

El objeto messageData contiene el mensaje personalizado enviado por el cliente para cada solicitud de transcript (un mensaje en la conversación del bot) en la clave data.

Tipo de dato Deluge	Disponibilidad
Map	En todas las funciones

param

Los valores de entrada proporcionados por el usuario para cada param estático serían capturados bajo los objetos con el mismo nombre de param a través de las Deluge functions.

Tipo de dato Deluge	Disponibilidad
Tipo de dato correspondiente al param	En la Context handler function y la Action execution function

previousParam

El objeto previousParam contiene el param que fue solicitado por última vez al usuario. La última respuesta del usuario se establecerá como valor para este param.

Tipo de dato Deluge	Disponibilidad
Tipo de dato correspondiente al param	Solo en la Context Handler function

card

Las opciones de formato en línea como Bold, Italic, Underline, Strikethrough, Link y Highlight también son aplicables a los elementos de la card. Por lo tanto, cualquiera de estas opciones de formato mencionadas anteriormente puede usarse en los valores de texto en cualquiera de las cards siguientes.

Los siguientes elementos de UI son soportados en la card de mensaje de respuesta de ConvoKraft:

Elemento	Formato
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" : "<Text content that needs to be displayed as a note.>"` } 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" : "<Text content that needs to be displayed as the title>"` } 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" : "<element_label>" "preview" : { "header" : { "title" : "<title_content>" "description" : "<description_content>", "subheading" : "<subheading_content>", "image" : { "url" :"<image_url>" } }, “fields” :[ { “label” : “<field labels>” “value” : “<field values>” } //add other fields as necessary ] } } //add other elements as necessary ] } View more Nota: En la card list, se puede configurar un máximo de siete fields para un objeto preview.
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 Para la clave theme, el valor puede ser positive, negative o neutral. Para la clave execute, el valor puede ser cualquiera de los siguientes: function - para ejecutar la Button Click function definida. clienthook - para ejecutar el hook implementado por la aplicación cliente. Si clienthook se establece como valor de la clave execute, entonces la clave function no es requerida. Para la clave data, establece cualquier valor que necesite ser pasado a la button click function. Nota: Se puede configurar un máximo de tres buttons para una acción usando la card button.

Última actualización 2026-03-20 21:51:56 +0530 IST

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit