API リファレンス-Bot ConnectorAPI reference - Bot Connector

注意

REST API は SDK に相当するものではありません。The REST API is not equivalent to the SDK. REST API は標準の REST 通信を可能にするために提供されていますが、Bot Framework との好ましい対話方法は SDK です。The REST API is provided to allow standard REST communication, however the preferred method of interacting with the Bot Framework is the SDK.

Bot Framework 内で Bot Connector サービスを使用することにより、ボットは、Bot Framework Portal に構成されているチャネルでユーザーとメッセージを交換できます。Within the Bot Framework, the Bot Connector service enables your bot to exchange messages with users on channels that are configured in the Bot Framework Portal. このサービスでは、HTTPS で業界標準の REST および JSON が使用されます。The service uses industry-standard REST and JSON over HTTPS.

ベース URIBase URI

ユーザーがボットにメッセージを送信すると、受信要求には、ボットが応答を送信するエンドポイントを指定する serviceUrl プロパティを持つ Activity オブジェクトが含まれています。When a user sends a message to your bot, the incoming request contains an Activity object with a serviceUrl property that specifies the endpoint to which your bot should send its response. Bot Connector サービスにアクセスするには、serviceUrl 値を API 要求のベース URI として使用します。To access the Bot Connector service, use the serviceUrl value as the base URI for API requests.

たとえば、ユーザーがボットにメッセージを送信したときに、ボットが次のアクティビティを受け取るとします。For example, assume that your bot receives the following activity when the user sends a message to the bot.

{
    "type": "message",
    "id": "bf3cc9a2f5de...",
    "timestamp": "2016-10-19T20:17:52.2891902Z",
    "serviceUrl": "https://smba.trafficmanager.net/apis",
    "channelId": "channel's name/id",
    "from": {
        "id": "1234abcd",
        "name": "user's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
    },
    "recipient": {
        "id": "12345678",
        "name": "bot's name"
    },
    "text": "Haircut on Saturday"
}

ユーザーのメッセージ内の serviceUrl プロパティは、ボットがエンドポイント https://smba.trafficmanager.net/apis に応答を送信することを示します。これは、この会話のコンテキストでボットが発行する後続の要求のベース URI になります。The serviceUrl property within the user's message indicates that the bot should send its response to the endpoint https://smba.trafficmanager.net/apis; this will be the base URI for any subsequent requests that the bot issues in the context of this conversation. ボットがユーザーに事前対応型のメッセージを送信する必要がある場合は、必ず serviceUrl の値を保存してください。If your bot will need to send a proactive message to the user, be sure to save the value of serviceUrl.

次の例は、ユーザーのメッセージに応答するためにボットが発行する要求を示しています。The following example shows the request that the bot issues to respond to the user's message.

POST https://smba.trafficmanager.net/apis/v3/conversations/abcd1234/activities/bf3cc9a2f5de...
Authorization: Bearer eyJhbGciOiJIUzI1Ni...
Content-Type: application/json
{
    "type": "message",
    "from": {
        "id": "12345678",
        "name": "bot's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
    },
   "recipient": {
        "id": "1234abcd",
        "name": "user's name"
    },
    "text": "I have several times available on Saturday!",
    "replyToId": "bf3cc9a2f5de..."
}

ヘッダーHeaders

要求ヘッダーRequest headers

発行するすべての API 要求には、標準の HTTP 要求ヘッダーに加えて、ボットを認証するためのアクセス トークンを指定する Authorization ヘッダーが含まれている必要があります。In addition to the standard HTTP request headers, every API request that you issue must include an Authorization header that specifies an access token to authenticate your bot. Authorization ヘッダーは次の形式を使用して指定します。Specify the Authorization header using this format:

Authorization: Bearer ACCESS_TOKEN

ボットのアクセス トークンを取得する方法の詳細については、「Authenticate requests from your bot to the Bot Connector service」(ボットからの要求を Bot Connector サービスに認証する) を参照してください。For details about how to obtain an access token for your bot, see Authenticate requests from your bot to the Bot Connector service.

応答ヘッダーResponse headers

標準の HTTP 応答ヘッダーに加えて、すべての応答には X-Correlating-OperationId ヘッダーが含まれます。In addition to the standard HTTP response headers, every response will contain an X-Correlating-OperationId header. このヘッダーの値は、要求の詳細を含む Bot Framework のログ エントリに対応する ID です。The value of this header is an ID that corresponds to the Bot Framework log entry which contains details about the request. エラー応答を受け取るたびに、このヘッダーの値をキャプチャしてください。Any time that you receive an error response, you should capture the value of this header. 自力で問題を解決できない場合は、問題を報告するときにサポート チームに提供する情報にこの値を含めてください。If you are not able to independently resolve the issue, include this value in the information that you provide to the Support team when you report the issue.

HTTP 状態コードHTTP status codes

各応答で返される HTTP 状態コード は、対応する要求の結果を示しています。The HTTP status code that is returned with each response indicates the outcome of the corresponding request.

HTTP 状態コードHTTP status code 意味Meaning
200200 要求は成功しました。The request succeeded.
201201 要求は成功しました。The request succeeded.
202202 要求の処理は受理されました。The request has been accepted for processing.
204204 要求は成功しましたが、返されたコンテンツはありませんでした。The request succeeded but no content was returned.
400400 要求の形式その他が正しくありませんでした。The request was malformed or otherwise incorrect.
401401 ボットは要求を行うことが許可されていません。The bot is not authorized to make the request.
403403 要求された操作の実行がボットに許可されていません。The bot is not allowed to perform the requested operation.
404404 要求されたリソースが見つかりませんでした。The requested resource was not found.
405405 このチャネルは、要求された操作をサポートしていません。The channel does not support the requested operation.
500500 内部サーバー エラーが発生しました。An internal server error occurred.
503503 サービスを利用できません。The service is unavailable.

エラーErrors

4xx 範囲または 5xx 範囲の HTTP 状態コードを指定する応答では、エラーの情報を提供する ErrorResponse オブジェクトが応答の本文に含まれます。Any response that specifies an HTTP status code in the 4xx range or 5xx range will include an ErrorResponse object in the body of the response that provides information about the error. 4xx 範囲のエラー応答を受け取った場合、要求を再送信する前に、ErrorResponse オブジェクトを検査してエラーの原因を識別し、問題を解決してください。If you receive an error response in the 4xx range, inspect the ErrorResponse object to identify the cause of the error and resolve your issue prior to resubmitting the request.

会話操作Conversation operations

これらの操作を使用して、会話を作成し、メッセージ (アクティビティ) を送信し、会話の内容を管理します。Use these operations to create conversations, send messages (activities), and manage the contents of conversations.

OperationOperation 説明Description
会話を作成するCreate Conversation 新しい会話を作成します。Creates a new conversation.
削除アクティビティDelete Activity 既存のアクティビティを削除します。Deletes an existing activity.
会話のメンバーを削除するDelete Conversation Member 会話からメンバーを削除します。Removes a member from a conversation.
アクティビティのメンバーを取得するGet Activity Members 指定された会話内の指定されたアクティビティのメンバーを取得します。Gets the members of the specified activity within the specified conversation.
会話のメンバーを取得するGet Conversation Member 会話のメンバーに関する詳細を取得します。Gets details about a member of a conversation.
会話のメンバーを取得するGet Conversation Members 指定された会話のメンバーを取得します。Gets the members of the specified conversation.
会話のページングされたメンバーを取得するGet Conversation Paged Members 指定された会話のメンバーを一度に 1 ページずつ取得します。Gets the members of the specified conversation one page at a time.
会話を取得するGet Conversations ボットが参加した会話のリストを取得します。Gets a list of conversations the bot has participated in.
アクティビティに返信するReply to Activity 指定されたアクティビティへの返信として、指定された会話にアクティビティ (メッセージ) を送信します。Sends an activity (message) to the specified conversation, as a reply to the specified activity.
会話履歴を送信するSend Conversation History 過去のアクティビティのトランスクリプトを会話にアップロードします。Uploads a transcript of past activities to the conversation.
会話に送信するSend to Conversation 指定された会話の最後にアクティビティ (メッセージ) を送信します。Sends an activity (message) to the end of the specified conversation.
アクティビティを更新するUpdate Activity 既存のアクティビティを更新します。Updates an existing activity.
添付ファイルをチャネルにアップロードするUpload Attachment to Channel 添付ファイルをチャネルの BLOB ストレージに直接アップロードします。Uploads an attachment directly into a channel's blob storage.

会話を作成するCreate Conversation

新しい会話を作成します。Creates a new conversation.

POST /v3/conversations
要求本文Request body ConversationParameters オブジェクトA ConversationParameters object
戻り値Returns ConversationResourceResponse オブジェクトA ConversationResourceResponse object

アクティビティを削除するDelete Activity

一部のチャネルでは、既存のアクティビティを削除できます。Some channels allow you to delete an existing activity. 成功すると、この操作は指定されたアクティビティを指定された会話から削除します。If successful, this operation removes the specified activity from the specified conversation.

