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

2025-05-10

ボットは、Activity 種類 メッセージ のオブジェクトを送信してユーザーに情報を伝達し、同様に、ユーザーからメッセージ アクティビティを受信します。一部のメッセージは単にプレーンテキストで構成される場合もあれば、推奨されるアクション、メディア添付ファイル、リッチカード、チャネル固有のデータなどの豊富なコンテンツが含まれる場合があります。この記事では、一般的に使用されるメッセージプロパティの一部について説明します。

メッセージのテキストと書式設定

メッセージテキストは、プレーン、markdown、または xmlを使用して書式設定できます。 textFormat プロパティの既定の書式は markdown であり、Markdown 書式設定標準を使用してテキストを解釈します。テキスト形式のサポートレベルはチャネルによって異なります。

ヒント

各チャネルでサポートされている機能については、チャネルのリファレンス記事を参照してください。

textFormat オブジェクトのプロパティを使用して、テキストの形式を指定できます。たとえば、プレーンテキストのみを含む基本的なメッセージを作成するには、textFormat オブジェクトの Activity プロパティをプレーンに設定し、text プロパティをメッセージの内容に設定し、locale プロパティを送信者のロケールに設定します。

添付ファイル

attachments オブジェクトのプロパティを使用すると、簡単なメディア添付ファイル (画像、オーディオ、ビデオ、ファイル) やリッチカードを送信できます。詳細については、「メッセージにメディア添付ファイルを追加する」および「リッチカードをメッセージに追加する」を参照してください。

エンティティ

entities オブジェクトのプロパティは、チャネルとボットの間で共通のコンテキストメタデータを交換できるようにする、オープンエンドの schema.org オブジェクトの配列です。

エンティティを言及する

多くのチャネルでは、ボットまたはユーザーが会話のコンテキスト内で誰かを "メンション" する機能がサポートされています。メッセージ内のユーザーにメンションするには、メッセージの entities プロパティに Mention オブジェクトを設定します。

エンティティを配置する

メッセージ内で場所に関連する情報を伝達するには、メッセージの entities プロパティにオブジェクトを設定します。

チャネルデータ

channelData オブジェクトのプロパティを使用して、チャネル固有の機能を実装できます。詳細については、「チャネル固有の機能を実装する」を参照してください。

推奨されるアクション

suggestedActions オブジェクトのプロパティを使用すると、ユーザーがタップして入力を提供できるボタンを表示できます。リッチカード内に表示されるボタン (タップされた後もユーザーが表示およびアクセス可能な状態のまま) とは異なり、ユーザーが選択を行った後に、推奨される操作ウィンドウ内に表示されるボタンは表示されなくなります。詳細については、「メッセージに推奨されるアクションを追加する」を参照してください。