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
Javascript

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#

Field	Description
`id`	unique conversation identifier
`text`	conversation text
`type`	response type. default is follow_up
`score`	confidence score of the generated topic. value from 0 - 1
`messageIds`	unique message identifiers of the corresponding messages
`entities`	list of detected entity objects in the insight with `type` - entity type and `text` - corresponding text
`from`	user object with name and email
`assignee`	this field contains the name and email of the person assigned to the follow up
`phrases`	list of detected phrases with `type` - phrase type and `text` - corresponding text. The `action_phrase` type represents the actionable part of an insight