Bot Connector API を使用してメッセージを作成するCreate messages with the Bot Connector API

ボットは、message 型の Activity オブジェクトを送信してユーザーに情報を伝達し、同様にユーザーからのメッセージ アクティビティも受信します。Your bot will send Activity objects of type message to communicate information to users, and likewise, will also receive message activities from users. プレーン テキストだけで構成されているシンプルなメッセージもあれば、読み上げテキスト推奨されるアクションメディアの添付ファイルリッチ カードチャネル固有のデータなど、よりリッチなコンテンツを含むメッセージもあります。Some messages may simply consist of plain text, while others may contain richer content such as text to be spoken, suggested actions, media attachments, rich cards, and channel-specific data. この記事では、一般的に使用されるメッセージ プロパティの一部について説明します。This article describes some of the commonly-used message properties.

メッセージ テキストと書式設定Message text and formatting

メッセージ テキストは plainmarkdown、または xml を使用して書式設定できます。Message text can be formatted using plain, markdown, or xml. textFormat プロパティの既定の書式設定は markdown で、Markdown 書式設定標準を使用してテキストを解釈します。The default format for the textFormat property is markdown and interprets text using Markdown formatting standards. テキスト書式のサポートのレベルは、チャネルによって異なります。The level of text format support varies across channels.

ヒント

各チャネルでサポートされる機能を記載した表については、チャネルのリファレンス記事を参照してください。For tables describing which features are supported on each channel, see the channels reference article.

Activity オブジェクトの textFormat プロパティを使用して、テキストの書式を指定することができます。The textFormat property of the Activity object can be used to specify the format of the text. たとえば、プレーン テキストのみを含む基本的なメッセージを作成するには、Activity オブジェクトの textFormat プロパティを plain に設定し、text プロパティをメッセージの内容に設定し、locale プロパティを送信者のロケールに設定します。For example, to create a basic message that contains only plain text, set the textFormat property of the Activity object to plain, set the text property to the contents of the message and set the locale property to the locale of the sender.

[Attachments]Attachments

Activity オブジェクトの attachments プロパティは、単純なメディア添付ファイル (画像、オーディオ、ビデオ、ファイル) やリッチ カードの送信に使用できます。The attachments property of the Activity object can be used to send simple media attachments (image, audio, video, file) and rich cards. 詳細については、「メッセージへのメディア添付ファイルの追加」および「メッセージへのリッチ カードの追加」を参照してください。For details, see Add media attachments to messages and Add rich cards to messages.

エンティティEntities

Activity オブジェクトの entities プロパティは、拡張可能な schema.org オブジェクトの配列であり、チャネルとボットの間で共通のコンテキスト メタデータを交換するために使用します。The entities property of the Activity object is an array of open-ended schema.org objects that allows the exchange of common contextual metadata between the channel and bot.

メンション エンティティMention entities

多くのチャネルは、ボットまたはユーザーが会話のコンテキスト内で誰かを "メンション" する能力をサポートしています。Many channels support the ability for a bot or user to "mention" someone within the context of a conversation. メッセージでユーザーをメンションするには、メッセージの entities プロパティに Mention オブジェクトを設定します。To mention a user in a message, populate the message's entities property with a Mention object.

場所エンティティPlace entities

メッセージ内で場所に関連した情報を伝達するには、メッセージの entities プロパティに Place オブジェクトを設定します。To convey location-related information within a message, populate the message's entities property with Place object.

チャネル データChannel data

Activity オブジェクトの channelData プロパティは、チャネル固有の機能を実装するために使用できます。The channelData property of the Activity object can be used to implement channel-specific functionality. 詳細については、「チャネル固有の機能の実装」を参照してください。For details, see Implement channel-specific functionality.

テキストを音声に変換するText to speech

Activity オブジェクトの speak プロパティを使用して、音声に対応したチャネルでボットが話すテキストを指定できます。また、Activity オブジェクトの inputHint プロパティを使用して、クライアントのマイクの状態に影響を与えることができます。The speak property of the Activity object can be used to specify the text to be spoken by your bot on a speech-enabled channel and the inputHint property of the Activity object can be used to influence the state of the client's microphone. 詳細については、「メッセージへの音声の追加」および「メッセージへの入力ヒントの追加」を参照してください。For details, see Add speech to messages and Add input hints to messages.

推奨されるアクションSuggested actions

Activity オブジェクトの suggestedActions プロパティは、ユーザーが入力を提供するためにタップできるボタンを表示するために使用できます。The suggestedActions property of the Activity object can be used to present buttons that the user can tap to provide input. (タップされた後でも表示されたままとなり、ユーザーがアクセスできる) リッチ カード内に表示されるボタンとは異なり、推奨される操作ウィンドウ内に表示されるボタンは、ユーザーが選択を行った後は表示されなくなります。Unlike buttons that appear within rich cards (which remain visible and accessible to the user even after being tapped), buttons that appear within the suggested actions pane will disappear after the user makes a selection. 詳細については、「メッセージへの推奨されるアクションの追加」を参照してください。For details, see Add suggested actions to messages.

その他のリソースAdditional resources