Skapa meddelanden med BOT Connector-API:et
Din robot skickar aktivitetsobjekt av typen meddelande för att kommunicera information till användare, och på samma sätt tar även emot meddelandeaktiviteter från användare. Vissa meddelanden kan helt enkelt bestå av oformaterad text, medan andra kan innehålla mer omfattande innehåll, till exempel text som ska talas, föreslagna åtgärder, mediebilagor, RTF-kort och kanalspecifika data. I den här artikeln beskrivs några av de vanligaste meddelandeegenskaperna.
Meddelandetext och formatering
Meddelandetext kan formateras med oformaterad text, markdown eller xml. Standardformatet textFormat för egenskapen är markdown och tolkar text med markdown-formateringsstandarder. Stödnivån för textformat varierar mellan olika kanaler.
Tips
Information om vilka funktioner som stöds på varje kanal finns i kanalreferensartikeln .
Egenskapen textFormat för aktivitetsobjektet kan användas för att ange formatet på texten. Om du till exempel vill skapa ett grundläggande meddelande som endast innehåller oformaterad text anger du textFormat egenskapen Activity för objektet till oformaterad, anger text egenskapen till innehållet i meddelandet och anger locale egenskapen till avsändarens språk.
Bilagor
Egenskapen attachments för aktivitetsobjektet kan användas för att skicka enkla mediebilagor (bild, ljud, video, fil) och rich-kort. Mer information finns i Lägga till mediebilagor i meddelanden och Lägga till omfattande kort i meddelanden.
Entiteter
Egenskapen entitiesför aktivitetsobjektet är en matris med öppna schema.org objekt som möjliggör utbyte av vanliga sammanhangsbaserade metadata mellan kanalen och roboten.
Nämna entiteter
Många kanaler stöder möjligheten för en robot eller användare att "nämna" någon inom ramen för en konversation. Om du vill nämna en användare i ett meddelande fyller du i meddelandets entities egenskap med ett Omnämnande-objekt .
Placera entiteter
Om du vill förmedla platsrelaterad information i ett meddelande fyller du i meddelandets entities egenskap med Place-objekt .
Kanaldata
Egenskapen channelDataför aktivitetsobjektet kan användas för att implementera kanalspecifika funktioner. Mer information finns i Implementera kanalspecifika funktioner.
Text till tal
Egenskapen speakför aktivitetsobjektet kan användas för att ange texten som ska talas av roboten på en talaktiverad kanal och inputHint egenskapen Activity för objektet kan användas för att påverka tillståndet för klientens mikrofon. Mer information finns i Lägga till tal i meddelanden och Lägga till indatatips i meddelanden.
Föreslagna åtgärder
Egenskapen suggestedActions för aktivitetsobjektet kan användas för att visa knappar som användaren kan trycka på för att ange indata. Till skillnad från knappar som visas i rich-kort (som förblir synliga och tillgängliga för användaren även efter att ha tryckts på), försvinner knappar som visas i det föreslagna åtgärdsfönstret när användaren gör ett val. Mer information finns i Lägga till föreslagna åtgärder i meddelanden.