DELETE /v3/conversations/{conversationId}/activities/{activityId}
要求本文Request body 該当なしn/a
戻り値Returns 操作の結果を示す HTTP 状態コード。An HTTP Status code that indicates the outcome of the operation. 応答の本文では何も指定されません。Nothing is specified in the body of the response.

会話のメンバーを削除するDelete Conversation Member

会話からメンバーを削除します。Removes a member from a conversation. そのメンバーが会話の最後のメンバーだった場合は、会話も削除されます。If that member was the last member of the conversation, the conversation will also be deleted.

DELETE /v3/conversations/{conversationId}/members/{memberId}
要求本文Request body 該当なしn/a
戻り値Returns 操作の結果を示す HTTP 状態コード。An HTTP Status code that indicates the outcome of the operation. 応答の本文では何も指定されません。Nothing is specified in the body of the response.

アクティビティのメンバーを取得するGet Activity Members

指定された会話内の指定されたアクティビティのメンバーを取得します。Gets the members of the specified activity within the specified conversation.

GET /v3/conversations/{conversationId}/activities/{activityId}/members
要求本文Request body 該当なしn/a
戻り値Returns ChannelAccount オブジェクトの配列An array of ChannelAccount objects

会話を取得するGet Conversations

ボットが参加した会話のリストを取得します。Gets a list of conversations the bot has participated in.

GET /v3/conversations?continuationToken={continuationToken}
要求本文Request body 該当なしn/a
戻り値Returns ConversationsResult オブジェクトA ConversationsResult object

会話のメンバーを取得するGet Conversation Member

特定の会話の特定のメンバーに関する詳細を取得します。Gets details about a specific member of a specific conversation.

GET /v3/conversations/{conversationId}/members/{memberId}
要求本文Request body 該当なしn/a
戻り値Returns メンバーの ChannelAccount オブジェクト。A ChannelAccount object for the member.

会話のメンバーを取得するGet Conversation Members

指定された会話のメンバーを取得します。Gets the members of the specified conversation.

GET /v3/conversations/{conversationId}/members
要求本文Request body 該当なしn/a
戻り値Returns 会話のメンバーの ChannelAccount オブジェクトの配列。An array of ChannelAccount objects for the members of the conversation.

会話のページングされたメンバーを取得するGet Conversation Paged Members

指定された会話のメンバーを一度に 1 ページずつ取得します。Gets the members of the specified conversation one page at a time.

GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={continuationToken}
要求本文Request body 該当なしn/a
戻り値Returns PagedMembersResult オブジェクトA PagedMembersResult object

アクティビティに返信するReply to Activity

指定されたアクティビティへの返信として、指定された会話にアクティビティ (メッセージ) を送信します。Sends an activity (message) to the specified conversation, as a reply to the specified activity. チャネルがサポートしている場合、アクティビティは別のアクティビティへの返信として追加されます。The activity will be added as a reply to another activity, if the channel supports it. ネストした応答をチャネルがサポートしていない場合、この操作は会話に送信すると同様に動作します。If the channel does not support nested replies, then this operation behaves like Send to Conversation.

POST /v3/conversations/{conversationId}/activities/{activityId}
要求本文Request body Activity オブジェクトAn Activity object
戻り値Returns ResourceResponse オブジェクトA ResourceResponse object

会話履歴を送信するSend Conversation History

クライアントが過去のアクティビティのトランスクリプトをレンダリングできるように、それらを会話にアップロードします。Uploads a transcript of past activities to the conversation so that the client can render them.

POST /v3/conversations/{conversationId}/activities/history
要求本文Request body Transcript オブジェクト。A Transcript object.
戻り値Returns ResourceResponse オブジェクト。A ResourceResponse object.

会話に送信するSend to Conversation

指定された会話にアクティビティ (メッセージ) を送信します。Sends an activity (message) to the specified conversation. アクティビティは、タイムスタンプまたはチャネルのセマンティクスに従って会話の最後に追加されます。The activity will be appended to the end of the conversation according to the timestamp or semantics of the channel. 会話内の特定のメッセージに返信するには、代わりにアクティビティに返信するを使用します。To reply to a specific message within the conversation, use Reply to Activity instead.

POST /v3/conversations/{conversationId}/activities
要求本文Request body Activity オブジェクトAn Activity object
戻り値Returns ResourceResponse オブジェクトA ResourceResponse object

アクティビティを更新するUpdate Activity

一部のチャネルでは、既存のアクティビティを編集してボットの会話の新しい状態を反映させることができます。Some channels allow you to edit an existing activity to reflect the new state of a bot conversation. たとえば、いずれかのボタンをユーザーがクリックした後、会話内のメッセージからボタンを削除することができます。For example, you might remove buttons from a message in the conversation after the user has clicked one of the buttons. 成功すると、この操作は指定された会話内の指定されたアクティビティを更新します。If successful, this operation updates the specified activity within the specified conversation.

PUT /v3/conversations/{conversationId}/activities/{activityId}
要求本文Request body Activity オブジェクトAn Activity object
戻り値Returns ResourceResponse オブジェクトA ResourceResponse object

添付ファイルをチャネルにアップロードUpload Attachment to Channel

指定された会話の添付ファイルをチャネルの BLOB ストレージに直接アップロードします。Uploads an attachment for the specified conversation directly into a channel's blob storage. これにより、準拠したストアにデータを保存できます。This enables you to store data in a compliant store.

POST /v3/conversations/{conversationId}/attachments
要求本文Request body AttachmentData オブジェクト。An AttachmentData object.
戻り値Returns ResourceResponse オブジェクト。A ResourceResponse object. id プロパティは、添付ファイル情報を取得する操作と添付ファイルを取得する操作で使用できる添付ファイル ID を指定します。The id property specifies the attachment ID that can be used with the Get Attachment Info operation and the Get Attachment operation.

添付ファイル操作Attachment operations

これらの操作を使用して、添付ファイルの情報とファイル自体のバイナリ データを取得します。Use these operations to retrieve information about an attachment as well the binary data for the file itself.

OperationOperation 説明Description
添付ファイル情報を取得するGet Attachment Info ファイル名、ファイルの種類、使用可能なビュー (例: オリジナルまたはサムネイル) など、指定された添付ファイルの情報を取得します。Gets information about the specified attachment, including file name, file type, and the available views (e.g. original or thumbnail).
添付ファイルを取得するGet Attachment 指定された添付ファイルの指定されたビューをバイナリ コンテンツとして取得します。Gets the specified view of the specified attachment as binary content.

添付ファイル情報を取得するGet Attachment Info

ファイル名、種類、使用可能なビュー (例: オリジナルまたはサムネイル) など、指定された添付ファイルの情報を取得します。Gets information about the specified attachment, including file name, type, and the available views (e.g. original or thumbnail).

GET /v3/attachments/{attachmentId}
要求本文Request body 該当なしn/a
戻り値Returns AttachmentInfo オブジェクトAn AttachmentInfo object

添付ファイルを取得するGet Attachment

指定された添付ファイルの指定されたビューをバイナリ コンテンツとして取得します。Gets the specified view of the specified attachment as binary content.

GET /v3/attachments/{attachmentId}/views/{viewId}
要求本文Request body 該当なしn/a
戻り値Returns 指定された添付ファイルの指定されたビューを表すバイナリ コンテンツBinary content that represents the specified view of the specified attachment

状態操作 (非推奨)State operations (deprecated)

Microsoft Bot Framework State サービスは 2018 年 3 月 30 日時点で廃止されています。The Microsoft Bot Framework State service is retired as of March 30, 2018. 以前は、Azure Bot Service または Bot Builder SDK で構築されたボットには、ボットの状態データを格納するために Microsoft によってホストされたこのサービスへの既定の接続がありました。Previously, bots built on the Azure Bot Service or the Bot Builder SDK had a default connection to this service hosted by Microsoft to store bot state data. ボットは、独自の状態ストレージを使用するように更新する必要があります。Bots will need to be updated to use their own state storage.

OperationOperation 説明Description
Set User Data チャネルの特定のユーザーの状態データを保存します。Stores state data for a specific user on a channel.
Set Conversation Data チャネルの特定の会話の状態データを保存します。Stores state data for a specific conversation on a channel.
Set Private Conversation Data チャネルの特定の会話のコンテキスト内で特定のユーザーの状態データを保存します。Stores state data for a specific user within the context of a specific conversation on a channel.
Get User Data チャネルのすべての会話で以前に保存した特定のユーザーの状態データを取得します。Retrieves state data that has previously been stored for a specific user across all conversations on a channel.
Get Conversation Data チャネルの特定の会話で以前に保存した状態データを取得します。Retrieves state data that has previously been stored for a specific conversation on a channel.
Get Private Conversation Data チャネルの特定の会話のコンテキスト内で以前に保存した特定のユーザーの状態データを取得します。Retrieves state data that has previously been stored for a specific user within the context of a specific conversation on a channel.
Delete State For User ユーザーのために以前に格納された状態データを削除します。Deletes state data that has previously been stored for a user.

スキーマSchema

Bot Framework スキーマには、ボットがユーザーとの通信に使用できるオブジェクトとそれらのプロパティが定義されています。The Bot Framework schema defines the objects and their properties that your bot can use to communicate with a user.

