Receive Follow-Ups

This API returns list of all the follow ups generated from the conversation.

This is a category of action items with a connotation to follow-up a request or a task like sending an email or making a phone call or booking an appointment or setting up a meeting.

HTTP Request#

GET https://api.symbl.ai/v1/conversations/{conversationId}/follow-ups

Example API call#

curl "https://api.symbl.ai/v1/conversations/{conversationId}/follow-ups" \
-H "x-api-key: <api_token>"

Response#

{
"followUps": [
{
"id": "4526427164639111",
"text": "We need to have the meeting today, and we're going to talk about how to run a product strategy Workshop is by Richard Holmes.",
"type": "follow_up",
"score": 0.8660254037851491,
"messageIds": [
"4675554024357888"
],
"entities": [
{
"type": "date",
"text": "today",
"offset": 28,
"value": "2020-06-22"
},
{
"type": "person",
"text": "Richard Holmes",
"offset": 110,
"value": {
"name": "Richard Holmes"
}
}
],
"from": {},
"assignee": {},
"dueBy": "2020-06-22T07:00:00.000Z"
}
]
}

Response Object#

FieldDescription
idunique conversation identifier
textconversation text
typeresponse type. default is follow_up
scoreconfidence score of the generated topic. value from 0 - 1
messageIdsunique message identifiers of the corresponding messages
entitieslist of detected entity objects in the insight with type - entity type and text - corresponding text
fromuser object with name and email
assigneethis field contains the name and email of the person assigned to the follow up
phraseslist of detected phrases with type - phrase type and text - corresponding text. The action_phrase type represents the actionable part of an insight