Read the Outcome of a Call

GET /v1/calls/{call_id}/outcomes

Answers the Call's Outcome (1.56.0, FR-calls-16): its status and every field of its schema with its method, confidence and, with calls:read, the value of each phi: false field whose type is not free text; include=values adds every other value, needs transcripts:read and is an audited content read. While an outcomes analysis retries a failed extraction the status is pending. A Call whose Agent version has no Outcome schema, or that is not finalized, has none: 404 not_found.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the calls:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/calls/call_.../outcomes" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/calls/call_.../outcomes`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/calls/call_.../outcomes",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is Outcome.