ObjectObject 説明Description
Activity オブジェクトActivity object ボットとユーザーの間で交換されるメッセージを定義します。Defines a message that is exchanged between bot and user.
AnimationCard オブジェクトAnimationCard object アニメーション GIF または短いビデオを再生できるカードを定義します。Defines a card that can play animated GIFs or short videos.
Attachment オブジェクトAttachment object メッセージに含める追加の情報を定義します。Defines additional information to include in the message. メディア ファイル (例: オーディオ、ビデオ、画像、ファイル) またはリッチ カードを添付ファイルにすることができます。An attachment may be a media file (e.g. audio, video, image, file) or a rich card.
AttachmentData オブジェクトAttachmentData object 添付ファイルのデータについて説明します。Describes an attachment data.
AttachmentInfo オブジェクトAttachmentInfo object 添付ファイルについて説明します。Describes an attachment.
AttachmentView オブジェクトAttachmentView object 添付ファイルのビューを定義します。Defines a attachment view.
AudioCard オブジェクトAudioCard object オーディオ ファイルを再生できるカードを定義します。Defines a card that can play an audio file.
CardAction オブジェクトCardAction object 実行するアクションを定義します。Defines an action to perform.
CardImage オブジェクトCardImage object カードに表示する画像を定義します。Defines an image to display on a card.
ChannelAccount オブジェクトChannelAccount object チャネルのボットまたはユーザー アカウントを定義します。Defines a bot or user account on the channel.
ConversationAccount オブジェクトConversationAccount object チャネルでの会話を定義します。Defines a conversation in a channel.
ConversationMembers オブジェクトConversationMembers object 会話のメンバーを取得します。Defines the members of a conversation.
ConversationParameters オブジェクトConversationParameters object 新しい会話を作成するためのパラメーターを定義しますDefine parameters for creating a new conversation
ConversationReference オブジェクトConversationReference object 会話内の特定のポイントを定義します。Defines a particular point in a conversation.
ConversationResourceResponse オブジェクトConversationResourceResponse object 会話を作成するへの応答を定義します。Defines a response to Create Conversation.
ConversationsResult オブジェクトConversationsResult object 会話を取得するの呼び出し結果を定義します。Defines the result of a call to Get Conversations.
Entity オブジェクトEntity object エンティティ オブジェクトを定義します。Defines an entity object.
Error オブジェクトError object エラーを定義します。Defines an error.
ErrorResponse オブジェクトErrorResponse object HTTP API 応答を定義します。Defines an HTTP API response.
Fact オブジェクトFact object ファクトを含むキーと値のペアを定義します。Defines a key-value pair that contains a fact.
GeoCoordinates オブジェクトGeoCoordinates object World Geodetic System (WSG84) 座標を使用して地理的な場所を定義します。Defines a geographical location using World Geodetic System (WSG84) coordinates.
HeroCard オブジェクトHeroCard object 大きい画像、タイトル、テキスト、アクションの各ボタンを持つカードを定義します。Defines a card with a large image, title, text, and action buttons.
InnerHttpError オブジェクトInnerHttpError object 内部 HTTP エラーを示すオブジェクト。Object representing an inner HTTP error.
MediaEventValue オブジェクトMediaEventValue object メディア イベントの補助パラメーター。Supplementary parameter for media events.
MediaUrl オブジェクトMediaUrl object メディア ファイルのソース URL を定義します。Defines the URL to a media file's source.
Mention オブジェクトMention object 会話でメンションされたユーザーまたはボットを定義します。Defines a user or bot that was mentioned in the conversation.
MessageReaction オブジェクトMessageReaction object メッセージへの反応を定義します。Defines a reaction to a message.
PagedMembersResult オブジェクトPagedMembersResult object 会話のページングされたメンバーを取得するによって返されるメンバーのページ。Page of members returned by Get Conversation Paged Members.
Place オブジェクトPlace object 会話でメンションされた場所を定義します。Defines a place that was mentioned in the conversation.
ReceiptCard オブジェクトReceiptCard object 購入のレシートを含むカードを定義します。Defines a card that contains a receipt for a purchase.
ReceiptItem オブジェクトReceiptItem object レシート内の品目を定義します。Defines a line item within a receipt.
ResourceResponse オブジェクトResourceResponse object リソースを定義します。Defines a resource.
SemanticAction オブジェクトSemanticAction object プログラムによるアクションへの参照を定義します。Defines a reference to a programmatic action.
SignInCard オブジェクトSignInCard object ユーザーがサービスにサインインできるようにするカードを定義します。Defines a card that lets a user sign in to a service.
SuggestedActions オブジェクトSuggestedActions object ユーザーが選択できるオプションを定義します。Defines the options from which a user can choose.
TextHighlight オブジェクトTextHighlight object 別のフィールド内のコンテンツの部分文字列を参照します。Refers to a substring of content within another field.
ThumbnailCard オブジェクトThumbnailCard object サムネイル画像、タイトル、テキスト、アクションの各ボタンを持つカードを定義します。Defines a card with a thumbnail image, title, text, and action buttons.
ThumbnailUrl オブジェクトThumbnailUrl object 画像のソース URL を定義します。Defines the URL to an image's source.
Transcript オブジェクトTranscript object 会話履歴を送信するを使用してアップロードされるアクティビティのコレクション。A collection of activities to be uploaded using Send Conversation History.
VideoCard オブジェクトVideoCard object ビデオを再生できるカードを定義します。Defines a card that can play videos.

Activity オブジェクトActivity object

ボットとユーザーの間で交換されるメッセージを定義します。Defines a message that is exchanged between bot and user.

