Ask

This activity sends a question to an existing chat conversation and returns the answer received. A timeout value can be configured to complete the activity if an answer is not received within the timeout period (default is 60 seconds).

Table 1. Ask action - Inputs
Parameters Description

ConversationId

Unique identifier for the conversation.

BodyObject

JSON formatted content of the message for messages not of type 'Text'.

TimeoutSeconds

Amount of time in seconds to wait for a response to be received.

ContentType

Indicates the content type of the message to be sent. Options are 'Text', 'Html', 'Whisper', 'Location' or 'Action Card'.

Body

Content of the message, if it is of type 'Text'.

Table 2. Ask action - Outputs
Parameters Description

Result

Returns the JSON formatted response from the activity.

Answer

Response received.

BranchId

Returns 'Responses' if responses are received or 'Timeout' if no response is received before the timeout period.

BranchResult

Response received.

Success

Indicates whether the activity was completed successfully (value = True) or not (value = False).