POposhbotio
Conversations

UpdateActivity

Edit an existing activity.

Some channels allow you to edit an existing activity to reflect the new state of a bot conversation.

For example, you can remove buttons after someone has clicked "Approve" button.

put/v3/conversations/{conversationId}/activities/{activityId}

Request

Path parameters

conversationIdstring required

Conversation ID

activityIdstring required

activityId to update

Request body

type'message' | 'contactRelationUpdate' | 'conversationUpdate' | 'typing' | 'ping' | 'endOfConversation' | 'event' | 'invoke' | 'deleteUserData' | 'messageUpdate' | 'messageDelete' | 'installationUpdate' | 'messageReaction' | 'suggestion' | 'trace'

Types of Activities

idstring

ID of this activity

timestampstring date-time

UTC Time when message was sent (set by service)

localTimestampstring date-time

Local time when message was sent (set by client, Ex: 2016-09-23T13:07:49.4714686-07:00)

serviceUrlstring

Service endpoint where operations concerning the activity may be performed

channelIdstring

ID of the channel where the activity was sent

textFormat'markdown' | 'plain' | 'xml'

Text format types

attachmentLayout'list' | 'carousel'

Attachment layout types

topicNamestring

The conversation's updated topic name

historyDisclosedboolean

True if prior history of the channel is disclosed

localestring

The language code of the Text field

textstring

Content for the message

speakstring

SSML Speak for TTS audio response

inputHint'acceptingInput' | 'ignoringInput' | 'expectingInput'

Indicates whether the bot is accepting, expecting, or ignoring input

summarystring

Text to display if the channel cannot render cards

channelDataobject

Channel-specific payload

actionstring

ContactAdded/Removed action

replyToIdstring

The original ID this message is a response to

labelstring

Descriptive label

valueTypestring

Unique string which identifies the shape of the value object

valueobject

Open-ended value

namestring

Name of the operation to invoke or the name of the event

code'unknown' | 'completedSuccessfully' | 'userCancelled' | 'botTimedOut' | 'botIssuedInvalidMessage' | 'channelFailed'

Codes indicating why a conversation has ended

expirationstring date-time

DateTime to expire the activity as ISO 8601 encoded datetime

importancestring

Importance of this activity {Low|Normal|High}, null value indicates Normal importance see ActivityImportance)

deliveryModestring

Hint to describe how this activity should be delivered.
Currently: null or "Default" = default delivery "Notification" = notification semantics

Response

An object will be returned containing the ID for the resource.

idstring

Id of the resource

Changes

No recorded changes to this operation across all 1 revision of this API.