Referencia de API: Bot ConnectorAPI reference - Bot Connector

Nota

La API de REST no es equivalente al SDK.The REST API is not equivalent to the SDK. La API de REST se proporciona para permitir la comunicación de REST estándar; no obstante, el método preferido para interactuar con Bot Framework es el SDK.The REST API is provided to allow standard REST communication, however the preferred method of interacting with the Bot Framework is the SDK.

En Bot Framework, el servicio Bot Connector permite que el bot intercambie mensajes con los usuarios en los canales configurados en el portal de Bot Framework.Within the Bot Framework, the Bot Connector service enables your bot to exchange messages with users on channels that are configured in the Bot Framework Portal. El servicio usa los estándares del sector REST y JSON sobre HTTPS.The service uses industry-standard REST and JSON over HTTPS.

URI baseBase URI

Cuando un usuario envía un mensaje al bot, la solicitud entrante contiene un objeto Actividad con una propiedad serviceUrl que especifica el punto de conexión al que el bot debe enviar su respuesta.When a user sends a message to your bot, the incoming request contains an Activity object with a serviceUrl property that specifies the endpoint to which your bot should send its response. Para acceder al servicio Bot Connector, use el valor serviceUrl como el identificador URI de base para las solicitudes de API.To access the Bot Connector service, use the serviceUrl value as the base URI for API requests.

Por ejemplo, suponga que su bot recibe la siguiente actividad cuando el usuario envía un mensaje al bot.For example, assume that your bot receives the following activity when the user sends a message to the bot.

{
    "type": "message",
    "id": "bf3cc9a2f5de...",
    "timestamp": "2016-10-19T20:17:52.2891902Z",
    "serviceUrl": "https://smba.trafficmanager.net/apis",
    "channelId": "channel's name/id",
    "from": {
        "id": "1234abcd",
        "name": "user's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
    },
    "recipient": {
        "id": "12345678",
        "name": "bot's name"
    },
    "text": "Haircut on Saturday"
}

La propiedad serviceUrl del mensaje del usuario indica que el bot debe enviar su respuesta al punto de conexión https://smba.trafficmanager.net/apis; será el URI base para todas las solicitudes posteriores que el bot envíe en el contexto de esta conversación.The serviceUrl property within the user's message indicates that the bot should send its response to the endpoint https://smba.trafficmanager.net/apis; this will be the base URI for any subsequent requests that the bot issues in the context of this conversation. Si el bot necesita enviar un mensaje automático al usuario, asegúrese de guardar el valor de serviceUrl.If your bot will need to send a proactive message to the user, be sure to save the value of serviceUrl.

En el ejemplo siguiente se muestra la solicitud que el bot envía para responder al mensaje del usuario.The following example shows the request that the bot issues to respond to the user's message.

POST https://smba.trafficmanager.net/apis/v3/conversations/abcd1234/activities/bf3cc9a2f5de...
Authorization: Bearer eyJhbGciOiJIUzI1Ni...
Content-Type: application/json
{
    "type": "message",
    "from": {
        "id": "12345678",
        "name": "bot's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
    },
   "recipient": {
        "id": "1234abcd",
        "name": "user's name"
    },
    "text": "I have several times available on Saturday!",
    "replyToId": "bf3cc9a2f5de..."
}

encabezadosHeaders

Encabezados de solicitudRequest headers

Además de los encabezados de solicitud HTTP estándares, todas las solicitudes de API que envíe deben incluir un encabezado Authorization que especifique un token de acceso para autenticar el bot.In addition to the standard HTTP request headers, every API request that you issue must include an Authorization header that specifies an access token to authenticate your bot. Especifique el encabezado Authorization con este formato:Specify the Authorization header using this format:

Authorization: Bearer ACCESS_TOKEN

Para consultar información sobre cómo obtener un token de acceso para el bot, vea Authenticate requests from your bot to the Bot Connector service (Autenticación de solicitudes del bot en el servicio Bot Connector).For details about how to obtain an access token for your bot, see Authenticate requests from your bot to the Bot Connector service.

Encabezados de respuestaResponse headers

Además de los encabezados de respuesta HTTP estándares, cada respuesta contendrá un encabezado X-Correlating-OperationId.In addition to the standard HTTP response headers, every response will contain an X-Correlating-OperationId header. El valor de este encabezado es un identificador que corresponde a la entrada de registro de Bot Framework que contiene detalles acerca de la solicitud.The value of this header is an ID that corresponds to the Bot Framework log entry which contains details about the request. Siempre que reciba una respuesta de error, debe capturar el valor de este encabezado.Any time that you receive an error response, you should capture the value of this header. Si no puede resolver el problema de forma independiente, incluya este valor en la información que proporcione al equipo de soporte técnico al informar del problema.If you are not able to independently resolve the issue, include this value in the information that you provide to the Support team when you report the issue.

Códigos de estado HTTPHTTP status codes

El código de estado HTTP que se devuelve con cada respuesta indica el resultado de la solicitud correspondiente.The HTTP status code that is returned with each response indicates the outcome of the corresponding request.

Nota

En la tabla siguiente se describen los códigos de estado HTTP más comunes.The following table describes the most common HTTP status codes. El canal genera algunos errores.Some errors are generated by the channel. Para obtener más información, es posible que tenga que leer la documentación para desarrolladores del canal.For more information, you may need to read the channel's developer documentation.

Código de estado HTTPHTTP status code SignificadoMeaning
200200 La solicitud finalizó correctamente.The request succeeded.
201201 La solicitud finalizó correctamente.The request succeeded.
202202 La solicitud se aceptó para su procesamiento.The request was accepted for processing.
204204 La solicitud se realizó correctamente, pero no se devolvió ningún contenido.The request succeeded but no content was returned.
400400 La solicitud tenía formato incorrecto o era incorrecta por otro motivo.The request was malformed or otherwise incorrect.
401401 El bot aún no está autenticado.The bot is not yet authenticated.
403403 El bot no está autorizado para realizar la operación solicitada.The bot is not authorized to perform the requested operation.
404404 No se encontró el recurso solicitado.The requested resource was not found.
405405 Este canal no admite la operación solicitada.The channel does not support the requested operation.
500500 Se ha producido un error del servidor interno.An internal server error occurred.
503503 El servicio no está disponible temporalmente.The service is temporarily unavailable.

ErrorsErrors

Cualquier respuesta que especifique un código de estado HTTP en el rango de 4xx o 5xx incluirá un objeto ErrorResponse en el cuerpo de la respuesta que proporciona información sobre el error.Any response that specifies an HTTP status code in the 4xx range or 5xx range will include an ErrorResponse object in the body of the response that provides information about the error. Si recibe una respuesta de error en el rango de 4xx, inspeccione el objeto ErrorResponse para identificar la causa del error y resolver el problema antes de volver a enviar la solicitud.If you receive an error response in the 4xx range, inspect the ErrorResponse object to identify the cause of the error and resolve your issue prior to resubmitting the request.

Operaciones con conversacionesConversation operations

Use estas operaciones para crear conversaciones, enviar mensajes (actividades) y administrar el contenido de las conversaciones.Use these operations to create conversations, send messages (activities), and manage the contents of conversations.

OperaciónOperation DescripciónDescription
Crear conversaciónCreate Conversation Crea una conversación.Creates a new conversation.
Eliminar actividadDelete Activity Elimina una actividad existente.Deletes an existing activity.
Eliminar miembro de la conversaciónDelete Conversation Member Quita un miembro de una conversación.Removes a member from a conversation.
Obtener miembros de la actividadGet Activity Members Obtiene los miembros de la actividad especificada dentro de la conversación especificada.Gets the members of the specified activity within the specified conversation.
Obtener miembro de la conversaciónGet Conversation Member Obtiene detalles sobre un miembro de una conversación.Gets details about a member of a conversation.
Obtener miembros de la conversaciónGet Conversation Members Obtiene los miembros de la conversación especificada.Gets the members of the specified conversation.
Obtener los miembros de la conversación paginadosGet Conversation Paged Members Obtiene los miembros de la conversación especificada una página a la vez.Gets the members of the specified conversation one page at a time.
Obtener conversacionesGet Conversations Obtiene una lista de las conversaciones en las que ha participado el bot.Gets a list of conversations the bot has participated in.
Responder a actividadReply to Activity Envía una actividad (mensaje) a la conversación especificada, como una respuesta a la actividad especificada.Sends an activity (message) to the specified conversation, as a reply to the specified activity.
Enviar historial de la conversaciónSend Conversation History Carga una transcripción de actividades pasadas a la conversación.Uploads a transcript of past activities to the conversation.
Enviar a conversaciónSend to Conversation Envía una actividad (mensaje) al final de la conversación especificada.Sends an activity (message) to the end of the specified conversation.
Actualizar actividadUpdate Activity Actualiza una actividad existente.Updates an existing activity.
Cargar datos adjuntos al canalUpload Attachment to Channel Carga un archivo adjunto directamente al almacenamiento de blobs de un canal.Uploads an attachment directly into a channel's blob storage.

Crear conversaciónCreate Conversation

Crea una conversación.Creates a new conversation.

POST /v3/conversations
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body Un objeto ConversationParametersA ConversationParameters object
DevuelveReturns Un objeto ConversationResourceResponseA ConversationResourceResponse object

Eliminar actividadDelete Activity

Algunos canales le permiten eliminar una actividad existente.Some channels allow you to delete an existing activity. Si se realiza correctamente, esta operación elimina la actividad especificada de la conversación establecida.If successful, this operation removes the specified activity from the specified conversation.

