Calls

Getting a Call Log

Manage external call logs.

This view provides endpoints to retrieve, delete, and list call logs for external users. A call log represents a record of a communication event, including details such as the agent involved, the call ID, and the outcome of the call. This information is crucial for monitoring and evaluating the performance of agents and the quality of interactions.

Required only when call_logs is “all” OR is number of first N calls. Only either of agent_id or assistant_id is required

GET

observability

call-logs-external

{id}

curl --request GET \
  --url https://new-prod.vocera.ai/observability/v1/call-logs-external/{id}/ \
  --header 'X-VOCERA-API-KEY: <api-key>'

{
  "id": 123,
  "duration": "<string>",
  "voice_recording_url": "<string>",
  "critical_categories": "<string>",
  "status": "success",
  "agent_id": "<string>",
  "assistant_id": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "success": true,
  "is_reviewed": true,
  "feedback": "<string>",
  "evaluation": "<any>",
  "transcript": "<string>",
  "transcript_object": "<any>",
  "call_ended_reason": "<string>",
  "dropoff_point": "<string>",
  "dropoff_reason": "<string>",
  "topic": "<string>",
  "customer_number": "<string>",
  "user_generated_transcript": "<any>",
  "metadata": "<any>",
  "dynamic_variables": "<any>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "call_id": "<string>",
  "agent": 123
}

Authorizations

X-VOCERA-API-KEY

string

header

required

API Key Authentication. It should be included in the header of each request.

Path Parameters

string

required

Response

200

application/json

integer

required

duration

string

required

Duration of the call in MM:SS format

voice_recording_url

string

required

URL to access the voice recording file

critical_categories

string

required

List of critical categories identified in the call evaluation

created_at

string

required

updated_at

string

required

call_id

string

required

Maximum length: 100

status

enum<string>

Current status of the call log

success - Success
failure - Failure
reviewed_success - Reviewed Success
reviewed_failure - Reviewed Failure

Available options:

success,

failure,

reviewed_success,

reviewed_failure

agent_id

string

ID of the agent associated with this call log

assistant_id

string

ID of the assistant associated with this call log

timestamp

string

success

boolean | null

is_reviewed

boolean

feedback

string

evaluation

any | null

transcript

string

transcript_object

any | null

call_ended_reason

string

Maximum length: 100

dropoff_point

string

Maximum length: 1000

dropoff_reason

string

Maximum length: 1000

topic

string

Maximum length: 1000

customer_number

string

Maximum length: 15

user_generated_transcript

any | null

metadata

any

dynamic_variables

any

agent

integer | null

Observing Calls Getting Call Logs

curl --request GET \
  --url https://new-prod.vocera.ai/observability/v1/call-logs-external/{id}/ \
  --header 'X-VOCERA-API-KEY: <api-key>'

{
  "id": 123,
  "duration": "<string>",
  "voice_recording_url": "<string>",
  "critical_categories": "<string>",
  "status": "success",
  "agent_id": "<string>",
  "assistant_id": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "success": true,
  "is_reviewed": true,
  "feedback": "<string>",
  "evaluation": "<any>",
  "transcript": "<string>",
  "transcript_object": "<any>",
  "call_ended_reason": "<string>",
  "dropoff_point": "<string>",
  "dropoff_reason": "<string>",
  "topic": "<string>",
  "customer_number": "<string>",
  "user_generated_transcript": "<any>",
  "metadata": "<any>",
  "dynamic_variables": "<any>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "call_id": "<string>",
  "agent": 123
}

API Reference

Authorizations

Path Parameters

Response