Follow-ups

Use the Conversations API to identify an action item that requires a follow-up task; in general or by someone in the conversation.

Some examples of follow-ups:

  • "I will sync up with my manager and find out the agreed dates with the vendor." Here a person needs to follow up with their manager in order to complete this action.

  • “We’ll need to set up a meeting with the design team to find out more details.” Here one or more people need to organize and schedule a meeting with the design team.

  • “I will probably sync up with you tomorrow on this.” It’s clear that there needs to be a follow-up, but the tone doesn’t indicate whether it is the final decision. It just indicates the possibility of a sync up the next day.

  • “I may have to schedule a meeting with the client to discuss this further.” In this case, although there needs to be further discussion with the client on the matter, it is not clear whether that will happen or not.

Authentication

This request requires an access token, as described in Authenticate.


Get follow-ups

This section describes how to get follow-ups from a conversation. This request requires a conversation ID. You receive a conversation ID when you process a conversation with the Symbl.ai APIs. For a complete description of the API request, see Get follow-ups.

To get follow-ups, use the GET <https://api.symbl.ai/v1/conversations/><CONVERSATION_ID>/follow-ups operation:

👍

Try our interactive examples!

We provide interactive versions of these code samples: curl, Node.js, Python

To get started with our code samples, see Set Up Your Test Environment.

ACCESS_TOKEN="<ACCESS_TOKEN>"
CONVERSATION_ID="<CONVERSATION_ID>"

curl --request GET \
  --url "https://api.symbl.ai/v1/conversations/$CONVERSATION_ID/follow-ups" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "Content-Type: application/json"
import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';
const conversationId = '<CONVERSATION_ID>';

const fetchResponse = await fetch(`https://api.symbl.ai/v1/conversations/${conversationId}/follow-ups`, {
  method: 'get',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(JSON.stringify(responseBody, null, 2));
import json
import requests

access_token = "<ACCESS_TOKEN>"
conversation_id = "<CONVERSATION_ID>"

headers = {
  "Authorization": "Bearer " + access_token,
  "Content-Type": "application/json"
}

response = requests.request(
  method="GET", 
  url="https://api.symbl.ai/v1/conversations/" + conversation_id + "/follow-ups",
  headers=headers
)

print(json.dumps(response.json(), indent=2))

Where:

For additional reference information, see Retrieve Follow-Ups by conversation ID.

Example response

{
  "followUps": [
    {
      "id": "6355531491966976",
      "text": "I can send it internet service technician to your home whenever you're free.",
      "type": "follow_up",
      "score": 1,
      "messageIds": [
        "6633702162432000"
      ],
      "entities": [],
      "phrases": [],
      "from": {},
      "definitive": false,
      "assignee": {}
    }
  ]
}