DELETE /v3/conversations/{conversationId}/activities/{activityId}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Un código de estado HTTP que indica el resultado de la operación.An HTTP Status code that indicates the outcome of the operation. No se especifica nada en el cuerpo de la respuesta.Nothing is specified in the body of the response.

Eliminar miembro de la conversaciónDelete Conversation Member

Quita un miembro de una conversación.Removes a member from a conversation. Si ese miembro era el último miembro de la conversación, también se eliminará la conversación.If that member was the last member of the conversation, the conversation will also be deleted.

DELETE /v3/conversations/{conversationId}/members/{memberId}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Un código de estado HTTP que indica el resultado de la operación.An HTTP Status code that indicates the outcome of the operation. No se especifica nada en el cuerpo de la respuesta.Nothing is specified in the body of the response.

Obtener miembros de la actividadGet Activity Members

Obtiene los miembros de la actividad especificada dentro de la conversación especificada.Gets the members of the specified activity within the specified conversation.

GET /v3/conversations/{conversationId}/activities/{activityId}/members
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Una matriz de objetos ChannelAccountAn array of ChannelAccount objects

Obtener conversacionesGet Conversations

Obtiene una lista de las conversaciones en las que ha participado el bot.Gets a list of conversations the bot has participated in.

GET /v3/conversations?continuationToken={continuationToken}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Un objeto ConversationsResultA ConversationsResult object

Obtener miembro de la conversaciónGet Conversation Member

Obtiene detalles sobre un miembro específico de una determinada conversación.Gets details about a specific member of a specific conversation.

GET /v3/conversations/{conversationId}/members/{memberId}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Objeto ChannelAccount para el miembro.A ChannelAccount object for the member.

Obtener miembros de la conversaciónGet Conversation Members

Obtiene los miembros de la conversación especificada.Gets the members of the specified conversation.

GET /v3/conversations/{conversationId}/members
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Matriz de objetos ChannelAccount de los miembros de la conversación.An array of ChannelAccount objects for the members of the conversation.

Obtener los miembros de la conversación paginadosGet Conversation Paged Members

Obtiene los miembros de la conversación especificada una página a la vez.Gets the members of the specified conversation one page at a time.

GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={continuationToken}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Un objeto PagedMembersResultA PagedMembersResult object

Responder a actividadReply to Activity

Envía una actividad (mensaje) a la conversación especificada, como una respuesta a la actividad especificada.Sends an activity (message) to the specified conversation, as a reply to the specified activity. La actividad se agregará como respuesta a otra actividad, si lo admite el canal.The activity will be added as a reply to another activity, if the channel supports it. Si el canal no admite respuestas anidadas, esta operación se comporta como Enviar a conversación.If the channel does not support nested replies, then this operation behaves like Send to Conversation.

POST /v3/conversations/{conversationId}/activities/{activityId}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body Un objeto ActivityAn Activity object
DevuelveReturns Un objeto ResourceResponseA ResourceResponse object

Enviar historial de la conversaciónSend Conversation History

Carga una transcripción de actividades pasadas a la conversación para que el cliente pueda representarlas.Uploads a transcript of past activities to the conversation so that the client can render them.

POST /v3/conversations/{conversationId}/activities/history
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body Un objeto Transcript.A Transcript object.
DevuelveReturns Un objeto ResourceResponse.A ResourceResponse object.

Enviar a conversaciónSend to Conversation

Envía una actividad (mensaje) a la conversación especificada.Sends an activity (message) to the specified conversation. La actividad se anexará al final de la conversación según la marca de tiempo o la semántica del canal.The activity will be appended to the end of the conversation according to the timestamp or semantics of the channel. Para responder a un mensaje específico dentro de la conversación, en su lugar, use Responder a actividad.To reply to a specific message within the conversation, use Reply to Activity instead.

POST /v3/conversations/{conversationId}/activities
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body Un objeto ActivityAn Activity object
DevuelveReturns Un objeto ResourceResponseA ResourceResponse object

Actualizar actividadUpdate Activity

Algunos canales le permiten modificar una actividad existente para reflejar el nuevo estado de una conversación de bot.Some channels allow you to edit an existing activity to reflect the new state of a bot conversation. Por ejemplo, puede quitar los botones de un mensaje de la conversación después de que el usuario haya hecho clic en uno de los botones.For example, you might remove buttons from a message in the conversation after the user has clicked one of the buttons. Si se realiza correctamente, esta operación actualiza la actividad especificada dentro de la conversación establecida.If successful, this operation updates the specified activity within the specified conversation.

PUT /v3/conversations/{conversationId}/activities/{activityId}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body Un objeto ActivityAn Activity object
DevuelveReturns Un objeto ResourceResponseA ResourceResponse object

Cargar datos adjuntos al canalUpload Attachment to Channel

Carga un archivo adjunto para la conversación especificada directamente en el almacenamiento de blobs de un canal.Uploads an attachment for the specified conversation directly into a channel's blob storage. Esto le permite almacenar datos en un almacén compatible.This enables you to store data in a compliant store.

POST /v3/conversations/{conversationId}/attachments
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body Un objeto AttachmentData.An AttachmentData object.
DevuelveReturns Un objeto ResourceResponse.A ResourceResponse object. La propiedad id especifica el identificador de datos adjuntos que se puede usar con las operaciones Obtener información de datos adjuntos y Obtener datos adjuntos.The id property specifies the attachment ID that can be used with the Get Attachment Info operation and the Get Attachment operation.

Operaciones con datos adjuntosAttachment operations

Utilice estas operaciones para recuperar información sobre los datos adjuntos y los datos binarios para el propio archivo.Use these operations to retrieve information about an attachment as well the binary data for the file itself.

OperaciónOperation DescripciónDescription
Obtener información de datos adjuntosGet Attachment Info Obtiene información sobre los datos adjuntos especificados, incluido el nombre de archivo, el tipo de archivo y las vistas disponibles (p. ej., original o miniatura).Gets information about the specified attachment, including file name, file type, and the available views (e.g. original or thumbnail).
Obtener datos adjuntosGet Attachment Obtiene la vista especificada de los datos adjuntos determinados como contenido binario.Gets the specified view of the specified attachment as binary content.

Obtener información de datos adjuntosGet Attachment Info

Obtiene información sobre los datos adjuntos especificados, incluido el nombre de archivo, el tipo y las vistas disponibles (p. ej., original o miniatura).Gets information about the specified attachment, including file name, type, and the available views (e.g. original or thumbnail).

GET /v3/attachments/{attachmentId}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Un objeto AttachmentInfoAn AttachmentInfo object

Obtener datos adjuntosGet Attachment

Obtiene la vista especificada de los datos adjuntos determinados como contenido binario.Gets the specified view of the specified attachment as binary content.

GET /v3/attachments/{attachmentId}/views/{viewId}
ContenidoContent DescriptionDescription
Cuerpo de la solicitudRequest body N/Dn/a
DevuelveReturns Contenido binario que representa la vista especificada de los datos adjuntos establecidosBinary content that represents the specified view of the specified attachment

Operaciones de estado (en desuso)State operations (deprecated)

El servicio de estado de Microsoft bot Framework se retirará a partir del 30 de marzo de 2018.The Microsoft Bot Framework State service is retired as of March 30, 2018. Anteriormente, los bots creados en Azure Bot Service o en el SDK Bot Builder tenían una conexión predeterminada con este servicio hospedado por Microsoft para almacenar los datos de estado del bot.Previously, bots built on the Azure Bot Service or the Bot Builder SDK had a default connection to this service hosted by Microsoft to store bot state data. Los bots se deberán actualizar para usar su propio almacenamiento del estado.Bots will need to be updated to use their own state storage.

OperaciónOperation DescripciónDescription
Set User Data Almacena datos de estado de un usuario específico en un canal.Stores state data for a specific user on a channel.
Set Conversation Data Almacena datos de estado de una conversación específica en un canal.Stores state data for a specific conversation on a channel.
Set Private Conversation Data Almacena datos de estado de un usuario específico en el contexto de una conversación determinada en un canal.Stores state data for a specific user within the context of a specific conversation on a channel.
Get User Data Recupera datos de estado que previamente se almacenaron para un usuario específico de todas las conversaciones en un canal.Retrieves state data that has previously been stored for a specific user across all conversations on a channel.
Get Conversation Data Recupera datos de estado que previamente se almacenaron para una conversación específica en un canal.Retrieves state data that has previously been stored for a specific conversation on a channel.
Get Private Conversation Data Recupera datos de estado que previamente se almacenaron para un usuario específico en el contexto de una conversación determinada en un canal.Retrieves state data that has previously been stored for a specific user within the context of a specific conversation on a channel.
Delete State For User Elimina los datos de estado que se han almacenado previamente para un usuario.Deletes state data that has previously been stored for a user.

SchemaSchema

El esquema de Bot Framework define los objetos y las propiedades que puede usar el bot para comunicarse con un usuario.The Bot Framework schema defines the objects and their properties that your bot can use to communicate with a user.

