Share via

Activity interface

  • 참조
패키지:
botframework-schema

활동은 Bot Framework 3.0 프로토콜의 기본 통신 유형입니다.

속성

action

contactRelationUpdate의 받는 사람이 보낸 사람의 연락처 목록에서 추가 또는 제거되었는지 여부를 나타냅니다.
attachmentLayout

여러 첨부 파일에 대한 레이아웃 힌트입니다. 기본값: list. 가능한 값은 'list', 'carousel'입니다.
attachments

Attachments
callerId

봇의 호출자를 식별하는 URI를 포함하는 문자열입니다. 이 필드는 유선을 통해 전송되는 것이 아니라 호출자의 ID(예: 토큰)를 어설션하는 암호화 확인 가능한 데이터를 기반으로 하여 봇과 클라이언트에서 채워집니다.
channelData

채널별 콘텐츠를 포함합니다.
channelId

채널을 고유하게 식별하는 ID를 포함합니다. 채널별로 설정합니다.
code

대화가 종료된 이유를 나타내는 endOfConversation 활동에 대한 코드입니다. 가능한 값은 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'입니다.
conversation

활동이 속한 대화를 식별합니다.
deliveryMode

활동에 대한 받는 사람 대체 전송 경로에 신호를 보내는 전송 힌트입니다. 기본 배달 모드는 "기본값"입니다. 가능한 값은 'normal', 'notification', 'expectReplies', 'Ephemeral'입니다.
entities

메시지에 언급된 엔터티를 나타냅니다.
expiration

활동이 "만료된" 것으로 간주되고 받는 사람에게 표시되지 않아야 하는 시간입니다.
from

메시지의 발신자를 식별합니다.
historyDisclosed

채널의 이전 기록이 공개되는지 여부를 나타냅니다.
id

채널에서 활동을 고유하게 식별하는 ID를 포함합니다.
importance

활동의 중요도입니다. 가능한 값은 'low', 'normal', 'high'입니다.
inputHint

메시지가 클라이언트에 전달된 후 봇이 사용자 입력을 수락, 예상 또는 무시할지 여부를 나타냅니다. 가능한 값은 'acceptingInput', 'ignoringInput', 'expectingInput'입니다.
label

활동에 대한 설명이 포함된 레이블입니다.
listenFor

음성 및 언어 초기화 시스템에서 수신해야 하는 구 및 참조 목록
locale

텍스트 필드의 내용에 대한 로캘 이름입니다. 로캘 이름은 언어와 연결된 ISO 639 2자 또는 3자 문화권 코드와 국가 또는 지역과 연결된 ISO 3166 2자 하위 문화권 코드의 조합입니다. 로캘 이름은 유효한 BCP-47 언어 태그에도 해당할 수 있습니다.
localTimestamp

ISO-8601 형식으로 표현된 메시지의 로컬 날짜 및 시간을 포함합니다. 예를 들어 2016-09-23T13:07:49.4714686-07:00입니다.
localTimezone

IANA 표준 시간대 데이터베이스 형식으로 표시되는 메시지의 로컬 표준 시간대 이름을 포함합니다. 예를 들어 America/Los_Angeles와 같습니다.
membersAdded

대화에 추가된 멤버의 컬렉션입니다.
membersRemoved

대화에서 제거된 멤버의 컬렉션입니다.
name

호출 또는 이벤트 활동과 연결된 작업의 이름입니다.
reactionsAdded

대화에 추가된 반응의 컬렉션입니다.
reactionsRemoved

대화에서 제거된 반응의 컬렉션입니다.
recipient

메시지의 받는 사람을 식별합니다.
relatesTo

다른 대화 또는 활동에 대한 참조입니다.
replyToId

이 메시지가 회신인 메시지의 ID를 포함합니다.
semanticAction

이 요청과 함께 제공되는 선택적 프로그래밍 작업
serviceUrl

채널의 서비스 엔드포인트를 지정하는 URL을 포함합니다. 채널별로 설정합니다.
speak