プロパティProperty TypeType 説明Description
actionaction stringstring 適用する、または適用されたアクション。The action to apply or that was applied. アクションのコンテキストを決定するには、type プロパティを使用します。Use the type property to determine context for the action. たとえば、typecontactRelationUpdate の場合、action プロパティの値は、ユーザーがボットを連絡先リストに追加した場合は add になり、ユーザーがボットを連絡先リストから削除した場合は remove になります。For example, if type is contactRelationUpdate, the value of the action property would be add if the user added your bot to their contacts list, or remove if they removed your bot from their contacts list.
attachmentLayoutattachmentLayout stringstring メッセージに含まれるリッチ カード添付ファイルのレイアウト。Layout of the rich card attachments that the message includes. 次の値のいずれか: carousellistOne of these values: carousel, list. リッチ カード添付ファイルの詳細については、「メッセージへのリッチ カード添付ファイルの追加」を参照してください。For more information about rich card attachments, see Add rich card attachments to messages.
attachmentsattachments Attachment[]Attachment[] メッセージに含める追加の情報を定義する Attachment オブジェクトの配列。Array of Attachment objects that defines additional information to include in the message. 各添付ファイルは、ファイル (例: オーディオ、ビデオ、画像) またはリッチ カードのどちらかにすることができます。Each attachment may be either a file (e.g. audio, video, image) or a rich card.
callerIdcallerId stringstring ボットの呼び出し元を識別する IRI を含む文字列。A string containing an IRI identifying the caller of a bot. このフィールドは、ネットワーク経由で送信されるものではありません。その代わりに、呼び出し元 (トークンなど) の ID をアサートする暗号的に検証可能なデータに基づいて、ボットとクライアントによって設定されます。This field is not intended to be transmitted over the wire, but is instead populated by bots and clients based on cryptographically verifiable data that asserts the identity of the callers (e.g. tokens).
channelDatachannelData objectobject チャネル固有のコンテンツを格納するオブジェクト。An object that contains channel-specific content. 一部のチャネルには、添付ファイル スキーマでは表現できない追加情報を必要とする機能があります。Some channels provide features that require additional information that cannot be represented using the attachment schema. そのような場合は、このプロパティを、チャネルのドキュメントで定義されているチャネル固有のコンテンツに設定します。For those cases, set this property to the channel-specific content as defined in the channel's documentation. 詳細については、「チャネル固有の機能の実装」を参照してください。For more information, see Implement channel-specific functionality.
channelIdchannelId stringstring チャネルを一意に識別する ID。An ID that uniquely identifies the channel. チャネルによって設定されます。Set by the channel.
codecode stringstring 会話が終了した理由を示すコード。Code indicating why the conversation has ended.
conversationconversation ConversationAccountConversationAccount アクティビティが属する会話を定義する ConversationAccount オブジェクト。A ConversationAccount object that defines the conversation to which the activity belongs.
deliveryModedeliveryMode stringstring アクティビティの受信者の代替配信パスに通知する配信ヒント。A delivery hint to signal to the recipient alternate delivery paths for the activity. 値は、normalnotification のいずれかです。One of these values: normal, notification.
entitiesentities object[]object[] メッセージでメンションされたエンティティを表すオブジェクトの配列。Array of objects that represents the entities that were mentioned in the message. この配列内のオブジェクトは任意の Schema.org オブジェクトです。Objects in this array may be any Schema.org object. たとえば、会話でメンションされた人物を識別する Mention オブジェクトや、会話でメンションされた場所を識別する Place オブジェクトを配列に含めることができます。For example, the array may include Mention objects that identify someone who was mentioned in the conversation and Place objects that identify a place that was mentioned in the conversation.
expirationexpiration stringstring アクティビティを "期限切れ" と見なす時刻です。これは受信者に表示すべきではありません。The time at which the activity should be considered to be "expired" and should not be presented to the recipient.
fromfrom ChannelAccountChannelAccount メッセージの送信者を指定する ChannelAccount オブジェクト。A ChannelAccount object that specifies the sender of the message.
historyDisclosedhistoryDisclosed booleanboolean 履歴が公開されているかどうかを示すフラグ。Flag that indicates whether or not history is disclosed. 既定値は false です。Default value is false.
idid stringstring チャネルでのアクティビティを一意に識別する ID。ID that uniquely identifies the activity on the channel.
importanceimportance stringstring アクティビティの重要度を定義します。Defines the importance of an Activity. 次の値のいずれか: lownormalhighOne of these values: low, normal, high.
inputHintinputHint stringstring メッセージがクライアントに配信された後、ボットがユーザー入力を受け付けるか、期待するか、または無視するかを示す値。Value that indicates whether your bot is accepting, expecting, or ignoring user input after the message is delivered to the client. 次の値のいずれか: acceptingInputexpectingInputignoringInputOne of these values: acceptingInput, expectingInput, ignoringInput.
labellabel stringstring アクティビティの説明ラベル。A descriptive label for the activity.
listenForlistenFor string[]string[] 音声および言語の認識システムで聞き取る必要がある語句と参照の一覧。List of phrases and references that speech and language priming systems should listen for.
localelocale stringstring メッセージ内のテキストの表示に使用する言語のロケールで、<language>-<country> の形式。Locale of the language that should be used to display text within the message, in the format <language>-<country>. ボットがその言語の表示文字列を指定できるよう、チャネルはこのプロパティを使用してユーザーの言語を指示します。The channel uses this property to indicate the user's language, so that your bot may specify display strings in that language. 既定値は en-US です。Default value is en-US.
localTimestamplocalTimestamp stringstring ローカル タイム ゾーンでメッセージが送信された日時を ISO-8601 形式で表したもの。Date and time that the message was sent in the local time zone, expressed in ISO-8601 format.
localTimezonelocalTimezone stringstring IANA タイム ゾーン データベース形式で表される、メッセージのローカル タイムゾーンの名前が格納されます。Contains the name of the local timezone of the message, expressed in IANA Time Zone database format. 例: America/Los_Angeles。For example, America/Los_Angeles.
membersAddedmembersAdded ChannelAccount[]ChannelAccount[] 会話に参加したユーザーのリストを表す ChannelAccount オブジェクトの配列。Array of ChannelAccount objects that represents the list of users that joined the conversation. アクティビティの type が "conversationUpdate" で、ユーザーが会話に参加した場合にのみ存在します。Present only if activity type is "conversationUpdate" and users joined the conversation.
membersRemovedmembersRemoved ChannelAccount[]ChannelAccount[] 会話から退出したユーザーのリストを表す ChannelAccount オブジェクトの配列。Array of ChannelAccount objects that represents the list of users that left the conversation. アクティビティの type が "conversationUpdate" で、ユーザーが会話から退出した場合にのみ存在します。Present only if activity type is "conversationUpdate" and users left the conversation.
namename stringstring 呼び出す操作の名前またはイベントの名前。Name of the operation to invoke or the name of the event.
reactionsAddedreactionsAdded MessageReaction[]MessageReaction[] 会話に追加された反応のコレクション。The collection of reactions added to the conversation.
reactionsRemovedreactionsRemoved MessageReaction[]MessageReaction[] 会話から削除された反応のコレクション。The collection of reactions removed from the conversation.
recipientrecipient ChannelAccountChannelAccount メッセージの受信者を指定する ChannelAccount オブジェクト。A ChannelAccount object that specifies the recipient of the message.
relatesTorelatesTo ConversationReferenceConversationReference 会話内の特定のポイントを定義する ConversationReference オブジェクト。A ConversationReference object that defines a particular point in a conversation.
replyToIdreplyToId stringstring このメッセージの返信先メッセージの ID。The ID of the message to which this message replies. ユーザーが送信したメッセージに返信するには、このプロパティをユーザーのメッセージの ID に設定します。To reply to a message that the user sent, set this property to the ID of the user's message. すべてのチャネルがスレッド返信をサポートするわけではありません。Not all channels support threaded replies. このような場合、チャネルはこのプロパティを無視し、時間順のセマンティクス (タイムスタンプ) を使用してメッセージを会話に追加します。In these cases, the channel will ignore this property and use time ordered semantics (timestamp) to append the message to the conversation.
semanticActionsemanticAction SemanticActionSemanticAction プログラムによるアクションへの参照を表す SemanticAction オブジェクト。A SemanticAction object that represents a reference to a programmatic action.
serviceUrlserviceUrl stringstring チャネルのサービス エンドポイントを指定する URL。URL that specifies the channel's service endpoint. チャネルによって設定されます。Set by the channel.
speakspeak stringstring 音声対応チャネルでボットが話すテキスト。Text to be spoken by your bot on a speech-enabled channel. 音声、速度、音量、発音、ピッチなど、ボットの音声のさまざまな特性を制御するには、音声合成マークアップ言語 (SSML) 形式でこのプロパティを指定します。To control various characteristics of your bot's speech such as voice, rate, volume, pronunciation, and pitch, specify this property in Speech Synthesis Markup Language (SSML) format.
suggestedActionssuggestedActions SuggestedActionsSuggestedActions ユーザーが選択できるオプションを定義する SuggestedActions オブジェクト。A SuggestedActions object that defines the options from which the user can choose.
summarysummary stringstring メッセージに含まれる情報の要約。Summary of the information that the message contains. たとえば、電子メール チャネルで送信されるメッセージの場合、このプロパティで電子メール メッセージの最初の 50 文字を指定できます。For example, for a message that is sent on an email channel, this property may specify the first 50 characters of the email message.
texttext stringstring ユーザーからボットに、またはボットからユーザーに送信されるメッセージのテキスト。Text of the message that is sent from user to bot or bot to user. このプロパティの内容に課される制限については、チャネルのドキュメントを参照してください。See the channel's documentation for limits imposed upon the contents of this property.
textFormattextFormat stringstring メッセージの text の形式。Format of the message's text. 次の値のいずれか: markdownplainxmlOne of these values: markdown, plain, xml. テキスト形式の詳細については、「Create messages」(メッセージの作成) を参照してください。For details about text format, see Create messages.
textHighlightstextHighlights TextHighlight[]TextHighlight[] アクティビティに replyToId 値が含まれている場合に、強調表示するテキスト フラグメントのコレクション。The collection of text fragments to highlight when the activity contains a replyToId value.
timestamptimestamp stringstring UTC タイム ゾーンでメッセージが送信された日時を ISO-8601 形式で表したもの。Date and time that the message was sent in the UTC time zone, expressed in ISO-8601 format.
topicNametopicName stringstring アクティビティが属する会話のトピック。Topic of the conversation to which the activity belongs.
typetype stringstring アクティビティの種類。Type of activity. 次のいずれかの値: messagecontactRelationUpdateconversationUpdatetypingendOfConversationeventinvokedeleteUserDatamessageUpdatemessageDeleteinstallationUpdatemessageReactionsuggestiontracehandoffOne of these values: message, contactRelationUpdate, conversationUpdate, typing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff. アクティビティの種類の詳細については、「Activities overview」(アクティビティの概要) を参照してください。For details about activity types, see Activities overview.
valuevalue objectobject 拡張可能な値。Open-ended value.
valueTypevalueType stringstring アクティビティの値オブジェクトの型。The type of the activity's value object.

スキーマの表に戻るBack to Schema table

AnimationCard オブジェクトAnimationCard object

アニメーション GIF または短いビデオを再生できるカードを定義します。Defines a card that can play animated GIFs or short videos.

プロパティProperty TypeType 説明Description
aspectaspect booleanboolean サムネイル/メディア プレースホルダーの縦横比。Aspect ratio of thumbnail/media placeholder. 使用できる値は "16:9" と "4:3" です。Allowed values are "16:9" and "4:3".
autoloopautoloop booleanboolean 最後の項目が終了したときにアニメーション GIF のリストをリプレイするかどうかを示すフラグ。Flag that indicates whether to replay the list of animated GIFs when the last one ends. アニメーションを自動的にリプレイするには、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true to automatically replay the animation; otherwise, false. 既定値は true です。The default value is true.
autostartautostart booleanboolean カードが表示されたときにアニメーションを自動的に再生するかどうかを示すフラグ。Flag that indicates whether to automatically play the animation when the card is displayed. アニメーションを自動的に再生するには、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true to automatically play the animation; otherwise, false. 既定値は true です。The default value is true.
buttonsbuttons CardAction[]CardAction[] ユーザーが 1 つ以上のアクションを実行できるようにする CardAction オブジェクトの配列。Array of CardAction objects that enable the user to perform one or more actions. 指定できるボタンの数はチャネルが決定します。The channel determines the number of buttons that you may specify.
durationduration stringstring メディア コンテンツの長さ (ISO 8601 の期間の形式)。The length of the media content, in ISO 8601 duration format.
imageimage ThumbnailUrlThumbnailUrl カードに表示する画像を指定する ThumbnailUrl オブジェクト。A ThumbnailUrl object that specifies the image to display on the card.
mediamedia MediaUrl[]MediaUrl[] Mediaurl オブジェクトの配列。Array of MediaUrl objects. このフィールドに複数の URL が含まれている場合、各 URL は同じコンテンツの代替形式です。When this field contains more than one URL, each URL is an alternative format of the same content.
shareableshareable booleanboolean アニメーションを他のユーザーと共有できるかどうかを示すフラグ。Flag that indicates whether the animation may be shared with others. アニメーションを共有できる場合、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true if the animation may be shared; otherwise, false. 既定値は true です。The default value is true.
subtitlesubtitle stringstring カードのタイトルの下に表示するサブタイトル。Subtitle to display under the card's title.
texttext stringstring カードのタイトルまたはサブタイトルの下に表示する説明またはプロンプト。Description or prompt to display under the card's title or subtitle.
titletitle stringstring カードのタイトル。Title of the card.
valuevalue objectobject このカードの補助パラメーター。Supplementary parameter for this card.