ObjectObject DescripciónDescription
Objeto ActivityActivity object Define un mensaje que se intercambia entre el bot y el usuario.Defines a message that is exchanged between bot and user.
Objeto AnimationCardAnimationCard object Define una tarjeta que puede reproducir archivos GIF animados o vídeos cortos.Defines a card that can play animated GIFs or short videos.
Objeto AttachmentAttachment object Define información adicional que se va a incluir en el mensaje.Defines additional information to include in the message. Los datos adjuntos pueden ser un archivo multimedia (por ejemplo, audio, vídeo, imagen o archivo) o una tarjeta enriquecida.An attachment may be a media file (e.g. audio, video, image, file) or a rich card.
Objeto AttachmentDataAttachmentData object Describe los datos adjuntos.Describes an attachment data.
Objeto AttachmentInfoAttachmentInfo object Describe los datos adjuntos.Describes an attachment.
Objeto AttachmentViewAttachmentView object Define una vista de datos adjuntos.Defines a attachment view.
Objeto AudioCardAudioCard object Define una tarjeta que puede reproducir un archivo de audio.Defines a card that can play an audio file.
Objeto CardActionCardAction object Define una acción que se va a realizar.Defines an action to perform.
Objeto CardImageCardImage object Define una imagen para mostrarla en una tarjeta.Defines an image to display on a card.
Objeto ChannelAccountChannelAccount object Define un bot o cuenta de usuario en el canal.Defines a bot or user account on the channel.
Objeto ConversationAccountConversationAccount object Define una conversación en un canal.Defines a conversation in a channel.
Objeto ConversationMembersConversationMembers object Define los miembros de una conversación.Defines the members of a conversation.
Objeto ConversationParametersConversationParameters object Define los parámetros para crear una conversación.Define parameters for creating a new conversation
Objeto ConversationReferenceConversationReference object Define un punto concreto de una conversación.Defines a particular point in a conversation.
Objeto ConversationResourceResponseConversationResourceResponse object Define una respuesta para Crear conversación.Defines a response to Create Conversation.
Objeto ConversationsResultConversationsResult object Define el resultado de una llamada a Obtener conversaciones.Defines the result of a call to Get Conversations.
Objeto EntityEntity object Define un objeto entidad.Defines an entity object.
Objeto ErrorError object Define un error.Defines an error.
Objeto ErrorResponseErrorResponse object Define una respuesta de la API HTTP.Defines an HTTP API response.
Objeto FactFact object Define un par clave-valor que contiene un hecho.Defines a key-value pair that contains a fact.
Objeto GeocoordinatesGeoCoordinates object Define una ubicación geográfica mediante las coordenadas del sistema geodésico mundial (WSG84).Defines a geographical location using World Geodetic System (WSG84) coordinates.
Objeto HeroCardHeroCard object Define una tarjeta con una imagen grande, título, texto y botones de acción.Defines a card with a large image, title, text, and action buttons.
Objeto InnerHttpErrorInnerHttpError object Objeto que representa un error HTTP interno.Object representing an inner HTTP error.
Objeto MediaEventValueMediaEventValue object Parámetros complementarios para eventos multimedia.Supplementary parameter for media events.
Objeto MediaUrlMediaUrl object Define la dirección URL al origen de un archivo multimedia.Defines the URL to a media file's source.
Objeto MentionMention object Define un usuario o un bot que se mencionó en la conversación.Defines a user or bot that was mentioned in the conversation.
Objeto MessageReactionMessageReaction object Define una reacción a un mensaje.Defines a reaction to a message.
Objeto PagedMembersResultPagedMembersResult object Página de miembros que devuelve la operación Obtener los miembros de la conversación paginados.Page of members returned by Get Conversation Paged Members.
Objeto PlacePlace object Define un lugar mencionado en la conversación.Defines a place that was mentioned in the conversation.
Objeto ReceiptCardReceiptCard object Define una tarjeta que contiene una recepción de una compra.Defines a card that contains a receipt for a purchase.
Objeto ReceiptItemReceiptItem object Define un elemento de línea dentro de una confirmación.Defines a line item within a receipt.
Objeto ResourceResponseResourceResponse object Define un recurso.Defines a resource.
Objeto SemanticActionSemanticAction object Define una referencia a una acción mediante programación.Defines a reference to a programmatic action.
Objeto SignInCardSignInCard object Define una tarjeta que permite a un usuario iniciar sesión en un servicio.Defines a card that lets a user sign in to a service.
Objeto SuggestedActionsSuggestedActions object Define las opciones que puede elegir un usuario.Defines the options from which a user can choose.
Objeto TextHighlightTextHighlight object Hace referencia a una subcadena de contenido dentro de otro campo.Refers to a substring of content within another field.
Objeto ThumbnailCardThumbnailCard object Define una tarjeta con una imagen en miniatura, título, texto y botones de acción.Defines a card with a thumbnail image, title, text, and action buttons.
Objeto ThumbnailUrlThumbnailUrl object Define la dirección URL al origen de una imagen.Defines the URL to an image's source.
Objeto TranscriptTranscript object Una colección de actividades que se cargará mediante Enviar historial de la conversación.A collection of activities to be uploaded using Send Conversation History.
Objeto VideoCardVideoCard object Define una tarjeta que puede reproducir vídeos.Defines a card that can play videos.

Objeto ActivityActivity object

Define un mensaje que se intercambia entre el bot y el usuario.Defines a message that is exchanged between bot and user.

