{

"swagger": "2.0",

"info": {

"version": "v3",

"title": "Microsoft Bot Connector API - v3.0",

"description": "The Bot Connector REST API allows your bot to send and receive messages to channels configured in the\r\n[Bot Framework Developer Portal](https://dev.botframework.com). The Connector service uses industry-standard REST\r\nand JSON over HTTPS.\r\n\r\nClient libraries for this REST API are available. See below for a list.\r\n\r\nMany bots will use both the Bot Connector REST API and the associated [Bot State REST API](/en-us/restapi/state). The\r\nBot State REST API allows a bot to store and retrieve state associated with users and conversations.\r\n\r\nAuthentication for both the Bot Connector and Bot State REST APIs is accomplished with JWT Bearer tokens, and is\r\ndescribed in detail in the [Connector Authentication](/en-us/restapi/authentication) document.\r\n\r\n# Client Libraries for the Bot Connector REST API\r\n\r\n* [Bot Builder for C#](/en-us/csharp/builder/sdkreference/)\r\n* [Bot Builder for Node.js](/en-us/node/builder/overview/)\r\n* Generate your own from the [Connector API Swagger file](https://raw.githubusercontent.com/Microsoft/BotBuilder/master/CSharp/Library/Microsoft.Bot.Connector.Shared/Swagger/ConnectorAPI.json)\r\n\r\n© 2016 Microsoft",

"termsOfService": "https://www.microsoft.com/en-us/legal/intellectualproperty/copyright/default.aspx",

"contact": {

"name": "Bot Framework",

"url": "https://botframework.com",

"email": "botframework@microsoft.com"

},

"license": {

"name": "The MIT License (MIT)",

"url": "https://opensource.org/licenses/MIT"

}

},

"host": "api.botframework.com",

"schemes": [

"https"

],

"paths": {

"/v3/attachments/{attachmentId}": {

"get": {

"tags": [

"Attachments"

],

"summary": "GetAttachmentInfo",

"description": "Get AttachmentInfo structure describing the attachment views",

"operationId": "Attachments_GetAttachmentInfo",

"consumes": [],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "attachmentId",

"in": "path",

"description": "attachment id",

"required": true,

"type": "string"

}

],

"responses": {

"200": {

"description": "An attachmentInfo object is returned which describes the:\r\n* type of the attachment\r\n* name of the attachment\r\n\r\n\r\nand an array of views:\r\n* Size - size of the object\r\n* ViewId - View Id which can be used to fetch a variation on the content (ex: original or thumbnail)",

"schema": {

"$ref": "#/definitions/AttachmentInfo"

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/attachments/{attachmentId}/views/{viewId}": {

"get": {

"tags": [

"Attachments"

],

"summary": "GetAttachment",

"description": "Get the named view as binary content",

"operationId": "Attachments_GetAttachment",

"consumes": [],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "attachmentId",

"in": "path",

"description": "attachment id",

"required": true,

"type": "string"

},

{

"name": "viewId",

"in": "path",

"description": "View id from attachmentInfo",

"required": true,

"type": "string"

}

],

"responses": {

"200": {

"description": "Attachment stream",

"schema": {

"format": "byte",

"type": "file"

}

},

"301": {

"description": "The Location header describes where the content is now."

},

"302": {

"description": "The Location header describes where the content is now."

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/conversations": {

"get": {

"tags": [

"Conversations"

],

"summary": "GetConversations",

"description": "List the Conversations in which this bot has participated.\r\n\r\nGET from this method with a skip token\r\n\r\nThe return value is a ConversationsResult, which contains an array of ConversationMembers and a skip token. If the skip token is not empty, then \r\nthere are further values to be returned. Call this method again with the returned token to get more values.\r\n\r\nEach ConversationMembers object contains the ID of the conversation and an array of ChannelAccounts that describe the members of the conversation.",

"operationId": "Conversations_GetConversations",

"consumes": [],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "continuationToken",

"in": "query",

"description": "skip or continuation token",

"required": false,

"type": "string"

}

],

"responses": {

"200": {

"description": "An object will be returned containing \r\n* an array (Conversations) of ConversationMembers objects\r\n* a continuation token\r\n\r\nEach ConversationMembers object contains:\r\n* the Id of the conversation\r\n* an array (Members) of ChannelAccount objects",

"schema": {

"$ref": "#/definitions/ConversationsResult"

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

},

"post": {

"tags": [

"Conversations"

],

"summary": "CreateConversation",

"description": "Create a new Conversation.\r\n\r\nPOST to this method with a\r\n* Bot being the bot creating the conversation\r\n* IsGroup set to true if this is not a direct message (default is false)\r\n* Array containing the members to include in the conversation\r\n\r\nThe return value is a ResourceResponse which contains a conversation id which is suitable for use\r\nin the message payload and REST API uris.\r\n\r\nMost channels only support the semantics of bots initiating a direct message conversation. An example of how to do that would be:\r\n\r\n```\r\nvar resource = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount(\"user1\") } );\r\nawait connect.Conversations.SendToConversationAsync(resource.Id, new Activity() ... ) ;\r\n\r\n```",

"operationId": "Conversations_CreateConversation",

"consumes": [

"application/json",

"text/json",

"application/xml",

"text/xml",

"application/x-www-form-urlencoded"

],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "parameters",

"in": "body",

"description": "Parameters to create the conversation from",

"required": true,

"schema": {

"$ref": "#/definitions/ConversationParameters"

}

}

],

"responses": {

"200": {

"description": "An object will be returned containing \r\n* the ID for the conversation\r\n* ActivityId for the activity if provided. If ActivityId is null then the channel doesn't support returning resource id's for activity.",

"schema": {

"$ref": "#/definitions/ConversationResourceResponse"

}

},

"201": {

"description": "An object will be returned containing \r\n* the ID for the conversation\r\n* ActivityId for the activity if provided. If ActivityId is null then the channel doesn't support returning resource id's for activity.",

"schema": {

"$ref": "#/definitions/ConversationResourceResponse"

}

},

"202": {

"description": "An object will be returned containing \r\n* the ID for the conversation\r\n* ActivityId for the activity if provided. If ActivityId is null then the channel doesn't support returning resource id's for activity.",

"schema": {

"$ref": "#/definitions/ConversationResourceResponse"

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/conversations/{conversationId}/activities": {

"post": {

"tags": [

"Conversations"

],

"summary": "SendToConversation",

"description": "This method allows you to send an activity to the end of a conversation.\r\n\r\nThis is slightly different from ReplyToActivity().\r\n* SendToConversation(conversationId) - will append the activity to the end of the conversation according to the timestamp or semantics of the channel.\r\n* ReplyToActivity(conversationId,ActivityId) - adds the activity as a reply to another activity, if the channel supports it. If the channel does not support nested replies, ReplyToActivity falls back to SendToConversation.\r\n\r\nUse ReplyToActivity when replying to a specific activity in the conversation.\r\n\r\nUse SendToConversation in all other cases.",

"operationId": "Conversations_SendToConversation",

"consumes": [

"application/json",

"text/json",

"application/xml",

"text/xml",

"application/x-www-form-urlencoded"

],

"produces": [

"application/json",

"text/json"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "activity",

"in": "body",

"description": "Activity to send",

"required": true,

"schema": {

"$ref": "#/definitions/Activity"

}

}

],

"responses": {

"200": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"201": {

"description": "A ResourceResponse object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"202": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/conversations/{conversationId}/activities/history": {

"post": {

"tags": [

"Conversations"

],

"summary": "SendConversationHistory",

"description": "This method allows you to upload the historic activities to the conversation.\r\n\r\nSender must ensure that the historic activities have unique ids and appropriate timestamps. The ids are used by the client to deal with duplicate activities and the timestamps are used by the client to render the activities in the right order.",

"operationId": "Conversations_SendConversationHistory",

"consumes": [

"application/json",

"text/json",

"application/xml",

"text/xml",

"application/x-www-form-urlencoded"

],

"produces": [

"application/json",

"text/json"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "history",

"in": "body",

"description": "Historic activities",

"required": true,

"schema": {

"$ref": "#/definitions/Transcript"

}

}

],

"responses": {

"200": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"201": {

"description": "A ResourceResponse object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"202": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/conversations/{conversationId}/activities/{activityId}": {

"put": {

"tags": [

"Conversations"

],

"summary": "UpdateActivity",

"description": "Edit an existing activity.\r\n\r\nSome channels allow you to edit an existing activity to reflect the new state of a bot conversation.\r\n\r\nFor example, you can remove buttons after someone has clicked \"Approve\" button.",

"operationId": "Conversations_UpdateActivity",

"consumes": [

"application/json",

"text/json",

"application/xml",

"text/xml",

"application/x-www-form-urlencoded"

],

"produces": [

"application/json",

"text/json"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "activityId",

"in": "path",

"description": "activityId to update",

"required": true,

"type": "string"

},

{

"name": "activity",

"in": "body",

"description": "replacement Activity",

"required": true,

"schema": {

"$ref": "#/definitions/Activity"

}

}

],

"responses": {

"200": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"201": {

"description": "A ResourceResponse object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"202": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

},

"post": {

"tags": [

"Conversations"

],

"summary": "ReplyToActivity",

"description": "This method allows you to reply to an activity.\r\n\r\nThis is slightly different from SendToConversation().\r\n* SendToConversation(conversationId) - will append the activity to the end of the conversation according to the timestamp or semantics of the channel.\r\n* ReplyToActivity(conversationId,ActivityId) - adds the activity as a reply to another activity, if the channel supports it. If the channel does not support nested replies, ReplyToActivity falls back to SendToConversation.\r\n\r\nUse ReplyToActivity when replying to a specific activity in the conversation.\r\n\r\nUse SendToConversation in all other cases.",

"operationId": "Conversations_ReplyToActivity",

"consumes": [

"application/json",

"text/json",

"application/xml",

"text/xml",

"application/x-www-form-urlencoded"

],

"produces": [

"application/json",

"text/json"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "activityId",

"in": "path",

"description": "activityId the reply is to (OPTIONAL)",

"required": true,

"type": "string"

},

{

"name": "activity",

"in": "body",

"description": "Activity to send",

"required": true,

"schema": {

"$ref": "#/definitions/Activity"

}

}

],

"responses": {

"200": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"201": {

"description": "A ResourceResponse object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"202": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

},

"delete": {

"tags": [

"Conversations"

],

"summary": "DeleteActivity",

"description": "Delete an existing activity.\r\n\r\nSome channels allow you to delete an existing activity, and if successful this method will remove the specified activity.",

"operationId": "Conversations_DeleteActivity",

"consumes": [],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "activityId",

"in": "path",

"description": "activityId to delete",

"required": true,

"type": "string"

}

],

"responses": {

"200": {

"description": "The operation succeeded, there is no response."

},

"202": {

"description": "The request has been accepted for processing, but the processing has not been completed"

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/conversations/{conversationId}/members": {

"get": {

"tags": [

"Conversations"

],

"summary": "GetConversationMembers",

"description": "Enumerate the members of a conversation. \r\n\r\nThis REST API takes a ConversationId and returns an array of ChannelAccount objects representing the members of the conversation.",

"operationId": "Conversations_GetConversationMembers",

"consumes": [],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

}

],

"responses": {

"200": {

"description": "An array of ChannelAccount objects",

"schema": {

"type": "array",

"items": {

"$ref": "#/definitions/ChannelAccount"

}

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/conversations/{conversationId}/pagedmembers": {

"get": {

"tags": [

"Conversations"

],

"summary": "GetConversationPagedMembers",

"description": "Enumerate the members of a conversation one page at a time.\r\n\r\nThis REST API takes a ConversationId. Optionally a pageSize and/or continuationToken can be provided. It returns a PagedMembersResult, which contains an array\r\nof ChannelAccounts representing the members of the conversation and a continuation token that can be used to get more values.\r\n\r\nOne page of ChannelAccounts records are returned with each call. The number of records in a page may vary between channels and calls. The pageSize parameter can be used as \r\na suggestion. If there are no additional results the response will not contain a continuation token. If there are no members in the conversation the Members will be empty or not present in the response.\r\n\r\nA response to a request that has a continuation token from a prior request may rarely return members from a previous request.",

"operationId": "Conversations_GetConversationPagedMembers",

"consumes": [],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "pageSize",

"in": "query",

"description": "Suggested page size",

"required": false,

"type": "integer",

"format": "int32"

},

{

"name": "continuationToken",

"in": "query",

"description": "Continuation Token",

"required": false,

"type": "string"

}

],

"responses": {

"200": {

"description": "OK",

"schema": {

"$ref": "#/definitions/PagedMembersResult"

}

}

}

}

},

"/v3/conversations/{conversationId}/members/{memberId}": {

"delete": {

"tags": [

"Conversations"

],

"summary": "DeleteConversationMember",

"description": "Deletes a member from a conversation. \r\n\r\nThis REST API takes a ConversationId and a memberId (of type string) and removes that member from the conversation. If that member was the last member\r\nof the conversation, the conversation will also be deleted.",

"operationId": "Conversations_DeleteConversationMember",

"consumes": [],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "memberId",

"in": "path",

"description": "ID of the member to delete from this conversation",

"required": true,

"type": "string"

}

],

"responses": {

"200": {

"description": "The operation succeeded, there is no response."

},

"204": {

"description": "The operation succeeded but no content was returned."

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/conversations/{conversationId}/activities/{activityId}/members": {

"get": {

"tags": [

"Conversations"

],

"summary": "GetActivityMembers",

"description": "Enumerate the members of an activity. \r\n\r\nThis REST API takes a ConversationId and a ActivityId, returning an array of ChannelAccount objects representing the members of the particular activity in the conversation.",

"operationId": "Conversations_GetActivityMembers",

"consumes": [],

"produces": [

"application/json",

"text/json",

"application/xml",

"text/xml"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "activityId",

"in": "path",

"description": "Activity ID",

"required": true,

"type": "string"

}

],

"responses": {

"200": {

"description": "An array of ChannelAccount objects",

"schema": {

"type": "array",

"items": {

"$ref": "#/definitions/ChannelAccount"

}

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

},

"/v3/conversations/{conversationId}/attachments": {

"post": {

"tags": [

"Conversations"

],

"summary": "UploadAttachment",

"description": "Upload an attachment directly into a channel's blob storage.\r\n\r\nThis is useful because it allows you to store data in a compliant store when dealing with enterprises.\r\n\r\nThe response is a ResourceResponse which contains an AttachmentId which is suitable for using with the attachments API.",

"operationId": "Conversations_UploadAttachment",

"consumes": [

"application/json",

"text/json",

"application/xml",

"text/xml",

"application/x-www-form-urlencoded"

],

"produces": [

"application/json",

"text/json"

],

"parameters": [

{

"name": "conversationId",

"in": "path",

"description": "Conversation ID",

"required": true,

"type": "string"

},

{

"name": "attachmentUpload",

"in": "body",

"description": "Attachment data",

"required": true,

"schema": {

"$ref": "#/definitions/AttachmentData"

}

}

],

"responses": {

"200": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"201": {

"description": "A ResourceResponse object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"202": {

"description": "An object will be returned containing the ID for the resource.",

"schema": {

"$ref": "#/definitions/ResourceResponse"

}

},

"default": {

"description": "The operation failed and the response is an error object describing the status code and failure.",

"schema": {

"$ref": "#/definitions/ErrorResponse"

}

}

}

}

}

},

"definitions": {

"AttachmentInfo": {

"description": "Metadata for an attachment",

"type": "object",

"properties": {

"name": {

"description": "Name of the attachment",

"type": "string"

},

"type": {

"description": "ContentType of the attachment",

"type": "string"

},

"views": {

"description": "attachment views",

"type": "array",

"items": {

"$ref": "#/definitions/AttachmentView"

}

}

}

},

"AttachmentView": {

"description": "Attachment View name and size",

"type": "object",

"properties": {

"viewId": {

"description": "Id of the attachment",

"type": "string"

},

"size": {

"format": "int32",

"description": "Size of the attachment",

"type": "integer"

}

}

},

"ErrorResponse": {

"description": "An HTTP API response",

"type": "object",

"properties": {

"error": {

"$ref": "#/definitions/Error",

"description": "Error message"

}

}

},

"Error": {

"description": "Object representing error information",

"type": "object",

"properties": {

"code": {

"description": "Error code",

"type": "string"

},

"message": {

"description": "Error message",

"type": "string"

},

"innerHttpError": {

"$ref": "#/definitions/InnerHttpError",

"description": "Error from inner http call"

}

}

},

"InnerHttpError": {

"description": "Object representing inner http error",

"type": "object",

"properties": {

"statusCode": {

"format": "int32",

"description": "HttpStatusCode from failed request",

"type": "integer"

},

"body": {

"description": "Body from failed request",

"type": "object"

}

}

},

"ConversationParameters": {

"description": "Parameters for creating a new conversation",

"type": "object",

"properties": {

"isGroup": {

"description": "IsGroup",

"type": "boolean"

},

"bot": {

"$ref": "#/definitions/ChannelAccount",

"description": "The bot address for this conversation"

},

"members": {

"description": "Members to add to the conversation",

"type": "array",

"items": {

"$ref": "#/definitions/ChannelAccount"

}

},

"topicName": {

"description": "(Optional) Topic of the conversation (if supported by the channel)",

"type": "string"

},

"tenantId": {

"description": "(Optional) The tenant ID in which the conversation should be created",

"type": "string"

},

"activity": {

"$ref": "#/definitions/Activity",

"description": "(Optional) When creating a new conversation, use this activity as the initial message to the conversation"

},

"channelData": {

"description": "Channel specific payload for creating the conversation",

"type": "object"

}

}

},

"ChannelAccount": {

"description": "Channel account information needed to route a message",

"type": "object",

"properties": {

"id": {

"description": "Channel id for the user or bot on this channel (Example: joe@smith.com, or @joesmith or 123456)",

"type": "string"

},

"name": {

"description": "Display friendly name",

"type": "string"

},

"aadObjectId": {

"description": "This account's object ID within Azure Active Directory (AAD)",

"type": "string"

},

"role": {

"$ref": "#/definitions/RoleTypes",

"description": "Role of the entity behind the account (Example: User, Bot, etc.)"

}

}

},

"Activity": {

"description": "An Activity is the basic communication type for the Bot Framework 3.0 protocol.",

"type": "object",

"properties": {

"type": {

"$ref": "#/definitions/ActivityTypes",

"description": "Contains the activity type."

},

"id": {

"description": "Contains an ID that uniquely identifies the activity on the channel.",

"type": "string"

},

"timestamp": {

"format": "date-time",

"description": "Contains the date and time that the message was sent, in UTC, expressed in ISO-8601 format.",

"type": "string"

},

"localTimestamp": {

"format": "date-time",

"description": "Contains the local date and time of the message, expressed in ISO-8601 format.\r\nFor example, 2016-09-23T13:07:49.4714686-07:00.",

"type": "string"

},

"localTimezone": {

"description": "Contains the name of the local timezone of the message, expressed in IANA Time Zone database format.\r\nFor example, America/Los_Angeles.",

"type": "string"

},

"callerId": {

"description": "A string containing an IRI identifying the caller of a bot. This field is not intended to be transmitted\r\nover the wire, but is instead populated by bots and clients based on cryptographically verifiable data\r\nthat asserts the identity of the callers (e.g. tokens).",

"type": "string"

},

"serviceUrl": {

"description": "Contains the URL that specifies the channel's service endpoint. Set by the channel.",

"type": "string"

},

"channelId": {

"description": "Contains an ID that uniquely identifies the channel. Set by the channel.",

"type": "string"

},

"from": {

"$ref": "#/definitions/ChannelAccount",

"description": "Identifies the sender of the message."

},

"conversation": {

"$ref": "#/definitions/ConversationAccount",

"description": "Identifies the conversation to which the activity belongs."

},

"recipient": {

"$ref": "#/definitions/ChannelAccount",

"description": "Identifies the recipient of the message."

},

"textFormat": {

"$ref": "#/definitions/TextFormatTypes",

"description": "Format of text fields Default:markdown"

},

"attachmentLayout": {

"$ref": "#/definitions/AttachmentLayoutTypes",

"description": "The layout hint for multiple attachments. Default: list."

},

"membersAdded": {

"description": "The collection of members added to the conversation.",

"type": "array",

"items": {

"$ref": "#/definitions/ChannelAccount"

}

},

"membersRemoved": {

"description": "The collection of members removed from the conversation.",

"type": "array",

"items": {

"$ref": "#/definitions/ChannelAccount"

}

},

"reactionsAdded": {

"description": "The collection of reactions added to the conversation.",

"type": "array",