スキーマの表に戻るBack to Schema table

Attachment オブジェクトAttachment object

メッセージに含める追加の情報を定義します。Defines additional information to include in the message. ファイル (画像、オーディオ、ビデオなど) またはリッチ カードを添付ファイルにすることができます。An attachment may be a file (such as an image, audio, or video) or a rich card.

プロパティProperty TypeType 説明Description
contentcontent objectobject 添付ファイルのコンテンツ。The content of the attachment. 添付ファイルがリッチ カードの場合、このプロパティをリッチ カード オブジェクトに設定します。If the attachment is a rich card, set this property to the rich card object. このプロパティと contentUrl プロパティは相互に排他的です。This property and the contentUrl property are mutually exclusive.
contentTypecontentType stringstring 添付ファイル内のコンテンツのメディアの種類。The media type of the content in the attachment. メディア ファイルの場合、このプロパティを image/pngaudio/wavvideo/mp4 などの既知のメディア タイプに設定します。For media files, set this property to known media types such as image/png, audio/wav, and video/mp4. リッチ カードの場合、このプロパティを次のベンダー固有タイプのいずれかに設定します。For rich cards, set this property to one of these vendor-specific types:
  • application/vnd.microsoft.card.adaptive: テキスト、音声、画像、ボタン、入力フィールドの任意の組み合わせを含めることができるリッチ カード。application/vnd.microsoft.card.adaptive: A rich card that can contain any combination of text, speech, images, buttons, and input fields. content プロパティを AdaptiveCard オブジェクトに設定します。Set the content property to an AdaptiveCard object.
  • application/vnd.microsoft.card.animation: アニメーションを再生するリッチ カード。application/vnd.microsoft.card.animation: A rich card that plays animation. content プロパティを AnimationCard オブジェクトに設定します。Set the content property to an AnimationCard object.
  • application/vnd.microsoft.card.audio: オーディオ ファイルを再生するリッチ カード。application/vnd.microsoft.card.audio: A rich card that plays audio files. content プロパティを AudioCard オブジェクトに設定します。Set the content property to an AudioCard object.
  • application/vnd.microsoft.card.hero: ヒーロー カード。application/vnd.microsoft.card.hero: A Hero card. content プロパティを HeroCard オブジェクトに設定します。Set the content property to a HeroCard object.
  • application/vnd.microsoft.card.receipt:領収書カード。application/vnd.microsoft.card.receipt: A Receipt card. content プロパティを ReceiptCard オブジェクトに設定します。Set the content property to a ReceiptCard object.
  • application/vnd.microsoft.card.signin:ユーザー サインイン カード。application/vnd.microsoft.card.signin: A user Sign In card. content プロパティを SignInCard オブジェクトに設定します。Set the content property to a SignInCard object.
  • application/vnd.microsoft.card.thumbnail: サムネイル カード。application/vnd.microsoft.card.thumbnail: A Thumbnail card. content プロパティを ThumbnailCard オブジェクトに設定します。Set the content property to a ThumbnailCard object.
  • application/vnd.microsoft.card.video: ビデオを再生するリッチ カード。application/vnd.microsoft.card.video: A rich card that plays videos. content プロパティを VideoCard オブジェクトに設定します。Set the content property to a VideoCard object.
contentUrlcontentUrl stringstring 添付ファイルのコンテンツの URL。URL for the content of the attachment. たとえば、添付ファイルが画像の場合、contentUrl を画像の場所を表す URL に設定できます。For example, if the attachment is an image, you can set contentUrl to the URL that represents the location of the image. サポートされているプロトコルは、HTTP、HTTPS、File、Data です。Supported protocols are: HTTP, HTTPS, File, and Data.
namename stringstring 添付ファイルの名前。Name of the attachment.
thumbnailUrlthumbnailUrl stringstring より小さな形式の代替 content または contentUrl の使用をチャネルがサポートしている場合にチャネルが使用できるサムネイル画像の URL。URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. たとえば、contentTypeapplication/word に設定し、contentUrl を Word 文書の場所に設定する場合、文書を表すサムネイル画像を含めることができます。For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. チャネルは文書の代わりにサムネイル画像を表示できます。The channel could display the thumbnail image instead of the document. ユーザーが画像をクリックすると、チャネルは文書を開きます。When the user clicks the image, the channel would open the document.

スキーマの表に戻るBack to Schema table

AttachmentData オブジェクトAttachmentData object

添付ファイルのデータについて説明します。Describes an attachment's data.

プロパティProperty TypeType 説明Description
namename stringstring 添付ファイルの名前。Name of the attachment.
originalBase64originalBase64 stringstring 添付ファイルのコンテンツ。Attachment content.
thumbnailBase64thumbnailBase64 stringstring 添付ファイルのサムネイル コンテンツ。Attachment thumbnail content.
typetype stringstring 添付ファイルのコンテンツの種類。Content type of the attachment.

スキーマの表に戻るBack to Schema table

AttachmentInfo オブジェクトAttachmentInfo object

添付ファイルのメタデータ。Metadata for an attachment.

プロパティProperty TypeType 説明Description
namename stringstring 添付ファイルの名前。Name of the attachment.
typetype stringstring 添付ファイルのコンテンツの種類。Content type of the attachment.
viewsviews AttachmentView[]AttachmentView[] 添付ファイルの利用可能なビューを表す AttachmentView オブジェクトの配列。Array of AttachmentView objects that represent the available views for the attachment.

スキーマの表に戻るBack to Schema table

AttachmentView オブジェクトAttachmentView object

添付ファイルのビューを定義します。Defines a attachment view.

プロパティProperty TypeType 説明Description
sizesize numbernumber ファイルのサイズ。Size of the file.
viewIdviewId stringstring ビュー ID。View ID.

スキーマの表に戻るBack to Schema table

AudioCard オブジェクトAudioCard object

オーディオ ファイルを再生できるカードを定義します。Defines a card that can play an audio file.

プロパティProperty TypeType 説明Description
aspectaspect stringstring image プロパティで指定されたサムネイルの縦横比。Aspect ratio of the thumbnail that is specified in the image property. 有効な値は 16:94:3 です。Valid values are 16:9 and 4:3.
autoloopautoloop booleanboolean 最後の項目が終了したときにオーディオ ファイルのリストをリプレイするかどうかを示すフラグ。Flag that indicates whether to replay the list of audio files when the last one ends. オーディオ ファイルを自動的にリプレイするには、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true to automatically replay the audio files; otherwise, false. 既定値は true です。The default value is true.
autostartautostart booleanboolean カードが表示されたときにオーディオを自動的に再生するかどうかを示すフラグ。Flag that indicates whether to automatically play the audio when the card is displayed. オーディオを自動的に再生するには、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true to automatically play the audio; otherwise, false. 既定値は true です。The default value is true.
buttonsbuttons CardAction[]CardAction[] ユーザーが 1 つ以上のアクションを実行できるようにする CardAction オブジェクトの配列。Array of CardAction objects that enable the user to perform one or more actions. 指定できるボタンの数はチャネルが決定します。The channel determines the number of buttons that you may specify.
durationduration stringstring メディア コンテンツの長さ (ISO 8601 の期間の形式)。The length of the media content, in ISO 8601 duration format.
imageimage ThumbnailUrlThumbnailUrl カードに表示する画像を指定する ThumbnailUrl オブジェクト。A ThumbnailUrl object that specifies the image to display on the card.
mediamedia MediaUrl[]MediaUrl[] Mediaurl オブジェクトの配列。Array of MediaUrl objects. このフィールドに複数の URL が含まれている場合、各 URL は同じコンテンツの代替形式です。When this field contains more than one URL, each URL is an alternative format of the same content.
shareableshareable booleanboolean オーディオ ファイルを他のユーザーと共有できるかどうかを示すフラグ。Flag that indicates whether the audio files may be shared with others. オーディオを共有できる場合、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true if the audio may be shared; otherwise, false. 既定値は true です。The default value is true.
subtitlesubtitle stringstring カードのタイトルの下に表示するサブタイトル。Subtitle to display under the card's title.
texttext stringstring カードのタイトルまたはサブタイトルの下に表示する説明またはプロンプト。Description or prompt to display under the card's title or subtitle.
titletitle stringstring カードのタイトル。Title of the card.
valuevalue objectobject このカードの補助パラメーター。Supplementary parameter for this card.