PropiedadProperty TipoType DescripciónDescription
actionaction stringstring La acción que se va a aplicar o que se aplicó.The action to apply or that was applied. Use la propiedad type para determinar el contexto de la acción.Use the type property to determine context for the action. Por ejemplo, si type es contactRelationUpdate, el valor de la propiedad action sería add si el usuario agregó el bot a su lista de contactos, o remove si quitó el bot de su lista de contactos.For example, if type is contactRelationUpdate, the value of the action property would be add if the user added your bot to their contacts list, or remove if they removed your bot from their contacts list.
attachmentLayoutattachmentLayout stringstring Diseño de los datos adjuntos de la tarjeta enriquecida que el mensaje incluye.Layout of the rich card attachments that the message includes. Uno de estos valores: carousel, list.One of these values: carousel, list. Para más información sobre los datos adjuntos de tarjetas enriquecidas, vea Incorporación de datos adjuntos de tarjetas enriquecidas a mensajes.For more information about rich card attachments, see Add rich card attachments to messages.
attachmentsattachments Attachment[]Attachment[] Matriz de objetos Attachment que define información adicional que se va a incluir en el mensaje.Array of Attachment objects that defines additional information to include in the message. Cada dato adjunto puede ser un archivo (por ejemplo, audio, vídeo o imagen) o una tarjeta enriquecida.Each attachment may be either a file (e.g. audio, video, image) or a rich card.
callerIdcallerId stringstring Una cadena que contiene un IRI que identifica al autor de la llamada de un bot.A string containing an IRI identifying the caller of a bot. Este campo no está pensado para transmitirse a través de la conexión, sino que los bots y los clientes lo rellenan basándose en datos comprobables criptográficamente que confirman la identidad de los autores de las llamadas (por ejemplo, tokens).This field is not intended to be transmitted over the wire, but is instead populated by bots and clients based on cryptographically verifiable data that asserts the identity of the callers (e.g. tokens).
channelDatachannelData objectobject Objeto que incluye contenido específico de canal.An object that contains channel-specific content. Algunos canales proporcionan características que requieren información adicional que no se puede representar mediante el esquema de datos adjuntos.Some channels provide features that require additional information that cannot be represented using the attachment schema. Para esos casos, establezca esta propiedad en el contenido específico de canal tal como se define en la documentación del canal.For those cases, set this property to the channel-specific content as defined in the channel's documentation. Para más información, vea Implementación de una funcionalidad específica de canal.For more information, see Implement channel-specific functionality.
channelIdchannelId stringstring Identificador que distingue de manera única el canal.An ID that uniquely identifies the channel. Se establece mediante el canal.Set by the channel.
codecode stringstring Código que indica por qué la conversación ha finalizado.Code indicating why the conversation has ended.
conversationconversation ConversationAccountConversationAccount Un objeto ConversationAccount que define la conversación a la que pertenece la actividad.A ConversationAccount object that defines the conversation to which the activity belongs.
deliveryModedeliveryMode stringstring Una sugerencia de entrega para indicar al destinatario rutas de entrega alternativas para la actividad.A delivery hint to signal to the recipient alternate delivery paths for the activity. Uno de estos valores: normal, notification (notificación).One of these values: normal, notification.
entitiesentities object[]object[] Matriz de objetos que representa las entidades que se han mencionado en el mensaje.Array of objects that represents the entities that were mentioned in the message. Los objetos de esta matriz pueden ser cualquier objeto Schema.org.Objects in this array may be any Schema.org object. Por ejemplo, la matriz puede incluir objetos Mention que identifican a alguien a quien se ha mencionado en la conversación y objetos Place que identifican un lugar mencionado en la conversación.For example, the array may include Mention objects that identify someone who was mentioned in the conversation and Place objects that identify a place that was mentioned in the conversation.
expirationexpiration stringstring La hora en que la actividad debería considerarse "expirada" y no debería presentarse al destinatario.The time at which the activity should be considered to be "expired" and should not be presented to the recipient.
fromfrom ChannelAccountChannelAccount Un objeto ChannelAccount que especifica el remitente del mensaje.A ChannelAccount object that specifies the sender of the message.
historyDisclosedhistoryDisclosed booleanboolean Marca que indica si se revela o no el historial.Flag that indicates whether or not history is disclosed. El valor predeterminado es false.Default value is false.
idid stringstring Identificador que distingue de manera única la actividad en el canal.ID that uniquely identifies the activity on the channel.
importanceimportance stringstring Define la importancia de una actividad.Defines the importance of an Activity. Uno de estos valores: low (baja), normal, high (alta).One of these values: low, normal, high.
inputHintinputHint stringstring Valor que indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se haya entregado al cliente.Value that indicates whether your bot is accepting, expecting, or ignoring user input after the message is delivered to the client. Uno de estos valores: acceptingInput, expectingInput, ignoringInput.One of these values: acceptingInput, expectingInput, ignoringInput.
labellabel stringstring Una etiqueta descriptiva para la actividad.A descriptive label for the activity.
listenForlistenFor string[]string[] Lista de frases y referencias que deben escuchar los sistemas de preparación para la voz y el idioma.List of phrases and references that speech and language priming systems should listen for.
localelocale stringstring Configuración regional del idioma que se debe usar para mostrar el texto del mensaje, en el formato <language>-<country>.Locale of the language that should be used to display text within the message, in the format <language>-<country>. El canal utiliza esta propiedad para indicar el idioma del usuario, para que su bot pueda especificar las cadenas para mostrar en ese idioma.The channel uses this property to indicate the user's language, so that your bot may specify display strings in that language. El valor predeterminado es en-US.Default value is en-US.
localTimestamplocalTimestamp stringstring Fecha y hora en que se envió el mensaje en la zona horaria local, expresada en el formato ISO-8601.Date and time that the message was sent in the local time zone, expressed in ISO-8601 format.
localTimezonelocalTimezone stringstring Contiene el nombre de la zona horaria local del mensaje, expresado en el formato de base de datos de zona horaria de IANA.Contains the name of the local timezone of the message, expressed in IANA Time Zone database format. Por ejemplo, America/Los_Angeles.For example, America/Los_Angeles.
membersAddedmembersAdded ChannelAccount[]ChannelAccount[] Matriz de objetos ChannelAccount que representa la lista de usuarios que se unieron a la conversación.Array of ChannelAccount objects that represents the list of users that joined the conversation. Presente solo si la actividad type es "conversationUpdate" y si los usuarios se unieron a la conversación.Present only if activity type is "conversationUpdate" and users joined the conversation.
membersRemovedmembersRemoved ChannelAccount[]ChannelAccount[] Matriz de objetos ChannelAccount que representa la lista de usuarios que abandonaron la conversación.Array of ChannelAccount objects that represents the list of users that left the conversation. Presente solo si la actividad type es "conversationUpdate" y si los usuarios abandonaron la conversación.Present only if activity type is "conversationUpdate" and users left the conversation.
namename stringstring Nombre de la operación para invocar o el nombre del evento.Name of the operation to invoke or the name of the event.
reactionsAddedreactionsAdded MessageReaction[]MessageReaction[] Colección de reacciones agregada a la conversación.The collection of reactions added to the conversation.
reactionsRemovedreactionsRemoved MessageReaction[]MessageReaction[] Colección de reacciones eliminada de la conversación.The collection of reactions removed from the conversation.
recipientrecipient ChannelAccountChannelAccount Un objeto ChannelAccount que especifica el destinatario del mensaje.A ChannelAccount object that specifies the recipient of the message.
relatesTorelatesTo ConversationReferenceConversationReference Un objeto ConversationReference que define un punto concreto en una conversación.A ConversationReference object that defines a particular point in a conversation.
replyToIdreplyToId stringstring Identificador del mensaje al que responde este mensaje.The ID of the message to which this message replies. Para responder a un mensaje que el usuario envía, establezca esta propiedad con el identificador del mensaje del usuario.To reply to a message that the user sent, set this property to the ID of the user's message. No todos los canales admiten respuestas encadenadas.Not all channels support threaded replies. En estos casos, el canal ignorará esta propiedad y usará la semántica ordenada por tiempo (marca de tiempo) para anexar el mensaje a la conversación.In these cases, the channel will ignore this property and use time ordered semantics (timestamp) to append the message to the conversation.
semanticActionsemanticAction SemanticActionSemanticAction Un objeto SemanticAction que representa una referencia a una acción mediante programación.A SemanticAction object that represents a reference to a programmatic action.
serviceUrlserviceUrl stringstring Dirección URL que especifica el punto de conexión de servicio del canal.URL that specifies the channel's service endpoint. Se establece mediante el canal.Set by the channel.
speakspeak stringstring Texto que pronuncia el bot en un canal habilitado para voz.Text to be spoken by your bot on a speech-enabled channel. Para controlar diversas características de voz del bot como voz, velocidad, volumen, pronunciación y tono, especifique esta propiedad con el formato de lenguaje de marcado de síntesis de voz (SSML).To control various characteristics of your bot's speech such as voice, rate, volume, pronunciation, and pitch, specify this property in Speech Synthesis Markup Language (SSML) format.
suggestedActionssuggestedActions SuggestedActionsSuggestedActions Un objeto SuggestedActions que define las opciones entre las que el usuario puede elegir.A SuggestedActions object that defines the options from which the user can choose.
summarysummary stringstring Resumen de la información que contiene el mensaje.Summary of the information that the message contains. Por ejemplo, en un mensaje que se envía en un canal de correo electrónico, esta propiedad puede especificar los 50 primeros caracteres del mensaje de correo electrónico.For example, for a message that is sent on an email channel, this property may specify the first 50 characters of the email message.
texttext stringstring Texto del mensaje que se envía del usuario al bot o del bot al usuario.Text of the message that is sent from user to bot or bot to user. Consulte la documentación del canal para conocer los límites impuestos en el contenido de esta propiedad.See the channel's documentation for limits imposed upon the contents of this property.
textFormattextFormat stringstring Formato del texto del mensaje.Format of the message's text. Uno de estos valores: markdown, plain, xml.One of these values: markdown, plain, xml. Para más información sobre el formato del texto, vea Creación de mensajes.For details about text format, see Create messages.
textHighlightstextHighlights TextHighlight[]TextHighlight[] Colección de fragmentos de texto que se resaltará si la actividad contiene un valor replyToId.The collection of text fragments to highlight when the activity contains a replyToId value.
timestamptimestamp stringstring Fecha y hora en que se envió el mensaje en la zona horaria UTC, expresada en el formato ISO-8601.Date and time that the message was sent in the UTC time zone, expressed in ISO-8601 format.
topicNametopicName stringstring Tema de la conversación a la que pertenece la actividad.Topic of the conversation to which the activity belongs.
typetype stringstring Tipo de actividad.Type of activity. Uno de estos valores: message, contactRelationUpdate, conversationUpdate, typing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff.One of these values: message, contactRelationUpdate, conversationUpdate, typing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff. Para obtener detalles sobre los tipos de actividad, vea Introducción a las actividades.For details about activity types, see Activities overview.
valuevalue objectobject Valor de final abierto.Open-ended value.
valueTypevalueType stringstring Tipo del objeto de valor de la actividad.The type of the activity's value object.

Volver a la tabla de esquemaBack to Schema table

Objeto AnimationCardAnimationCard object

Define una tarjeta que puede reproducir archivos GIF animados o vídeos cortos.Defines a card that can play animated GIFs or short videos.

PropiedadProperty TipoType DescripciónDescription
aspectaspect booleanboolean Relación de aspecto del marcador de miniatura o medio.Aspect ratio of thumbnail/media placeholder. Los valores permitidos son "16:9" y "4:3".Allowed values are "16:9" and "4:3".
autoloopautoloop booleanboolean Marca que indica si se debe reproducir la lista de archivos GIF animados cuando finaliza la última.Flag that indicates whether to replay the list of animated GIFs when the last one ends. Establezca esta propiedad en true para reproducir el archivo animado automáticamente; de lo contrario, establézcala en false.Set this property to true to automatically replay the animation; otherwise, false. El valor predeterminado es true.The default value is true.
autostartautostart booleanboolean Marca que indica si se debe reproducir automáticamente el archivo de animación cuando se muestra la tarjeta.Flag that indicates whether to automatically play the animation when the card is displayed. Establezca esta propiedad en true para reproducir el archivo animado automáticamente; de lo contrario, establézcala en false.Set this property to true to automatically play the animation; otherwise, false. El valor predeterminado es true.The default value is true.
buttonsbuttons CardAction[]CardAction[] Matriz de objetos CardAction que permite al usuario realizar una o varias acciones.Array of CardAction objects that enable the user to perform one or more actions. El canal determina el número de botones que se pueden especificar.The channel determines the number of buttons that you may specify.
durationduration stringstring La longitud del contenido multimedia, en el formato de duración ISO 8601.The length of the media content, in ISO 8601 duration format.
imageimage ThumbnailUrlThumbnailUrl Un objeto ThumbnailUrl que especifica la imagen que se mostrará en la tarjeta.A ThumbnailUrl object that specifies the image to display on the card.
mediamedia MediaUrl[]MediaUrl[] Matriz de objetos MediaUrl.Array of MediaUrl objects. Cuando este campo contiene más de una dirección URL, cada dirección URL es un formato alternativo del mismo contenido.When this field contains more than one URL, each URL is an alternative format of the same content.
shareableshareable booleanboolean Marca que indica si la animación puede compartirse con otros usuarios.Flag that indicates whether the animation may be shared with others. Establezca esta propiedad en true si la animación puede compartirse; de lo contrario, en false.Set this property to true if the animation may be shared; otherwise, false. El valor predeterminado es true.The default value is true.
subtitlesubtitle stringstring Subtítulo que se mostrará debajo del título de la tarjeta.Subtitle to display under the card's title.
texttext stringstring Descripción o mensaje para mostrar debajo del título o subtítulo de la tarjeta.Description or prompt to display under the card's title or subtitle.
titletitle stringstring Título de la tarjeta.Title of the card.
valuevalue objectobject Parámetro complementario de esta tarjeta.Supplementary parameter for this card.