읽을 텍스트입니다.
suggestedActions

활동에 대해 제안된 작업입니다.
summary

채널이 카드를 렌더링할 수 없는 경우 표시할 텍스트입니다.
text

메시지의 텍스트 내용입니다.
textFormat

텍스트 필드의 형식 기본값:markdown입니다. 가능한 값은 'markdown', 'plain', 'xml'입니다.
textHighlights

활동에 ReplyToId 값이 포함되어 있을 때 강조 표시할 텍스트 조각의 컬렉션입니다.
timestamp

ISO-8601 형식으로 표현된 메시지를 보낸 날짜와 시간을 UTC로 포함합니다.
topicName

대화의 업데이트된 토픽 이름입니다.
type

활동 유형을 포함합니다. 가능한 값은 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'입니다.
value

활동과 연결된 값입니다.
valueType

활동의 값 개체에 대한 형식입니다.

속성 세부 정보

action

contactRelationUpdate의 받는 사람이 보낸 사람의 연락처 목록에서 추가 또는 제거되었는지 여부를 나타냅니다.

action?: string

속성 값

string

attachmentLayout

여러 첨부 파일에 대한 레이아웃 힌트입니다. 기본값: list. 가능한 값은 'list', 'carousel'입니다.

attachmentLayout?: AttachmentLayoutTypes | string

속성 값

AttachmentLayoutTypes | string

attachments

Attachments

attachments?: Attachment[]

속성 값

Attachment[]

callerId

봇의 호출자를 식별하는 URI를 포함하는 문자열입니다. 이 필드는 유선을 통해 전송되는 것이 아니라 호출자의 ID(예: 토큰)를 어설션하는 암호화 확인 가능한 데이터를 기반으로 하여 봇과 클라이언트에서 채워집니다.

callerId: string

속성 값

string

channelData

채널별 콘텐츠를 포함합니다.

channelData?: any

속성 값

any

channelId

채널을 고유하게 식별하는 ID를 포함합니다. 채널별로 설정합니다.

channelId: string

속성 값

string

code

대화가 종료된 이유를 나타내는 endOfConversation 활동에 대한 코드입니다. 가능한 값은 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'입니다.

code?: EndOfConversationCodes | string

속성 값

EndOfConversationCodes | string

conversation

활동이 속한 대화를 식별합니다.

conversation: ConversationAccount

속성 값

ConversationAccount

deliveryMode

활동에 대한 받는 사람 대체 전송 경로에 신호를 보내는 전송 힌트입니다. 기본 배달 모드는 "기본값"입니다. 가능한 값은 'normal', 'notification', 'expectReplies', 'Ephemeral'입니다.

deliveryMode?: DeliveryModes | string

속성 값

DeliveryModes | string

entities

메시지에 언급된 엔터티를 나타냅니다.

entities?: Entity[]

속성 값

Entity[]

expiration

활동이 "만료된" 것으로 간주되고 받는 사람에게 표시되지 않아야 하는 시간입니다.

expiration?: Date

속성 값

Date

from

메시지의 발신자를 식별합니다.

from: ChannelAccount

속성 값

ChannelAccount

historyDisclosed

채널의 이전 기록이 공개되는지 여부를 나타냅니다.

historyDisclosed?: boolean

속성 값

boolean

id

채널에서 활동을 고유하게 식별하는 ID를 포함합니다.

id?: string

속성 값

string

importance

활동의 중요도입니다. 가능한 값은 'low', 'normal', 'high'입니다.

importance?: ActivityImportance | string

속성 값

ActivityImportance | string

inputHint

메시지가 클라이언트에 전달된 후 봇이 사용자 입력을 수락, 예상 또는 무시할지 여부를 나타냅니다. 가능한 값은 'acceptingInput', 'ignoringInput', 'expectingInput'입니다.

inputHint?: InputHints | string

속성 값

InputHints | string

label

활동에 대한 설명이 포함된 레이블입니다.

label: string

속성 값

string

