Skip to main content
POST
Analyze conversation

Authorizations

asapp-api-id
string
header
required
asapp-api-secret
string
header
required

Body

application/json

The parameters for triggering the analysis and response to a conversation

conversationId
string
required

Internal conversation identifier from ASAPP

Example:

"01BX5ZZKBKACTAV9WEVGEMMVS0"

streamId
string

The id associated with the connection where the responses should be sent to.

Example:

"97555020-0276-435f-8104-c378221ba292"

taskName
string

Name of the task to be used in the analysis

Example:

"UpgradePlan"

inputVariables
object

Input variables to be used as context in the analysis.

Example:
message
object

Represents a single message within a conversation.

Example:
channelType
enum<string>

Channel type used by the current request (digital or voice)

Available options:
digital,
voice
Example:

"digital"

Response

Successfully triggered the bot to analyze and respond to a conversation

Conversation identifier and message identifier if passed in the request

conversationId
string

Internal conversation identifier from ASAPP

Example:

"01BX5ZZKBKACTAV9WEVGEMMVS0"

messageId
string

Internal message identifier from ASAPP

Example:

"01BX5ZZKBKACTAV9WEVGEMMVS1"