Get conversation intent

Retrieves the primary intent of a conversation, represented by both an intent code and a human-readable intent name. If no intent is detected, “NO_INTENT” is returned.

This endpoint requires:

1. Intent support to be explicitly enabled for your account.
2. A valid conversationId, which is an ASAPP-generated identifier created when using the ASAPP /conversations endpoint.

Use this endpoint to gain insights into the main purpose or topic of a conversation.

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Path Parameters

conversationId

string

required

The identifier for a conversation.

Response

200 - application/json

conversationId

string

The id of the conversation.

intent

object

An object containing the determined intent for the conversation.

Show child attributes

intent.code

string

The machine-readable code for the given conversation. If no intent was found, then "NO_INTENT" is returned.

intent.name

string

The human-readable name of the intent for the given conversation.