Volver a la tabla de esquemaBack to Schema table

Objeto AttachmentAttachment object

Define información adicional que se va a incluir en el mensaje.Defines additional information to include in the message. Los datos adjuntos pueden ser archivos (como imágenes, audio o vídeo) o una tarjeta enriquecida.An attachment may be a file (such as an image, audio, or video) or a rich card.

PropiedadProperty TipoType DescripciónDescription
contentcontent objectobject Contenido de los datos adjuntos.The content of the attachment. Si los datos adjuntos son una tarjeta enriquecida, establezca esta propiedad en el objeto de tarjeta enriquecida.If the attachment is a rich card, set this property to the rich card object. Esta propiedad y la propiedad contentUrl son mutuamente excluyentes.This property and the contentUrl property are mutually exclusive.
contentTypecontentType stringstring Tipo de elemento multimedia del contenido de los datos adjuntos.The media type of the content in the attachment. Para los archivos multimedia, establezca esta propiedad en los tipos de elementos multimedia conocidos como image/png, audio/wav y video/mp4.For media files, set this property to known media types such as image/png, audio/wav, and video/mp4. Para tarjetas enriquecidas, establezca esta propiedad en uno de estos tipos específicos del proveedor:For rich cards, set this property to one of these vendor-specific types:
  • application/vnd.microsoft.card.adaptive: tarjeta enriquecida que puede contener cualquier combinación de texto, voz, imágenes, botones y campos de entrada.application/vnd.microsoft.card.adaptive: A rich card that can contain any combination of text, speech, images, buttons, and input fields. Establezca la propiedad content en un objeto AdaptiveCard.Set the content property to an AdaptiveCard object.
  • application/vnd.microsoft.card.animation: tarjeta enriquecida que reproduce una animación.application/vnd.microsoft.card.animation: A rich card that plays animation. Establezca la propiedad content en un objeto AnimationCard.Set the content property to an AnimationCard object.
  • application/vnd.microsoft.card.audio: tarjeta enriquecida que reproduce archivos de audio.application/vnd.microsoft.card.audio: A rich card that plays audio files. Establezca la propiedad content en un objeto AudioCard.Set the content property to an AudioCard object.
  • application/vnd.microsoft.card.hero: tarjeta de imagen prominente.application/vnd.microsoft.card.hero: A Hero card. Establezca la propiedad content en un objeto HeroCard.Set the content property to a HeroCard object.
  • application/vnd.microsoft.card.receipt: tarjeta de recepción.application/vnd.microsoft.card.receipt: A Receipt card. Establezca la propiedad content en un objeto ReceiptCard.Set the content property to a ReceiptCard object.
  • application/vnd.microsoft.card.signin: tarjeta de inicio de sesión del usuario.application/vnd.microsoft.card.signin: A user Sign In card. Establezca la propiedad content en un objeto SignInCard.Set the content property to a SignInCard object.
  • application/vnd.microsoft.card.thumbnail: tarjeta de miniatura.application/vnd.microsoft.card.thumbnail: A Thumbnail card. Establezca la propiedad content en un objeto ThumbnailCard.Set the content property to a ThumbnailCard object.
  • application/vnd.microsoft.card.video: tarjeta enriquecida que reproduce vídeos.application/vnd.microsoft.card.video: A rich card that plays videos. Establezca la propiedad content en un objeto VideoCard.Set the content property to a VideoCard object.
contentUrlcontentUrl stringstring Dirección URL del contenido de los datos adjuntos.URL for the content of the attachment. Por ejemplo, si los datos adjuntos son una imagen, puede establecer contentUrl en la dirección URL que representa la ubicación de la imagen.For example, if the attachment is an image, you can set contentUrl to the URL that represents the location of the image. Los protocolos admitidos son: HTTP, HTTPS, File y Data.Supported protocols are: HTTP, HTTPS, File, and Data.
namename stringstring Nombre de los datos adjuntos.Name of the attachment.
thumbnailUrlthumbnailUrl stringstring Dirección URL de una imagen en miniatura que el canal puede utilizar si admite el uso de una forma alternativa más pequeña de content o contentUrl.URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. Por ejemplo, si establece contentType en application/word y contentUrl en la ubicación del documento de Word, puede incluir una imagen en miniatura que representa el documento.For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. El canal puede mostrar la imagen en miniatura en lugar del documento.The channel could display the thumbnail image instead of the document. Cuando el usuario hace clic en la imagen, el canal abre el documento.When the user clicks the image, the channel would open the document.

Volver a la tabla de esquemaBack to Schema table

Objeto AttachmentDataAttachmentData object

Describe los datos adjuntos.Describes an attachment's data.

PropiedadProperty TipoType DescripciónDescription
namename stringstring Nombre de los datos adjuntos.Name of the attachment.
originalBase64originalBase64 stringstring Contenido de los datos adjuntos.Attachment content.
thumbnailBase64thumbnailBase64 stringstring Contenido de los datos adjuntos en miniatura.Attachment thumbnail content.
typetype stringstring Tipo de contenido de los datos adjuntos.Content type of the attachment.

Volver a la tabla de esquemaBack to Schema table

Objeto AttachmentInfoAttachmentInfo object

Metadatos de los datos adjuntos.Metadata for an attachment.

PropiedadProperty TipoType DescripciónDescription
namename stringstring Nombre de los datos adjuntos.Name of the attachment.
typetype stringstring Tipo de contenido de los datos adjuntos.Content type of the attachment.
vistasviews AttachmentView[]AttachmentView[] Matriz de objetos AttachmentView que representan las vistas disponibles para los datos adjuntos.Array of AttachmentView objects that represent the available views for the attachment.

Volver a la tabla de esquemaBack to Schema table

Objeto AttachmentViewAttachmentView object

Define una vista de datos adjuntos.Defines a attachment view.

PropiedadProperty TipoType DescripciónDescription
sizesize numbernumber Tamaño del archivo.Size of the file.
viewIdviewId stringstring Identificador de la vista.View ID.

Volver a la tabla de esquemaBack to Schema table

Objeto AudioCardAudioCard object

Define una tarjeta que puede reproducir un archivo de audio.Defines a card that can play an audio file.

PropiedadProperty TipoType DescripciónDescription
aspectaspect stringstring Relación de aspecto de la miniatura que se especifica en la propiedad image.Aspect ratio of the thumbnail that is specified in the image property. Los valores válidos son 16:9 y 4:3.Valid values are 16:9 and 4:3.
autoloopautoloop booleanboolean Marca que indica si se debe reproducir la lista de archivos de audio cuando finaliza la última.Flag that indicates whether to replay the list of audio files when the last one ends. Establezca esta propiedad en true para reproducir los archivos de audio automáticamente; de lo contrario, establézcala en false.Set this property to true to automatically replay the audio files; otherwise, false. El valor predeterminado es true.The default value is true.
autostartautostart booleanboolean Marca que indica si se debe reproducir automáticamente el archivo de audio cuando se muestra la tarjeta.Flag that indicates whether to automatically play the audio when the card is displayed. Establezca esta propiedad en true para reproducir el audio automáticamente; de lo contrario, establézcala en false.Set this property to true to automatically play the audio; otherwise, false. El valor predeterminado es true.The default value is true.
buttonsbuttons CardAction[]CardAction[] Matriz de objetos CardAction que permite al usuario realizar una o varias acciones.Array of CardAction objects that enable the user to perform one or more actions. El canal determina el número de botones que se pueden especificar.The channel determines the number of buttons that you may specify.
durationduration stringstring La longitud del contenido multimedia, en el formato de duración ISO 8601.The length of the media content, in ISO 8601 duration format.
imageimage ThumbnailUrlThumbnailUrl Un objeto ThumbnailUrl que especifica la imagen que se mostrará en la tarjeta.A ThumbnailUrl object that specifies the image to display on the card.
mediamedia MediaUrl[]MediaUrl[] Matriz de objetos MediaUrl.Array of MediaUrl objects. Cuando este campo contiene más de una dirección URL, cada dirección URL es un formato alternativo del mismo contenido.When this field contains more than one URL, each URL is an alternative format of the same content.
shareableshareable booleanboolean Marca que indica si los archivos de audio compartirse con otros usuarios.Flag that indicates whether the audio files may be shared with others. Establezca esta propiedad en true si el audio puede compartirse; de lo contrario, en false.Set this property to true if the audio may be shared; otherwise, false. El valor predeterminado es true.The default value is true.
subtitlesubtitle stringstring Subtítulo que se mostrará debajo del título de la tarjeta.Subtitle to display under the card's title.
texttext stringstring Descripción o mensaje para mostrar debajo del título o subtítulo de la tarjeta.Description or prompt to display under the card's title or subtitle.
titletitle stringstring Título de la tarjeta.Title of the card.
valuevalue objectobject Parámetro complementario de esta tarjeta.Supplementary parameter for this card.

Volver a la tabla de esquemaBack to Schema table

Objeto CardActionCardAction object

Define una acción en la que se puede hacer clic con un botón.Defines a clickable action with a button.

