Answer Server 12.13

# Converse

Starts or continues a conversation with a user, using an existing session token.

The `Converse` action requires the SystemName of your configured conversation system, and a SessionID (session token) for your conversation. You create the session token by using the ManageResources action. You can retrieve the IDs of existing conversation sessions by sending the GetResources action with Type set to `conversation_session`.

When you want to start a conversation, you can send `Converse` with only the SystemName and SessionID parameters. In this case, Answer Server runs the conversation task that has the initial state trigger (for example, a default greeting). If you do not have a configured task with the initial state trigger, Answer Server runs the conversation task that has the empty state trigger.

For more information about task triggers, refer to the Answer Server Administration Guide.

After the start of the conversation, you provide user text in the Text parameter. Answer Server processes the user text according to your task configuration, running the appropriate conversation tasks. The action response includes the result of the current task action, which might be a text reply, a request for information, or an acknowledgment, depending on your task configuration.

You continue the conversation by sending further `Converse` actions with the same SessionID.

## Example

    http://12.3.4.56:12000/action=Converse&SystemName=MyConversation&SessionID=860028728520387723

This action starts a conversation with session ID 860028728520387723 (previously created by using ManageResources).

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
SessionID | The session token for the conversation session.
SystemName | The system that you want to use to converse with the user.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Text | The text that the user supplies.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
EncryptResponse | Encrypt the output.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

## Response

You can retrieve the full response XSD by sending the GetResources action with Type set to `XSD`.

© Copyright 2016-2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Answer Server 12.13

Topic Title: Converse