Vytváření zpráv pomocí rozhraní API konektoru robota

Robot bude odesílat zprávy typu Aktivita, aby uživatelům předávaly informace, a stejně tak bude od uživatelů přijímat zprávy o aktivitách. Některé zprávy se můžou skládat jednoduše z prostého textu, zatímco jiné můžou obsahovat rozsáhlejší obsah, jako je text, který se má vyslovit, navrhované akce, mediální přílohy, karty s formátováním a data specifická pro kanály. Tento článek popisuje některé běžně používané vlastnosti zprávy.

Text zprávy a formátování

Text zprávy je možné formátovat pomocí formátu prostého kódu, markdownu nebo xml. Výchozí formát textFormat vlastnosti je Markdown a interpretuje text pomocí standardů formátování Markdownu. Úroveň podpory formátu textu se v různých kanálech liší.

Tip

Informace o tom, které funkce jsou podporované v jednotlivých kanálech, najdete v článku s referenčními informacemi o kanálech .

Vlastnost textFormat objektu Activity lze použít k určení formátu textu. Chcete-li například vytvořit základní zprávu, která obsahuje pouze prostý text, nastavte textFormat vlastnost objektu Activity na prostý, nastavte text vlastnost na obsah zprávy a vlastnost nastavte locale na národní prostředí odesílatele.

Přílohy

Vlastnost attachments objektu Activity lze použít k odesílání jednoduchých mediálních příloh (obrázek, zvuk, video, soubor) a formátovaných karet. Podrobnosti najdete v tématech Přidání mediálních příloh do zpráv a Přidání formátových karet do zpráv.

Entity

Vlastnost entities objektu Activity je pole objektů schema.org s otevřeným koncem, které umožňuje výměnu společných kontextových metadat mezi kanálem a robotem.

Zmínka o entitách

Mnoho kanálů podporuje možnost robota nebo uživatele "zmínit" někoho v kontextu konverzace. Pokud chcete ve zprávě zmínit uživatele, naplňte vlastnost zprávy entities objektem Zmínka .

Umístění entit

Pokud chcete sdělit informace o poloze ve zprávě, naplňte vlastnost zprávy entitiesumístěním objektů.

Data kanálu

Vlastnost channelDataobjektu Activity lze použít k implementaci funkcí specifických pro kanál. Podrobnosti najdete v tématu Implementace funkcí specifických pro kanál.

Text na řeč

Vlastnost speak objektu Activity se dá použít k určení textu, který má robot vyslovit v kanálu s podporou řeči, a inputHint vlastnost objektu Activity se dá použít k ovlivnění stavu mikrofonu klienta. Podrobnosti najdete v tématech Přidání řeči do zpráv a Přidání nápovědy ke zprávám.

Navrhované akce

Vlastnost suggestedActions objektu Activity lze použít k zobrazení tlačítek, na která může uživatel klepnout a zadat vstup. Na rozdíl od tlačítek, která se zobrazují na formátovaných kartách (která zůstávají viditelná a přístupná i po klepnutí), tlačítka, která se zobrazí v podokně navrhovaných akcí, zmizí, jakmile uživatel provede výběr. Podrobnosti najdete v tématu Přidání navrhovaných akcí do zpráv.

Další materiály