PropiedadProperty TipoType DescripciónDescription
channelDatachannelData stringstring Datos específicos del canal asociados a esta acción.Channel-specific data associated with this action.
displayTextdisplayText stringstring Texto que aparecerá en la fuente del chat si se hace clic en el botón.Text to display in the chat feed if the button is clicked.
imageimage stringstring Dirección URL de la imagen que aparecerá en el botón junto a la etiqueta de texto.Image URL which will appear on the button, next to the text label.
texttext stringstring Texto para la acción.Text for the action.
titletitle stringstring Descripción del texto que aparece en el botón.Text description which appears on the button.
typetype stringstring Tipo de acción que se va a realizar.Type of action to perform. Para obtener una lista de valores válidos, vea Incorporación de tarjetas enriquecidas a mensajes.For a list of valid values, see Add rich card attachments to messages.
valuevalue objectobject Parámetro complementario de la acción.Supplementary parameter for the action. El comportamiento de esta propiedad variará según el objeto type de la acción.The behavior of this property will vary according to the action type. Para más información, vea Incorporación de datos adjuntos de tarjetas enriquecidas a mensajes.For more information, see Add rich card attachments to messages.

Volver a la tabla de esquemaBack to Schema table

Objeto CardImageCardImage object

Define una imagen para mostrarla en una tarjeta.Defines an image to display on a card.

PropiedadProperty TipoType DescripciónDescription
altalt stringstring Descripción de la imagen.Description of the image. Debe incluir la descripción para admitir la accesibilidad.You should include the description to support accessibility.
taptap CardActionCardAction Un objeto CardAction que especifica la acción que se realizará si el usuario pulsa o hace clic en la imagen.A CardAction object that specifies the action to perform if the user taps or clicks the image.
urlurl stringstring Dirección URL del origen de la imagen o del binario Base64 de la imagen (por ejemplo, data:image/png;base64,iVBORw0KGgo...).URL to the source of the image or the base64 binary of the image (for example, data:image/png;base64,iVBORw0KGgo...).

Volver a la tabla de esquemaBack to Schema table

Objeto ChannelAccountChannelAccount object

Define un bot o cuenta de usuario en el canal.Defines a bot or user account on the channel.

PropiedadProperty TipoType DescripciónDescription
aadObjectIdaadObjectId stringstring Identificador de objeto de esta cuenta dentro de Azure Active Directory.This account's object ID within Azure Active Directory.
idid stringstring Identificador único del usuario o bot en este canal.Unique ID for the user or bot on this channel.
namename stringstring Nombre descriptivo del bot o el usuario.Display-friendly name of the bot or user.
rolerole stringstring Rol de la entidad que se encuentra detrás de la cuenta.Role of the entity behind the account. user (usuario) o bot.Either user or bot.

Volver a la tabla de esquemaBack to Schema table

Objeto ConversationAccountConversationAccount object

Define una conversación en un canal.Defines a conversation in a channel.

PropiedadProperty TipoType DescripciónDescription
aadObjectIdaadObjectId stringstring Identificador de objeto de esta cuenta dentro de Azure Active Directory (AAD).This account's object ID within Azure Active Directory (AAD).
conversationTypeconversationType stringstring Indica el tipo de conversación en canales que distinguen entre tipos de conversación (por ejemplo, grupo o personal).Indicates the type of the conversation in channels that distinguish between conversation types (e.g. group, personal).
idid stringstring Identificador de la conversación.The ID that identifies the conversation. El identificador es único para cada canal.The ID is unique per channel. Si el canal inicia la conversación, establece este identificador; de lo contrario, el bot establece esta propiedad en el identificador que obtiene con la respuesta cuando inicia la conversación (consulte Crear conversación).If the channel starts the conversation, it sets this ID; otherwise, the bot sets this property to the ID that it gets back in the response when it starts the conversation (see Create Conversation).
isGroupisGroup booleanboolean Marca que indica si la conversación contiene más de dos participantes en el momento en que se generó la actividad.Flag to indicate whether the conversation contains more than two participants at the time the activity was generated. Se establece en true si se trata de una conversación de grupo; en caso contrario, en false.Set to true if this is a group conversation; otherwise, false. El valor predeterminado es false.The default is false.
namename stringstring Un nombre para mostrar que se puede usar para identificar la conversación.A display name that can be used to identify the conversation.
rolerole stringstring Rol de la entidad que se encuentra detrás de la cuenta.Role of the entity behind the account. user (usuario) o bot.Either user or bot.
tenantIdtenantId stringstring Identificador del inquilino de esta conversación.This conversation's tenant ID.

Volver a la tabla de esquemaBack to Schema table

Objeto ConversationMembersConversationMembers object

Define los miembros de una conversación.Defines the members of a conversation.

PropiedadProperty TipoType DescripciónDescription
idid stringstring El identificador de la conversación.The conversation ID.
membersmembers ChannelAccount[]ChannelAccount[] Lista de miembros de esta conversación.List of members in this conversation.

Volver a la tabla de esquemaBack to Schema table

Objeto ConversationParametersConversationParameters object

Define los parámetros para crear una conversación.Defines parameters for creating a new conversation.

PropiedadProperty TipoType DescripciónDescription
activityactivity ActividadActivity El mensaje inicial que se envía a la conversación cuando se crea.The initial message to send to the conversation when it is created.
botbot ChannelAccountChannelAccount Información de la cuenta de canal necesaria para enrutar un mensaje al bot.Channel account information needed to route a message to the bot.
channelDatachannelData objectobject Carga útil específica del canal para crear la conversación.Channel-specific payload for creating the conversation.
isGroupisGroup booleanboolean Indica si se trata de una conversación de grupo.Indicates whether this is a group conversation.
membersmembers ChannelAccount[]ChannelAccount[] Información de la cuenta de canal necesaria para enrutar un mensaje a cada usuario.Channel account information needed to route a message to each user.
tenantIdtenantId stringstring El identificador del inquilino en el que se debe crear la conversación.The tenant ID in which the conversation should be created.
topicNametopicName stringstring Tema de la conversación.Topic of the conversation. Esta propiedad solo se usa si un canal la admite.This property is only used if a channel supports it.

Volver a la tabla de esquemaBack to Schema table

Objeto ConversationReferenceConversationReference object

Define un punto concreto de una conversación.Defines a particular point in a conversation.

PropiedadProperty TipoType DescripciónDescription
activityIdactivityId stringstring Identificador que identifica de forma única la actividad a la que hace referencia este objeto.ID that uniquely identifies the activity that this object references.
botbot ChannelAccountChannelAccount Un objeto ChannelAccount que identifica el bot en la conversación a la que este objeto hace referencia.A ChannelAccount object that identifies the bot in the conversation that this object references.
channelIdchannelId stringstring Un identificador que identifica de forma única el canal en la conversación a la que este objeto hace referencia.An ID that uniquely identifies the channel in the conversation that this object references.
conversationconversation ConversationAccountConversationAccount Un objeto ConversationAccount que define la conversación a la que este objeto hace referencia.A ConversationAccount object that defines the conversation that this object references.
serviceUrlserviceUrl stringstring Dirección URL que especifica el punto de conexión de servicio del canal de la conversación a la que este objeto hace referencia.URL that specifies the channel's service endpoint in the conversation that this object references.
useruser ChannelAccountChannelAccount Un objeto ChannelAccount que identifica al usuario en la conversación a la que este objeto hace referencia.A ChannelAccount object that identifies the user in the conversation that this object references.

Volver a la tabla de esquemaBack to Schema table

Objeto ConversationResourceResponseConversationResourceResponse object

Define una respuesta para Crear conversación.Defines a response to Create Conversation.

PropiedadProperty TipoType DescripciónDescription
activityIdactivityId stringstring Identificador de la actividad, si se envía.ID of the activity, if sent.
idid stringstring Identificador del recurso.ID of the resource.
serviceUrlserviceUrl stringstring Punto de conexión de servicio en el que se pueden realizar las operaciones relacionadas con la conversación.Service endpoint where operations concerning the conversation may be performed.

Volver a la tabla de esquemaBack to Schema table

Objeto ConversationsResultConversationsResult object

Define el resultado de Obtener conversaciones.Defines the result of Get Conversations.

PropiedadProperty TipoType DescripciónDescription
conversacionesconversations ConversationMembers[]ConversationMembers[] Los miembros de cada una de las conversaciones.The members in each of the conversations.
continuationTokencontinuationToken stringstring El token de continuación que se puede usar en las llamadas subsiguientes a Obtener conversaciones.The continuation token that can be used in subsequent calls to Get Conversations.

Volver a la tabla de esquemaBack to Schema table

Objeto EntityEntity object

Objeto de metadatos que pertenece a una actividad.Metadata object pertaining to an activity.

PropiedadProperty TipoType DescripciónDescription
typetype stringstring Tipo de esta entidad (RFC 3987 IRI).Type of this entity (RFC 3987 IRI).

Volver a la tabla de esquemaBack to Schema table

Objeto de errorError object

Objeto que representa la información de error.Object representing error information.

PropiedadProperty TipoType DescripciónDescription
codecode stringstring Código de error.Error code.
innerHttpErrorinnerHttpError InnerHttpErrorInnerHttpError Objeto que representa el error HTTP interno.Object representing the inner HTTP error.
messagemessage stringstring Descripción del error.A description of the error.

Volver a la tabla de esquemaBack to Schema table

Objeto ErrorResponseErrorResponse object

Define una respuesta de la API HTTP.Defines an HTTP API response.

PropiedadProperty TipoType DescripciónDescription
errorerror ErrorError Un objeto Error que contiene información sobre el error.An Error object that contains information about the error.

