Créer des messages avec l’API Bot Connector

Votre bot enverra des objets Activité de type message pour communiquer des informations aux utilisateurs et, en retour, recevoir des activités de message de la part des utilisateurs. Certains messages peuvent consister simplement en un texte brut, tandis que d’autres peuvent contenir un contenu plus riche, par exemple un texte à énoncer, des actions suggérées, des pièces jointes multimédia, des cartes riches et des données spécifiques du canal. Cet article décrit certaines des propriétés de message couramment utilisées.

Texte du message et mise en forme

Le texte du message peut être mis en forme à l’aide de brut, markdown, ou xml. Le format par défaut de la propriété textFormat est markdown et interprète le texte à l’aide de normes de mise en forme Markdown. Le niveau de prise en charge du format de texte varie en fonction des canaux.

Conseil

Pour plus d’informations sur les fonctionnalités prises en charge sur chaque canal, consultez l’article de référence sur les canaux .

La propriété textFormat de l’objet Activité peut être utilisée pour spécifier le format du texte. Par exemple, pour créer un message de base contenant uniquement du texte brut, définissez la propriété textFormat de l’objet Activity sur brut, définissez la propriété text sur le contenu du message et définissez la propriété locale sur les paramètres régionaux de l’expéditeur.

Pièces jointes

La propriété attachments de l’objet Activité peut être utilisée pour envoyer des pièces jointes multimédias simples (image, audio, vidéo, fichier) et des cartes riches. Pour plus d’informations, consultez Ajouter des pièces jointes multimédia aux messages et Ajouter des cartes riches aux messages.

Entités

La propriété entities de l’objet Activité est un tableau d’objets schema.org de durée indéterminée qui permet l’échange de métadonnées contextuelles communes entre le canal et le bot.

Mentionner des entités

De nombreux canaux permettent à un utilisateur ou un bot de « mentionner » une personne dans le cadre d’une conversation. Pour mentionner un utilisateur dans un message, remplissez la propriété entities du message avec un objet Mention.

Placer des entités

Pour transmettre des informations relatives à l’emplacement dans un message, renseignez la propriété du entities message avec des objets Place .

Données de canal

La propriété channelData de l’objet Activité peut être utilisée pour implémenter des fonctionnalités spécifiques du canal. Pour plus d’informations, consultez Implémenter une fonctionnalité spécifique au canal.

Synthèse vocale

La propriété speak de l’objet Activité peut être utilisée pour spécifier le texte à prononcer par votre bot sur un canal de reconnaissance vocale, et la propriété inputHint de l’objet Activity peut être utilisée pour influencer l’état du micro du client. Pour plus d’informations, consultez Ajouter des fonctionnalités vocales aux messages et Ajouter des conseils de saisie aux messages.

Actions suggérées

La propriété suggestedActions de l’objet Activité peut être utilisée pour présenter des boutons sur lesquels l’utilisateur peut appuyer pour effectuer une entrée. Contrairement aux boutons qui apparaissent dans les cartes enrichies (qui restent visibles et accessibles à l’utilisateur même après être touchées), les boutons qui apparaissent dans les volets des actions suggérées disparaissent une fois que l’utilisateur effectue une sélection. Pour plus d’informations, consultez Ajouter des actions suggérées aux messages.

Ressources supplémentaires