GET 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

curl "https://api.symbl.ai/v1/conversations/$CONVERSATION_ID/follow-ups" \

-H "Authorization: Bearer $AUTH_TOKEN"

Node.js

const request = require('request');

const authToken = AUTH_TOKEN;

const conversationId = CONVERSATION_ID;

request.get({

url: `https://api.symbl.ai/v1/conversations/${conversationId}/follow-ups`,

headers: { 'Authorization': `Bearer ${authToken}` },

json: true

}, (err, response, body) => {

console.log(body);

});

Python

import requests

baseUrl = "https://api.symbl.ai/v1/conversations/{conversationId}/follow-ups"

conversationId = 'your_conversation_id' # Generated using Submit text end point

url = baseUrl.format(conversationId=conversationId)

# set your access token here. See https://docs.symbl.ai/docs/developer-tools/authentication

access_token = 'your_access_token'

headers = {

'Authorization': 'Bearer ' + access_token,

'Content-Type': 'application/json'

}

responses = {

401: 'Unauthorized. Please generate a new access token.',

404: 'The conversation and/or it\'s metadata you asked could not be found, please check the input provided',

500: 'Something went wrong! Please contact support@symbl.ai'

}

response = requests.request("GET", url, headers=headers)

if response.status_code == 200:

# Successful API execution

print("followUps => " + str(response.json()['followUps'])) # followUps object containing followUp id, text, type, score, messageIds, entities, from, assignee, phrases

elif response.status_code in responses.keys():

print(responses[response.status_code]) # Expected error occurred

else:

print("Unexpected error occurred. Please contact support@symbl.ai" + ", Debug Message => " + str(response.text))

exit()

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 proprities 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.