スキーマの表に戻るBack to Schema table

CardAction オブジェクトCardAction object

ボタンを使用してクリック可能なアクションを定義します。Defines a clickable action with a button.

プロパティProperty TypeType 説明Description
channelDatachannelData stringstring このアクションに関連付けられているチャネル固有のデータ。Channel-specific data associated with this action.
displayTextdisplayText stringstring ボタンがクリックされた場合にチャット フィードに表示するテキスト。Text to display in the chat feed if the button is clicked.
imageimage stringstring テキスト ラベルの横にあるボタンに表示される画像の URL。Image URL which will appear on the button, next to the text label.
texttext stringstring アクションのテキスト。Text for the action.
titletitle stringstring ボタンに表示されるテキスト説明です。Text description which appears on the button.
typetype stringstring 実行するアクションの種類。Type of action to perform. 有効な値の一覧については、「メッセージへのリッチ カード添付ファイルの追加」を参照してください。For a list of valid values, see Add rich card attachments to messages.
valuevalue objectobject アクションの補助パラメーター。Supplementary parameter for the action. このプロパティの動作は、アクションの type によって異なります。The behavior of this property will vary according to the action type. 詳細については、「メッセージへのリッチ カード添付ファイルの追加」を参照してください。For more information, see Add rich card attachments to messages.

スキーマの表に戻るBack to Schema table

CardImage オブジェクトCardImage object

カードに表示する画像を定義します。Defines an image to display on a card.

プロパティProperty TypeType 説明Description
altalt stringstring 画像の説明。Description of the image. アクセシビリティをサポートするには、説明を含める必要があります。You should include the description to support accessibility.
taptap CardActionCardAction ユーザーが画像をタップまたはクリックした場合に実行するアクションを指定する CardAction オブジェクト。A CardAction object that specifies the action to perform if the user taps or clicks the image.
urlurl stringstring 画像または画像の base64 バイナリのソース URL (例: data:image/png;base64,iVBORw0KGgo...)。URL to the source of the image or the base64 binary of the image (for example, data:image/png;base64,iVBORw0KGgo...).

スキーマの表に戻るBack to Schema table

ChannelAccount オブジェクトChannelAccount object

チャネルのボットまたはユーザー アカウントを定義します。Defines a bot or user account on the channel.

プロパティProperty TypeType 説明Description
aadObjectIdaadObjectId stringstring Azure Active Directory 内のこのアカウントのオブジェクト ID。This account's object ID within Azure Active Directory.
idid stringstring このチャネルのユーザーまたはボットの一意の ID。Unique ID for the user or bot on this channel.
namename stringstring ボットまたはユーザーの表示用の名前。Display-friendly name of the bot or user.
rolerole stringstring このアカウントの背後にあるエンティティのロール。Role of the entity behind the account. user または bot のいずれかです。Either user or bot.

スキーマの表に戻るBack to Schema table

ConversationAccount オブジェクトConversationAccount object

チャネルでの会話を定義します。Defines a conversation in a channel.

プロパティProperty TypeType 説明Description
aadObjectIdaadObjectId stringstring Azure Active Directory (AAD) 内のこのアカウントのオブジェクト ID。This account's object ID within Azure Active Directory (AAD).
conversationTypeconversationType stringstring 会話の種類 (グループ、個人など) を区別するチャネルでの会話の種類を示します。Indicates the type of the conversation in channels that distinguish between conversation types (e.g. group, personal).
idid stringstring 会話を識別する ID。The ID that identifies the conversation. ID はチャネルごとに一意です。The ID is unique per channel. チャネルが会話を開始する場合、チャネルがこの ID を設定します。それ以外の場合、このプロパティはボットによって、ボットが会話を開始するときに応答で取得する ID に設定されます (「会話を作成する」を参照)。If the channel starts the conversation, it sets this ID; otherwise, the bot sets this property to the ID that it gets back in the response when it starts the conversation (see Create Conversation).
isGroupisGroup booleanboolean アクティビティが生成された時点で会話に 2 人より多い参加者が含まれているかどうかを示すフラグ。Flag to indicate whether the conversation contains more than two participants at the time the activity was generated. これがグループ会話の場合は true に設定します。それ以外の場合、false に設定します。Set to true if this is a group conversation; otherwise, false. 既定値は false です。The default is false.
namename stringstring 会話を識別するために使用できる表示名。A display name that can be used to identify the conversation.
rolerole stringstring このアカウントの背後にあるエンティティのロール。Role of the entity behind the account. user または bot のいずれかです。Either user or bot.
tenantIdtenantId stringstring この会話のテナント ID。This conversation's tenant ID.

スキーマの表に戻るBack to Schema table

ConversationMembers オブジェクトConversationMembers object

会話のメンバーを取得します。Defines the members of a conversation.

プロパティProperty TypeType 説明Description
idid stringstring 会話 ID。The conversation ID.
membersmembers ChannelAccount[]ChannelAccount[] この会話のメンバーの一覧。List of members in this conversation.

スキーマの表に戻るBack to Schema table

ConversationParameters オブジェクトConversationParameters object

新しい会話を作成するためのパラメーターを定義します。Defines parameters for creating a new conversation.

プロパティProperty TypeType 説明Description
activityactivity アクティビティActivity 会話の作成時にその会話に送信される初期メッセージ。The initial message to send to the conversation when it is created.
botbot ChannelAccountChannelAccount ボットにメッセージをルーティングするために必要なチャネル アカウント情報。Channel account information needed to route a message to the bot.
channelDatachannelData objectobject 会話を作成するためのチャネル固有のペイロード。Channel-specific payload for creating the conversation.
isGroupisGroup booleanboolean これがグループ会話かどうかを示します。Indicates whether this is a group conversation.
membersmembers ChannelAccount[]ChannelAccount[] 各ユーザーにメッセージをルーティングするために必要なチャネル アカウント情報。Channel account information needed to route a message to each user.
tenantIdtenantId stringstring 会話が作成されるテナントの ID。The tenant ID in which the conversation should be created.
topicNametopicName stringstring 会話のトピック。Topic of the conversation. このプロパティは、チャネルがサポートしている場合にのみ使用されます。This property is only used if a channel supports it.

スキーマの表に戻るBack to Schema table

ConversationReference オブジェクトConversationReference object

会話内の特定のポイントを定義します。Defines a particular point in a conversation.

プロパティProperty TypeType 説明Description
activityIdactivityId stringstring このオブジェクトが参照するアクティビティを一意に識別する ID。ID that uniquely identifies the activity that this object references.
botbot ChannelAccountChannelAccount このオブジェクトが参照する会話でボットを識別する ChannelAccount オブジェクト。A ChannelAccount object that identifies the bot in the conversation that this object references.
channelIdchannelId stringstring このオブジェクトが参照する会話でチャネルを一意に識別する ID。An ID that uniquely identifies the channel in the conversation that this object references.
conversationconversation ConversationAccountConversationAccount このオブジェクトが参照する会話を定義する ConversationAccount オブジェクト。A ConversationAccount object that defines the conversation that this object references.
serviceUrlserviceUrl stringstring このオブジェクトが参照する会話でチャネルのサービス エンドポイントを指定する URL。URL that specifies the channel's service endpoint in the conversation that this object references.
useruser ChannelAccountChannelAccount このオブジェクトが参照する会話でユーザーを識別する ChannelAccount オブジェクト。A ChannelAccount object that identifies the user in the conversation that this object references.

スキーマの表に戻るBack to Schema table

ConversationResourceResponse オブジェクトConversationResourceResponse object

会話を作成するへの応答を定義します。Defines a response to Create Conversation.

プロパティProperty TypeType 説明Description
activityIdactivityId stringstring アクティビティの ID (送信された場合)。ID of the activity, if sent.
idid stringstring リソースの ID。ID of the resource.
serviceUrlserviceUrl stringstring 会話に関する操作を実行できるサービス エンドポイント。Service endpoint where operations concerning the conversation may be performed.

スキーマの表に戻るBack to Schema table

ConversationsResult オブジェクトConversationsResult object

会話を取得するの結果を定義します。Defines the result of Get Conversations.

プロパティProperty TypeType 説明Description
conversationsconversations ConversationMembers[]ConversationMembers[] 各会話のメンバー。The members in each of the conversations.
continuationTokencontinuationToken stringstring その後の会話を取得するの呼び出しで使用できる継続トークン。The continuation token that can be used in subsequent calls to Get Conversations.

スキーマの表に戻るBack to Schema table

Entity オブジェクトEntity object

アクティビティに関連するメタデータ オブジェクト。Metadata object pertaining to an activity.

プロパティProperty TypeType 説明Description
typetype stringstring このエンティティの型 (RFC 3987 IRI)。Type of this entity (RFC 3987 IRI).

スキーマの表に戻るBack to Schema table

エラー オブジェクトError object

エラー情報を示すオブジェクト。Object representing error information.

