IConversation interface

Package:

botbuilder-calling

IConversation is a JSON body of a first request for new Skype voice call made by Skype Bot Platform for Calling to a bot. IConversation JSON body is posted on initial HTTPs endpoint registered by a bot developer in the Bot Framework Portal. IConversation request contains information about caller and target of the call and some additional information about initial state of a call.

Extends

IEvent

Properties

address	Address routing information for the event. Save this field to external storage somewhere to later compose a proactive message to the user.
agent	SDK thats processing the event. Will always be 'botbuilder'.
callState	Indicates the current state of the call.
links	Dictionary containing list of HTTPs links.
presentedModalityTypes	Flag indicates which modalities were presented by Skype user for a call.
source	The original source of the event (i.e. 'facebook', 'skype', 'slack', etc.)
sourceEvent	The original event in the sources native schema. For outgoing messages can be used to pass source specific event data like custom attachments.
type	Defines type of event. Should be 'message' for an IEvent.
user	For incoming event this is the user that sent the event. By default this is a copy of address.user but you can configure your bot with a lookupUser function that lets map the incoming user to an internal user id.

Property Details

address

Address routing information for the event. Save this field to external storage somewhere to later compose a proactive message to the user.

address: IAddress

Property Value

IAddress

agent

SDK thats processing the event. Will always be 'botbuilder'.

agent: string

Property Value

string

callState

Indicates the current state of the call.

callState: string

Property Value

string

links

Dictionary containing list of HTTPs links.

links?: any

Property Value

any

presentedModalityTypes

Flag indicates which modalities were presented by Skype user for a call.

presentedModalityTypes: string[]

Property Value

string[]

source

The original source of the event (i.e. 'facebook', 'skype', 'slack', etc.)

source: string

Property Value

string

sourceEvent

The original event in the sources native schema. For outgoing messages can be used to pass source specific event data like custom attachments.

sourceEvent: any

Property Value

any

type

Defines type of event. Should be 'message' for an IEvent.

type: string

Property Value

string

user

For incoming event this is the user that sent the event. By default this is a copy of address.user but you can configure your bot with a lookupUser function that lets map the incoming user to an internal user id.

user: IIdentity

Property Value

IIdentity