Volver a la tabla de esquemaBack to Schema table

Objeto FactFact object

Define un par clave-valor que contiene un hecho.Defines a key-value pair that contains a fact.

PropiedadProperty TipoType DescripciónDescription
keykey stringstring Nombre del hecho.Name of the fact. Por ejemplo, inserción en el repositorio.For example, Check-in. La clave se usa como una etiqueta al mostrar el valor del hecho.The key is used as a label when displaying the fact's value.
valuevalue stringstring Valor del hecho.Value of the fact. Por ejemplo, 10 de octubre de 2016.For example, 10 October 2016.

Volver a la tabla de esquemaBack to Schema table

Objeto GeocoordinatesGeoCoordinates object

Define una ubicación geográfica mediante las coordenadas del sistema geodésico mundial (WSG84).Defines a geographical location using World Geodetic System (WSG84) coordinates.

PropiedadProperty TipoType DescripciónDescription
elevationelevation numbernumber Elevación de la ubicación.Elevation of the location.
latitudelatitude numbernumber Latitud de la ubicación.Latitude of the location.
longitudelongitude numbernumber Longitud de la ubicación.Longitude of the location.
namename stringstring Nombre de la ubicación.Name of the location.
typetype stringstring El tipo de este objeto.The type of this object. Siempre se establece en GeoCoordinates.Always set to GeoCoordinates.

Volver a la tabla de esquemaBack to Schema table

Objeto HeroCardHeroCard object

Define una tarjeta con una imagen grande, título, texto y botones de acción.Defines a card with a large image, title, text, and action buttons.

PropiedadProperty TipoType DescripciónDescription
buttonsbuttons CardAction[]CardAction[] Matriz de objetos CardAction que permite al usuario realizar una o varias acciones.Array of CardAction objects that enable the user to perform one or more actions. El canal determina el número de botones que se pueden especificar.The channel determines the number of buttons that you may specify.
imagesimages CardImage[]CardImage[] Matriz de objetos CardImage que especifica la imagen que se mostrará en la tarjeta.Array of CardImage objects that specifies the image to display on the card. Una tarjeta Hero contiene solo una imagen.A Hero card contains only one image.
subtitlesubtitle stringstring Subtítulo que se mostrará debajo del título de la tarjeta.Subtitle to display under the card's title.
taptap CardActionCardAction Un objeto CardAction que especifica la acción que se realizará si el usuario pulsa o hace clic en la tarjeta.A CardAction object that specifies the action to perform if the user taps or clicks the card. Puede ser la misma acción que uno de los botones o una acción diferente.This can be the same action as one of the buttons or a different action.
texttext stringstring Descripción o mensaje para mostrar debajo del título o subtítulo de la tarjeta.Description or prompt to display under the card's title or subtitle.
titletitle stringstring Título de la tarjeta.Title of the card.

Volver a la tabla de esquemaBack to Schema table

Objeto InnerHttpErrorInnerHttpError object

Objeto que representa un error HTTP interno.Object representing an inner HTTP error.

PropiedadProperty TipoType DescripciónDescription
statusCodestatusCode numbernumber Código de estado HTTP de la solicitud con error.HTTP status code from the failed request.
bodybody objectobject Cuerpo de la solicitud con error.Body from the failed request.

Volver a la tabla de esquemaBack to Schema table

Objeto MediaEventValueMediaEventValue object

Parámetros complementarios para eventos multimedia.Supplementary parameter for media events.

PropiedadProperty TipoType DescripciónDescription
cardValuecardValue objectobject Parámetro de devolución de llamada especificado en el campo Valor de la tarjeta multimedia que originó este evento.Callback parameter specified in the value field of the media card that originated this event.

Volver a la tabla de esquemaBack to Schema table

Objeto MediaUrlMediaUrl object

Define la dirección URL al origen de un archivo multimedia.Defines the URL to a media file's source.

PropiedadProperty TipoType DescripciónDescription
profileprofile stringstring Sugerencia que describe el contenido del elemento multimedia.Hint that describes the media's content.
urlurl stringstring Dirección URL del origen del archivo multimedia.URL to the source of the media file.

Volver a la tabla de esquemaBack to Schema table

Objeto MentionMention object

Define un usuario o un bot que se mencionó en la conversación.Defines a user or bot that was mentioned in the conversation.

PropiedadProperty TipoType DescripciónDescription
mentionedmentioned ChannelAccountChannelAccount Un objeto ChannelAccount que especifica el usuario o el bot que se ha mencionado.A ChannelAccount object that specifies the user or the bot that was mentioned. Tenga en cuenta que algunos canales como Slack asignan nombres por conversación, por lo que es posible que el nombre mencionado del bot (en la propiedad recipient del mensaje) difiera del identificador especificado cuando se registró el bot.Note that some channels such as Slack assign names per conversation, so it is possible that your bot's mentioned name (in the message's recipient property) may be different from the handle that you specified when you registered your bot. Sin embargo, los identificadores de cuenta podrían ser los mismos.However, the account IDs for both would be the same.
texttext stringstring El usuario o bot como se mencionaron en la conversación.The user or bot as mentioned in the conversation. Por ejemplo, si el mensaje es @ColorBot "pick me a new color", esta propiedad se establecería en @ ColorBot.For example, if the message is "@ColorBot pick me a new color," this property would be set to @ColorBot. No todos los canales establecen esta propiedad.Not all channels set this property.
typetype stringstring Tipo de este objeto.This object's type. Siempre se establece en Mention.Always set to Mention.

Volver a la tabla de esquemaBack to Schema table

Objeto MessageReactionMessageReaction object

Define una reacción a un mensaje.Defines a reaction to a message.

PropiedadProperty TipoType DescripciónDescription
typetype stringstring Tipo de reacción.Type of reaction. like o plusOne.Either like or plusOne.

Volver a la tabla de esquemaBack to Schema table

Objeto PagedMembersResultPagedMembersResult object

Página de miembros que devuelve la operación Obtener los miembros de la conversación paginados.Page of members returned by Get Conversation Paged Members.

PropiedadProperty TipoType DescripciónDescription
continuationTokencontinuationToken stringstring El token de continuación que se puede usar en las llamadas subsiguientes a la operación Obtener los miembros de la conversación paginados.The continuation token that can be used in subsequent calls to Get Conversation Paged Members.
membersmembers ChannelAccount[]ChannelAccount[] Una matriz de miembros de la conversación.An array of conversation members.

Volver a la tabla de esquemaBack to Schema table

Objeto PlacePlace object

Define un lugar mencionado en la conversación.Defines a place that was mentioned in the conversation.

PropiedadProperty TipoType DescripciónDescription
addressaddress objectobject Dirección de un lugar.Address of a place. Esta propiedad puede ser una cadena o un objeto complejo del tipo PostalAddress.This property can be a string or a complex object of type PostalAddress.
geogeo GeoCoordinatesGeoCoordinates Un objeto GeoCoordinates que especifica las coordenadas geográficas de un lugar.A GeoCoordinates object that specifies the geographical coordinates of the place.
hasMaphasMap objectobject Mapa del lugar.Map to the place. Esta propiedad puede ser de tipo string (URL) o un objeto complejo de tipo Map.This property can be a string (URL) or a complex object of type Map.
namename stringstring Nombre del lugar.Name of the place.
typetype stringstring Tipo de este objeto.This object's type. Siempre se establece en Place.Always set to Place.

Volver a la tabla de esquemaBack to Schema table

Objeto ReceiptCardReceiptCard object

Define una tarjeta que contiene una recepción de una compra.Defines a card that contains a receipt for a purchase.

PropiedadProperty TipoType DescripciónDescription
buttonsbuttons CardAction[]CardAction[] Matriz de objetos CardAction que permite al usuario realizar una o varias acciones.Array of CardAction objects that enable the user to perform one or more actions. El canal determina el número de botones que se pueden especificar.The channel determines the number of buttons that you may specify.
factsfacts Fact[]Fact[] Matriz de objetos Fact que especifican información sobre la compra.Array of Fact objects that specify information about the purchase. Por ejemplo, la lista de hechos de la factura de la estancia en un hotel puede incluir la fecha de entrada y la fecha de salida.For example, the list of facts for a hotel stay receipt might include the check-in date and check-out date. El canal determina el número de hechos que se pueden especificar.The channel determines the number of facts that you may specify.
itemsitems ReceiptItem[]ReceiptItem[] Matriz de objetos ReceiptItem que especifican los elementos comprados.Array of ReceiptItem objects that specify the purchased items
taptap CardActionCardAction Un objeto CardAction que especifica la acción que se realizará si el usuario pulsa o hace clic en la tarjeta.A CardAction object that specifies the action to perform if the user taps or clicks the card. Puede ser la misma acción que uno de los botones o una acción diferente.This can be the same action as one of the buttons or a different action.
taxtax stringstring Una cadena con formato de moneda que especifica la cuantía de los impuestos aplicados a la compra.A currency-formatted string that specifies the amount of tax applied to the purchase.
titletitle stringstring Título que se muestra en la parte superior de la factura.Title displayed at the top of the receipt.
totaltotal stringstring Una cadena con formato de moneda que especifica el precio total de la compra, incluidos todos los impuestos aplicables.A currency-formatted string that specifies the total purchase price, including all applicable taxes.
vatvat stringstring Una cadena con formato de moneda que especifica la cuantía del impuesto sobre el valor añadido (IVA) aplicado al precio de compra.A currency-formatted string that specifies the amount of value-added tax (VAT) applied to the purchase price.