プロパティProperty TypeType 説明Description
codecode stringstring エラー コード。Error code.
innerHttpErrorinnerHttpError InnerHttpErrorInnerHttpError 内部 HTTP エラーを示すオブジェクト。Object representing the inner HTTP error.
messagemessage stringstring エラーの説明。A description of the error.

スキーマの表に戻るBack to Schema table

ErrorResponse オブジェクトErrorResponse object

HTTP API 応答を定義します。Defines an HTTP API response.

プロパティProperty TypeType 説明Description
errorerror ErrorError エラーに関する情報を含む Error オブジェクト。An Error object that contains information about the error.

スキーマの表に戻るBack to Schema table

Fact オブジェクトFact object

ファクトを含むキーと値のペアを定義します。Defines a key-value pair that contains a fact.

プロパティProperty TypeType 説明Description
keykey stringstring ファクトの名前。Name of the fact. 例: Check-inFor example, Check-in. キーは、ファクトの値を表示するときにラベルとして使用されます。The key is used as a label when displaying the fact's value.
valuevalue stringstring ファクトの値。Value of the fact. 例: 10 October 2016For example, 10 October 2016.

スキーマの表に戻るBack to Schema table

GeoCoordinates オブジェクトGeoCoordinates object

World Geodetic System (WSG84) 座標を使用して地理的な場所を定義します。Defines a geographical location using World Geodetic System (WSG84) coordinates.

プロパティProperty TypeType 説明Description
elevationelevation numbernumber 場所の標高。Elevation of the location.
latitudelatitude numbernumber 場所の緯度。Latitude of the location.
longitudelongitude numbernumber 場所の経度。Longitude of the location.
namename stringstring 場所の名前。Name of the location.
typetype stringstring このオブジェクトの種類。The type of this object. 常に GeoCoordinates に設定します。Always set to GeoCoordinates.

スキーマの表に戻るBack to Schema table

HeroCard オブジェクトHeroCard object

大きい画像、タイトル、テキスト、アクションの各ボタンを持つカードを定義します。Defines a card with a large image, title, text, and action buttons.

プロパティProperty TypeType 説明Description
buttonsbuttons CardAction[]CardAction[] ユーザーが 1 つ以上のアクションを実行できるようにする CardAction オブジェクトの配列。Array of CardAction objects that enable the user to perform one or more actions. 指定できるボタンの数はチャネルが決定します。The channel determines the number of buttons that you may specify.
imagesimages CardImage[]CardImage[] カードに表示する画像を指定する CardImage オブジェクトの配列。Array of CardImage objects that specifies the image to display on the card. ヒーロー カードには 1 つの画像のみが含まれます。A Hero card contains only one image.
subtitlesubtitle stringstring カードのタイトルの下に表示するサブタイトル。Subtitle to display under the card's title.
taptap CardActionCardAction ユーザーがカードをタップまたはクリックした場合に実行するアクションを指定する CardAction オブジェクト。A CardAction object that specifies the action to perform if the user taps or clicks the card. いずれかのボタンと同じアクションまたは別のアクションを指定できます。This can be the same action as one of the buttons or a different action.
texttext stringstring カードのタイトルまたはサブタイトルの下に表示する説明またはプロンプト。Description or prompt to display under the card's title or subtitle.
titletitle stringstring カードのタイトル。Title of the card.

スキーマの表に戻るBack to Schema table

InnerHttpError オブジェクトInnerHttpError object

内部 HTTP エラーを示すオブジェクト。Object representing an inner HTTP error.

プロパティProperty TypeType 説明Description
statusCodestatusCode numbernumber 失敗した要求の HTTP 状態コード。HTTP status code from the failed request.
bodybody objectobject 失敗した要求の本文。Body from the failed request.

スキーマの表に戻るBack to Schema table

MediaEventValue オブジェクトMediaEventValue object

メディア イベントの補助パラメーター。Supplementary parameter for media events.

プロパティProperty TypeType 説明Description
cardValuecardValue objectobject このイベントを発生させたメディア カードの value フィールドに指定されたコールバック パラメーター。Callback parameter specified in the value field of the media card that originated this event.

スキーマの表に戻るBack to Schema table

MediaUrl オブジェクトMediaUrl object

メディア ファイルのソース URL を定義します。Defines the URL to a media file's source.

プロパティProperty TypeType 説明Description
profileprofile stringstring メディアのコンテンツを説明するヒント。Hint that describes the media's content.
urlurl stringstring メディア ファイルのソース URL。URL to the source of the media file.

スキーマの表に戻るBack to Schema table

Mention オブジェクトMention object

会話でメンションされたユーザーまたはボットを定義します。Defines a user or bot that was mentioned in the conversation.

プロパティProperty TypeType 説明Description
mentionedmentioned ChannelAccountChannelAccount メンションされたユーザーまたはボットを指定する ChannelAccount オブジェクト。A ChannelAccount object that specifies the user or the bot that was mentioned. Slack などの一部のチャネルでは会話ごとに名前を割り当てるため、(メッセージの recipient プロパティで) メンションされたボットの名前は、ボットの登録時に指定したハンドルとは異なる可能性があることに注意してください。Note that some channels such as Slack assign names per conversation, so it is possible that your bot's mentioned name (in the message's recipient property) may be different from the handle that you specified when you registered your bot. ただし、両方のアカウント ID は同じになります。However, the account IDs for both would be the same.
texttext stringstring 会話でメンションされたユーザーまたはボット。The user or bot as mentioned in the conversation. たとえば、メッセージが「@ColorBot pick me a new color」の場合、このプロパティは **@ColorBot** に設定されます。For example, if the message is "@ColorBot pick me a new color," this property would be set to **@ColorBot**. すべてのチャネルがこのプロパティを設定するわけではありません。Not all channels set this property.
typetype stringstring このオブジェクトの種類。This object's type. 常に Mention に設定します。Always set to Mention.

スキーマの表に戻るBack to Schema table

MessageReaction オブジェクトMessageReaction object

メッセージへの反応を定義します。Defines a reaction to a message.

プロパティProperty TypeType 説明Description
typetype stringstring 反応の種類。Type of reaction. like または plusOne のいずれかです。Either like or plusOne.

スキーマの表に戻るBack to Schema table

PagedMembersResult オブジェクトPagedMembersResult object

会話のページングされたメンバーを取得するによって返されるメンバーのページ。Page of members returned by Get Conversation Paged Members.

プロパティProperty TypeType 説明Description
continuationTokencontinuationToken stringstring 後続の会話のページングされたメンバーを取得するの呼び出しで使用できる継続トークン。The continuation token that can be used in subsequent calls to Get Conversation Paged Members.
membersmembers ChannelAccount[]ChannelAccount[] 会話のメンバーの配列です。An array of conversation members.

スキーマの表に戻るBack to Schema table

Place オブジェクトPlace object

会話でメンションされた場所を定義します。Defines a place that was mentioned in the conversation.

プロパティProperty TypeType 説明Description
addressaddress objectobject 場所の所在地。Address of a place. このプロパティは string、または PostalAddress 型の複合オブジェクトです。This property can be a string or a complex object of type PostalAddress.
geogeo GeoCoordinatesGeoCoordinates 場所の地理的座標を指定する GeoCoordinates オブジェクト。A GeoCoordinates object that specifies the geographical coordinates of the place.
hasMaphasMap objectobject 場所の地図。Map to the place. このプロパティは string (URL)、または Map 型の複合オブジェクトです。This property can be a string (URL) or a complex object of type Map.
namename stringstring 場所の名前。Name of the place.
typetype stringstring このオブジェクトの種類。This object's type. 常に Place に設定します。Always set to Place.

スキーマの表に戻るBack to Schema table

ReceiptCard オブジェクトReceiptCard object

購入のレシートを含むカードを定義します。Defines a card that contains a receipt for a purchase.

プロパティProperty TypeType 説明Description
buttonsbuttons CardAction[]CardAction[] ユーザーが 1 つ以上のアクションを実行できるようにする CardAction オブジェクトの配列。Array of CardAction objects that enable the user to perform one or more actions. 指定できるボタンの数はチャネルが決定します。The channel determines the number of buttons that you may specify.
factsfacts Fact[]Fact[] 購入に関する情報を指定する Fact オブジェクトの配列。Array of Fact objects that specify information about the purchase. たとえば、ホテル宿泊レシートのファクトのリストには、チェックイン日とチェックアウト日が含まれる場合があります。For example, the list of facts for a hotel stay receipt might include the check-in date and check-out date. 指定できるファクトの数はチャネルが決定します。The channel determines the number of facts that you may specify.
itemsitems ReceiptItem[]ReceiptItem[] 購入したアイテムを指定する ReceiptItem オブジェクトの配列Array of ReceiptItem objects that specify the purchased items
taptap CardActionCardAction ユーザーがカードをタップまたはクリックした場合に実行するアクションを指定する CardAction オブジェクト。A CardAction object that specifies the action to perform if the user taps or clicks the card. いずれかのボタンと同じアクションまたは別のアクションを指定できます。This can be the same action as one of the buttons or a different action.
taxtax stringstring 購入に適用される税額を指定する通貨形式の文字列。A currency-formatted string that specifies the amount of tax applied to the purchase.
titletitle stringstring レシートの上部に表示されるタイトル。Title displayed at the top of the receipt.
totaltotal stringstring 適用されるすべての税金を含めた合計購入価格を指定する通貨形式の文字列。A currency-formatted string that specifies the total purchase price, including all applicable taxes.
vatvat stringstring 購入価格に適用される付加価値税 (VAT) の額を指定する通貨形式の文字列。A currency-formatted string that specifies the amount of value-added tax (VAT) applied to the purchase price.

