Response

Parameters
Sample Code

Property Name

Type

Description

Notes

Result

Object

Represents the result for talking with the client (speech or text).

Required

Result.IntroSpeakOut

String

Sentence to say in the agent’s language

Required

ForceIntent

Object

Any connected webhook service has the option to change the context of the response and switch between intents. This action will cancel execution of any other action if filled.

ForceIntent.IntentName

String

Which intent to switch to — must be in the same agent.

Required if change context is wanted

ForceIntent.Parameters[]

List

The forced intent can receive parameters with values, if the intent already contains these parameters in the parameter section in the intent

ForceIntent.Parameters[].Name

String

Parameter’s name (same as the parameter in the intent structure)

ForceIntent.Parameters[].Value

String

Value of the Parameter that will be injected

Should represent the entity’s type. For example, a parameter of type sys.number cannot accept characters as a value.

ForceIntent.Parameters[].Type

String

The type of parameter, which is the entity name.

The entity of the parameter as inserted on the developers platform

SessionParameters[]

List

Can be as additional data of their own or to update current parameters to different values.

-

SessionParameters[].Name

List

Parameter’s name (same as the parameter in the intent structure)

-

SessionParameters[].Value

List

Value of the Parameter that will be injected

-

SessionParameters[].Type

List

The type of parameter, which is the entity name.

-

{
"Result": {
"IntroSpeakOut": string,
"FlowResponse" [Optional] : string [For visual builder flow]
},
"SessionParameters" [Optional]:[
{
"Name": string,
"Type": string,
"Value": string
}
] ,
"ForceIntent" [Optional] : {
"IntentName": string
}
}