Volver a la tabla de esquemaBack to Schema table

Objeto ReceiptItemReceiptItem object

Define un elemento de línea dentro de una confirmación.Defines a line item within a receipt.

PropiedadProperty TipoType DescripciónDescription
imageimage CardImageCardImage Un objeto CardImage que especifica la imagen en miniatura que se mostrará junto al elemento de línea.A CardImage object that specifies thumbnail image to display next to the line item.
priceprice stringstring Una cadena con formato de moneda que especifica el precio total de todas las unidades compradas.A currency-formatted string that specifies the total price of all units purchased.
quantityquantity stringstring Una cadena numérica que especifica el número de unidades compradas.A numeric string that specifies the number of units purchased.
subtitlesubtitle stringstring Subtítulo para mostrar debajo del título del elemento de línea.Subtitle to be displayed under the line item's title.
taptap CardActionCardAction Un objeto CardAction que especifica la acción que se realizará si el usuario pulsa o hace clic en el elemento de línea.A CardAction object that specifies the action to perform if the user taps or clicks the line item.
texttext stringstring Descripción del elemento de línea.Description of the line item.
titletitle stringstring Título del elemento de línea.Title of the line item.

Volver a la tabla de esquemaBack to Schema table

Objeto ResourceResponseResourceResponse object

Define una respuesta que contiene un identificador de recurso.Defines a response that contains a resource ID.

PropiedadProperty TipoType DescripciónDescription
idid stringstring Identificador que distingue de manera única el recurso.ID that uniquely identifies the resource.

Volver a la tabla de esquemaBack to Schema table

Objeto SemanticActionSemanticAction object

Define una referencia a una acción mediante programación.Defines a reference to a programmatic action.

PropiedadProperty TipoType DescripciónDescription
entitiesentities objectobject Objeto en el que el valor de cada propiedad es un objeto Entity (entidad).An object where the value of each property is an Entity object.
idid stringstring Identificador de esta acción.ID of this action.
statestate stringstring Estado de esta acción.State of this action. Los valores permitidos son: start (iniciar), continue (continuar), done (listo).Allowed values: start, continue, done.

Volver a la tabla de esquemaBack to Schema table

Objeto SignInCardSignInCard object

Define una tarjeta que permite a un usuario iniciar sesión en un servicio.Defines a card that lets a user sign in to a service.

PropiedadProperty TipoType DescripciónDescription
buttonsbuttons CardAction[]CardAction[] Matriz de objetos CardAction que permite al usuario iniciar sesión en un servicio.Array of CardAction objects that enable the user to sign in to a service. El canal determina el número de botones que se pueden especificar.The channel determines the number of buttons that you may specify.
texttext stringstring Descripción o mensaje para incluir en la tarjeta de inicio de sesión.Description or prompt to include on the sign in card.

Volver a la tabla de esquemaBack to Schema table

Objeto SuggestedActionsSuggestedActions object

Define las opciones que puede elegir un usuario.Defines the options from which a user can choose.

PropiedadProperty TipoType DescripciónDescription
actionsactions CardAction[]CardAction[] Matriz de objetos CardAction que definen las acciones sugeridas.Array of CardAction objects that define the suggested actions.
toto string[]string[] Matriz de cadenas que contiene los identificadores de los destinatarios a los que se mostrarán las acciones sugeridas.Array of strings that contains the IDs of the recipients to whom the suggested actions should be displayed.

Volver a la tabla de esquemaBack to Schema table

Objeto TextHighlightTextHighlight object

Hace referencia a una subcadena de contenido dentro de otro campo.Refers to a substring of content within another field.

PropiedadProperty TipoType DescripciónDescription
occurrenceoccurrence numbernumber Aparición del campo de texto en el texto al que se hace referencia, en caso de que existan varios.Occurrence of the text field within the referenced text, if multiple exist.
texttext stringstring Define el fragmento de texto que se va a resaltar.Defines the snippet of text to highlight.

Volver a la tabla de esquemaBack to Schema table

Objeto ThumbnailCardThumbnailCard object

Define una tarjeta con una imagen en miniatura, título, texto y botones de acción.Defines a card with a thumbnail image, title, text, and action buttons.

PropiedadProperty TipoType DescripciónDescription
buttonsbuttons CardAction[]CardAction[] Matriz de objetos CardAction que permite al usuario realizar una o varias acciones.Array of CardAction objects that enable the user to perform one or more actions. El canal determina el número de botones que se pueden especificar.The channel determines the number of buttons that you may specify.
imagesimages CardImage[]CardImage[] Matriz de objetos CardImage que especifican las imágenes en miniatura que se mostrarán en la tarjeta.Array of CardImage objects that specify thumbnail images to display on the card. El canal determina el número de imágenes en miniatura que se pueden especificar.The channel determines the number of thumbnail images that you may specify.
subtitlesubtitle stringstring Subtítulo que se mostrará debajo del título de la tarjeta.Subtitle to display under the card's title.
taptap CardActionCardAction Un objeto CardAction que especifica la acción que se realizará si el usuario pulsa o hace clic en la tarjeta.A CardAction object that specifies the action to perform if the user taps or clicks the card. Puede ser la misma acción que uno de los botones o una acción diferente.This can be the same action as one of the buttons or a different action.
texttext stringstring Descripción o mensaje para mostrar debajo del título o subtítulo de la tarjeta.Description or prompt to display under the card's title or subtitle.
titletitle stringstring Título de la tarjeta.Title of the card.

Volver a la tabla de esquemaBack to Schema table

Objeto ThumbnailUrlThumbnailUrl object

Define la dirección URL al origen de una imagen.Defines the URL to an image's source.

PropiedadProperty TipoType DescripciónDescription
altalt stringstring Descripción de la imagen.Description of the image. Debe incluir la descripción para admitir la accesibilidad.You should include the description to support accessibility.
urlurl stringstring Dirección URL del origen de la imagen o del binario Base64 de la imagen (por ejemplo, data:image/png;base64,iVBORw0KGgo...).URL to the source of the image or the base64 binary of the image (for example, data:image/png;base64,iVBORw0KGgo...).

Volver a la tabla de esquemaBack to Schema table

Objeto TranscriptTranscript object

Una colección de actividades que se cargará mediante Enviar historial de la conversación.A collection of activities to be uploaded using Send Conversation History.

PropiedadProperty TipoType DescripciónDescription
activitiesactivities arrayarray Una matriz de objetos Activity.An array of Activity objects. Deben tener un identificador único y una marca de tiempo.They should each have a unique ID and timestamp.

Volver a la tabla de esquemaBack to Schema table

Objeto VideoCardVideoCard object

Define una tarjeta que puede reproducir vídeos.Defines a card that can play videos.

PropiedadProperty TipoType DescripciónDescription
aspectaspect stringstring Relación de aspecto de un vídeo.Aspect ratio of the video. 16:9 o 4:3.Either 16:9 or 4:3.
autoloopautoloop booleanboolean Marca que indica si se debe reproducir la lista de vídeos cuando finaliza la última.Flag that indicates whether to replay the list of videos when the last one ends. Establezca esta propiedad en true para reproducir los vídeos automáticamente; de lo contrario, establézcala en false.Set this property to true to automatically replay the videos; otherwise, false. El valor predeterminado es true.The default value is true.
autostartautostart booleanboolean Marca que indica si se deben reproducir automáticamente los vídeos cuando se muestra la tarjeta.Flag that indicates whether to automatically play the videos when the card is displayed. Establezca esta propiedad en true para reproducir los vídeos automáticamente; de lo contrario, establézcala en false.Set this property to true to automatically play the videos; otherwise, false. El valor predeterminado es true.The default value is true.
buttonsbuttons CardAction[]CardAction[] Matriz de objetos CardAction que permite al usuario realizar una o varias acciones.Array of CardAction objects that enable the user to perform one or more actions. El canal determina el número de botones que se pueden especificar.The channel determines the number of buttons that you may specify.
durationduration stringstring La longitud del contenido multimedia, en el formato de duración ISO 8601.The length of the media content, in ISO 8601 duration format.
imageimage ThumbnailUrlThumbnailUrl Un objeto ThumbnailUrl que especifica la imagen que se mostrará en la tarjeta.A ThumbnailUrl object that specifies the image to display on the card.
mediamedia MediaUrl[]MediaUrl[] Matriz de MediaUrl.Array of MediaUrl. Cuando este campo contiene más de una dirección URL, cada dirección URL es un formato alternativo del mismo contenido.When this field contains more than one URL, each URL is an alternative format of the same content.
shareableshareable booleanboolean Marca que indica si los vídeos pueden compartirse con otros usuarios.Flag that indicates whether the videos may be shared with others. Establezca esta propiedad en true si los vídeos pueden compartirse; de lo contrario, en false.Set this property to true if the videos may be shared; otherwise, false. El valor predeterminado es true.The default value is true.
subtitlesubtitle stringstring Subtítulo que se mostrará debajo del título de la tarjeta.Subtitle to display under the card's title.
texttext stringstring Descripción o mensaje para mostrar debajo del título o subtítulo de la tarjeta.Description or prompt to display under the card's title or subtitle.
titletitle stringstring Título de la tarjeta.Title of the card.
valuevalue objectobject Parámetro complementario de esta tarjeta.Supplementary parameter for this card

Volver a la tabla de esquemaBack to Schema table