listenFor

음성 및 언어 초기화 시스템에서 수신해야 하는 구 및 참조 목록

listenFor: string[]

속성 값

string[]

locale

텍스트 필드의 내용에 대한 로캘 이름입니다. 로캘 이름은 언어와 연결된 ISO 639 2자 또는 3자 문화권 코드와 국가 또는 지역과 연결된 ISO 3166 2자 하위 문화권 코드의 조합입니다. 로캘 이름은 유효한 BCP-47 언어 태그에도 해당할 수 있습니다.

locale?: string

속성 값

string

localTimestamp

ISO-8601 형식으로 표현된 메시지의 로컬 날짜 및 시간을 포함합니다. 예를 들어 2016-09-23T13:07:49.4714686-07:00입니다.

localTimestamp?: Date

속성 값

Date

localTimezone

IANA 표준 시간대 데이터베이스 형식으로 표시되는 메시지의 로컬 표준 시간대 이름을 포함합니다. 예를 들어 America/Los_Angeles와 같습니다.

localTimezone: string

속성 값

string

membersAdded

대화에 추가된 멤버의 컬렉션입니다.

membersAdded?: ChannelAccount[]

속성 값

ChannelAccount[]

membersRemoved

대화에서 제거된 멤버의 컬렉션입니다.

membersRemoved?: ChannelAccount[]

속성 값

ChannelAccount[]

name

호출 또는 이벤트 활동과 연결된 작업의 이름입니다.

name?: ActivityEventNames | string

속성 값

ActivityEventNames | string

reactionsAdded

대화에 추가된 반응의 컬렉션입니다.

reactionsAdded?: MessageReaction[]

속성 값

MessageReaction[]

reactionsRemoved

대화에서 제거된 반응의 컬렉션입니다.

reactionsRemoved?: MessageReaction[]

속성 값

MessageReaction[]

recipient

메시지의 받는 사람을 식별합니다.

recipient: ChannelAccount

속성 값

ChannelAccount

relatesTo

다른 대화 또는 활동에 대한 참조입니다.

relatesTo?: ConversationReference

속성 값

ConversationReference

replyToId

이 메시지가 회신인 메시지의 ID를 포함합니다.

replyToId?: string

속성 값

string

semanticAction

이 요청과 함께 제공되는 선택적 프로그래밍 작업

semanticAction?: SemanticAction

속성 값

SemanticAction

serviceUrl

채널의 서비스 엔드포인트를 지정하는 URL을 포함합니다. 채널별로 설정합니다.

serviceUrl: string

속성 값

string

speak

읽을 텍스트입니다.

speak?: string

속성 값

string

suggestedActions

활동에 대해 제안된 작업입니다.

suggestedActions?: SuggestedActions

속성 값

SuggestedActions

summary

채널이 카드를 렌더링할 수 없는 경우 표시할 텍스트입니다.

summary?: string

속성 값

string

text

메시지의 텍스트 내용입니다.

text: string

속성 값

string

textFormat

텍스트 필드의 형식 기본값:markdown입니다. 가능한 값은 'markdown', 'plain', 'xml'입니다.

textFormat?: TextFormatTypes | string

속성 값

TextFormatTypes | string

textHighlights

활동에 ReplyToId 값이 포함되어 있을 때 강조 표시할 텍스트 조각의 컬렉션입니다.

textHighlights?: TextHighlight[]

속성 값

TextHighlight[]

timestamp

ISO-8601 형식으로 표현된 메시지를 보낸 날짜와 시간을 UTC로 포함합니다.

timestamp?: Date

속성 값

Date

topicName

대화의 업데이트된 토픽 이름입니다.

topicName?: string

속성 값

string

type

활동 유형을 포함합니다. 가능한 값은 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'입니다.

type: ActivityTypes | string

속성 값

ActivityTypes | string

value

활동과 연결된 값입니다.

value?: any

속성 값

any

valueType

활동의 값 개체에 대한 형식입니다.

valueType: string

속성 값

string