POST
/
autocompose
/
v1
/
conversations
/
{conversationId}
/
suggestions

Authorizations

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

Path Parameters

conversationId
string
required

The identifier for a conversation.

Body

application/json
The parameters for getting suggestions for the next agent message.

A suggestions request with an optional message to add to the conversation

query
string

text the agent has already entered into the composer

message
object

Represents a single message within a conversation.

Response

200
application/json
Successfully fetched suggestions for the conversation

Suggestions for next agent message

id
string

ID for the suggestions that were returned (to be used in analytics events)

message
object

Response for messages

suggestions
object[]
phraseCompletion
object

Completion of the phrase the agent is currently typing, to be displayed inline in the composer

autopilotMessage
object

Recommended message for the agent to autopilot send.