スキーマの表に戻るBack to Schema table

ReceiptItem オブジェクトReceiptItem object

レシート内の品目を定義します。Defines a line item within a receipt.

プロパティProperty TypeType 説明Description
imageimage CardImageCardImage 品目の隣に表示するサムネイル画像を指定する CardImage オブジェクト。A CardImage object that specifies thumbnail image to display next to the line item.
priceprice stringstring すべての購入単位の合計価格を指定する通貨形式の文字列。A currency-formatted string that specifies the total price of all units purchased.
quantityquantity stringstring 購入単位数を指定する数値の文字列。A numeric string that specifies the number of units purchased.
subtitlesubtitle stringstring 品目のタイトルの下に表示されるサブタイトル。Subtitle to be displayed under the line item's title.
taptap CardActionCardAction ユーザーが品目をタップまたはクリックした場合に実行するアクションを指定する CardAction オブジェクト。A CardAction object that specifies the action to perform if the user taps or clicks the line item.
texttext stringstring 品目の説明。Description of the line item.
titletitle stringstring 品目のタイトル。Title of the line item.

スキーマの表に戻るBack to Schema table

ResourceResponse オブジェクトResourceResponse object

リソース ID を含む応答を定義します。Defines a response that contains a resource ID.

プロパティProperty TypeType 説明Description
idid stringstring リソースを一意に識別する ID。ID that uniquely identifies the resource.

スキーマの表に戻るBack to Schema table

SemanticAction オブジェクトSemanticAction object

プログラムによるアクションへの参照を定義します。Defines a reference to a programmatic action.

プロパティProperty TypeType 説明Description
entitiesentities objectobject 各プロパティの値が Entity オブジェクトであるオブジェクト。An object where the value of each property is an Entity object.
idid stringstring このアクションの ID。ID of this action.
statestate stringstring このアクションの状態。State of this action. 使用できる値: startcontinuedoneAllowed values: start, continue, done.

スキーマの表に戻るBack to Schema table

SignInCard オブジェクトSignInCard object

ユーザーがサービスにサインインできるようにするカードを定義します。Defines a card that lets a user sign in to a service.

プロパティProperty TypeType 説明Description
buttonsbuttons CardAction[]CardAction[] ユーザーがサービスにサインインできるようにする CardAction オブジェクトの配列。Array of CardAction objects that enable the user to sign in to a service. 指定できるボタンの数はチャネルが決定します。The channel determines the number of buttons that you may specify.
texttext stringstring サインイン カードに含める説明またはプロンプト。Description or prompt to include on the sign in card.

スキーマの表に戻るBack to Schema table

SuggestedActions オブジェクトSuggestedActions object

ユーザーが選択できるオプションを定義します。Defines the options from which a user can choose.

プロパティProperty TypeType 説明Description
actionsactions CardAction[]CardAction[] 推奨されるアクションを定義する CardAction オブジェクトの配列。Array of CardAction objects that define the suggested actions.
toto string[]string[] 推奨されるアクションの表示先である受信者の ID を含む文字列の配列。Array of strings that contains the IDs of the recipients to whom the suggested actions should be displayed.

スキーマの表に戻るBack to Schema table

TextHighlight オブジェクトTextHighlight object

別のフィールド内のコンテンツの部分文字列を参照します。Refers to a substring of content within another field.

プロパティProperty TypeType 説明Description
occurrenceoccurrence numbernumber 参照されるテキスト内でのテキスト フィールドの出現数 (複数存在する場合)。Occurrence of the text field within the referenced text, if multiple exist.
texttext stringstring 強調表示するテキストのスニペットを定義します。Defines the snippet of text to highlight.

スキーマの表に戻るBack to Schema table

ThumbnailCard オブジェクトThumbnailCard object

サムネイル画像、タイトル、テキスト、アクションの各ボタンを持つカードを定義します。Defines a card with a thumbnail image, title, text, and action buttons.

プロパティProperty TypeType 説明Description
buttonsbuttons CardAction[]CardAction[] ユーザーが 1 つ以上のアクションを実行できるようにする CardAction オブジェクトの配列。Array of CardAction objects that enable the user to perform one or more actions. 指定できるボタンの数はチャネルが決定します。The channel determines the number of buttons that you may specify.
imagesimages CardImage[]CardImage[] カードに表示するサムネイル画像を指定する CardImage オブジェクトの配列。Array of CardImage objects that specify thumbnail images to display on the card. 指定できるサムネイル画像の数はチャネルが決定します。The channel determines the number of thumbnail images that you may specify.
subtitlesubtitle stringstring カードのタイトルの下に表示するサブタイトル。Subtitle to display under the card's title.
taptap CardActionCardAction ユーザーがカードをタップまたはクリックした場合に実行するアクションを指定する CardAction オブジェクト。A CardAction object that specifies the action to perform if the user taps or clicks the card. いずれかのボタンと同じアクションまたは別のアクションを指定できます。This can be the same action as one of the buttons or a different action.
texttext stringstring カードのタイトルまたはサブタイトルの下に表示する説明またはプロンプト。Description or prompt to display under the card's title or subtitle.
titletitle stringstring カードのタイトル。Title of the card.

スキーマの表に戻るBack to Schema table

ThumbnailUrl オブジェクトThumbnailUrl object

画像のソース URL を定義します。Defines the URL to an image's source.

プロパティProperty TypeType 説明Description
altalt stringstring 画像の説明。Description of the image. アクセシビリティをサポートするには、説明を含める必要があります。You should include the description to support accessibility.
urlurl stringstring 画像または画像の base64 バイナリのソース URL (例: data:image/png;base64,iVBORw0KGgo...)。URL to the source of the image or the base64 binary of the image (for example, data:image/png;base64,iVBORw0KGgo...).

スキーマの表に戻るBack to Schema table

Transcript オブジェクトTranscript object

会話履歴を送信するを使用してアップロードされるアクティビティのコレクション。A collection of activities to be uploaded using Send Conversation History.

プロパティProperty TypeType 説明Description
activitiesactivities arrayarray Activity オブジェクトの配列です。An array of Activity objects. それぞれが一意の ID とタイムスタンプを持つ必要があります。They should each have a unique ID and timestamp.

スキーマの表に戻るBack to Schema table

VideoCard オブジェクトVideoCard object

ビデオを再生できるカードを定義します。Defines a card that can play videos.

プロパティProperty TypeType 説明Description
aspectaspect stringstring ビデオの縦横比。Aspect ratio of the video. 16:9 または 4:3 のいずれかです。Either 16:9 or 4:3.
autoloopautoloop booleanboolean 最後の項目が終了したときにビデオのリストをリプレイするかどうかを示すフラグ。Flag that indicates whether to replay the list of videos when the last one ends. ビデオを自動的にリプレイするには、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true to automatically replay the videos; otherwise, false. 既定値は true です。The default value is true.
autostartautostart booleanboolean カードが表示されたときにビデオを自動的に再生するかどうかを示すフラグ。Flag that indicates whether to automatically play the videos when the card is displayed. ビデオを自動的に再生するには、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true to automatically play the videos; otherwise, false. 既定値は true です。The default value is true.
buttonsbuttons CardAction[]CardAction[] ユーザーが 1 つ以上のアクションを実行できるようにする CardAction オブジェクトの配列。Array of CardAction objects that enable the user to perform one or more actions. 指定できるボタンの数はチャネルが決定します。The channel determines the number of buttons that you may specify.
durationduration stringstring メディア コンテンツの長さ (ISO 8601 の期間の形式)。The length of the media content, in ISO 8601 duration format.
imageimage ThumbnailUrlThumbnailUrl カードに表示する画像を指定する ThumbnailUrl オブジェクト。A ThumbnailUrl object that specifies the image to display on the card.
mediamedia MediaUrl[]MediaUrl[] MediaUrl の配列。Array of MediaUrl. このフィールドに複数の URL が含まれている場合、各 URL は同じコンテンツの代替形式です。When this field contains more than one URL, each URL is an alternative format of the same content.
shareableshareable booleanboolean ビデオを他のユーザーと共有できるかどうかを示すフラグ。Flag that indicates whether the videos may be shared with others. ビデオを共有できる場合、このプロパティを true に設定します。それ以外の場合、false に設定します。Set this property to true if the videos may be shared; otherwise, false. 既定値は true です。The default value is true.
subtitlesubtitle stringstring カードのタイトルの下に表示するサブタイトル。Subtitle to display under the card's title.
texttext stringstring カードのタイトルまたはサブタイトルの下に表示する説明またはプロンプト。Description or prompt to display under the card's title or subtitle.
titletitle stringstring カードのタイトル。Title of the card.
valuevalue objectobject このカードの補助パラメーターSupplementary parameter for this card

スキーマの表に戻るBack to Schema table