Creación de mensajes con Bot Connector API
El bot enviará objetos Actividad de tipo mensaje para comunicar información a los usuarios y, del mismo modo, recibirá actividades de mensajes de los usuarios. Algunos mensajes pueden constar simplemente de texto sin formato, mientras que otros pueden incluir contenido más enriquecido, como texto que se va a decir, acciones sugeridas, datos adjuntos multimedia, tarjetas enriquecidas y datos específicos del canal. En este artículo se describen algunas propiedades de mensaje usadas habitualmente.
Texto y formato del mensaje
Se puede aplicar formato al texto del mensaje mediante plain, markdown o xml. El formato predeterminado de la propiedad textFormat es markdown e interpreta el texto mediante los estándares de formato de Markdown. El nivel de compatibilidad con el formato de texto según el canal.
Sugerencia
Para obtener información sobre qué características se admiten en cada canal, consulte el artículo de referencia de canales .
La propiedad textFormat de un objeto Actividad se puede usar para especificar el formato del texto. Por ejemplo, para crear un mensaje básico que contenga solo texto sin formato, establezca la propiedad textFormat del objeto Activity en plain, establezca la propiedad text en el contenido del mensaje y establezca la propiedad locale en la configuración regional del remitente.
Datos adjuntos
La propiedad attachments de un objeto Actividad puede usarse para enviar datos adjuntos multimedia sencillos (imagen, audio, vídeo, archivo) y tarjetas enriquecidas. Para más información, vea Add media attachments to messages (Agregar datos adjuntos multimedia a mensajes) y Add rich cards to messages (Agregar tarjetas enriquecidas a mensajes).
Entidades
La propiedad entities de un objeto Actividad es una matriz de objetos schema.org de extremo abierto que permite el intercambio de metadatos contextuales comunes entre el canal y el bot.
Entidades de mención
Muchos canales ofrecen la posibilidad de que un bot o usuario "mencione" a alguien dentro del contexto de una conversación. Para mencionar a un usuario en un mensaje, rellene la propiedad entities del mensaje con un objeto Mention.
Entidades de lugar
Para transmitir información relacionada con la ubicación dentro de un mensaje, rellene la propiedad del entities mensaje con objetos Place .
Channel data
La propiedad channelData de un objeto Actividad puede usarse para implementar la funcionalidad específica del canal. Para más información, vea Implementación de una funcionalidad específica de canal.
Texto a voz
La propiedad speak del objeto Actividad puede usarse para especificar el texto que va a decir el bot en un canal habilitado para voz y la propiedad inputHint del objeto Activity se puede usar para influir en el estado del micrófono del cliente. Para más información, vea Incorporación de voz a mensajes e Incorporación de sugerencias de entrada a mensajes.
Acciones sugeridas
La propiedad suggestedActions de un objeto Actividad puede usarse para presentar los botones que el usuario puede pulsar para proporcionar la entrada. A diferencia de los botones que aparecen en las tarjetas enriquecidas (que permanecen visibles y accesibles para el usuario incluso después de que se pulsen), los botones que aparecen en el panel de acciones sugeridas desaparecerán una vez que el usuario haya hecho una selección. Para más información, vea Incorporación de acciones sugeridas a mensajes.
Recursos adicionales
- Referencia de canales
- Activities overview (Introducción a las actividades)
- Envío y recepción de mensajes
- Incorporación de datos adjuntos con elementos multimedia a mensajes
- Incorporación de tarjetas enriquecidas a mensajes
- Incorporación de voz a los mensajes
- Incorporación de sugerencias de entrada a los mensajes
- Incorporación de acciones sugeridas a mensajes
- Implementación de una funcionalidad específica de canal