Retrieve Call Data - Vocode

Call Objects

With the Vocode API in-progress and completed calls are accessible as Call objects.

To list your call history:

calls = vocode_client.calls.list_calls()

const calls = await vocode.calls.listCalls();

curl --request GET \
  --url https://api.vocode.dev/v1/calls/list \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <API_KEY>'

The resulting list of Call objects is structured like this:

[
  {
    id: 'call_id',
    userId: 'user_id',
    toNumber: '123456789',
    fromNumber: '123456789',
    agent: {
      id: 'agent_id',
      userId: 'user_id',
      prompt: 'The assistant is having a pleasant conversation about life.',
      actions: [],
      voice: [Object],
      initialMessage: undefined,
      webhook: undefined
    },
    goal: undefined,
    transcript: undefined,
    recordingUrl: undefined,
    status: 'ended',
    errorMessage: undefined,
    recordingAvailable: false
  }
]

Get a specific call

If you have a call ID, you can get the call object for that call.

vocode_client.calls.get_call(id="CALL_ID")

const calls = await vocode.calls.getCall({ id: "CALL_ID" });

curl --request GET \
  --url https://api.vocode.dev/v1/calls/recording/<CALL_ID> \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <API_KEY>'

Download a call recording

If you enabled call recording, you can download the call recording file.

vocode_client.calls.get_recording(id="CALL_ID")

const calls = await vocode.calls.listCalls();
const recording = await vocode.calls.get_recording({ id: calls[0].id });

curl --request GET \
  --url https://api.vocode.dev/v1/calls/recording/<CALL_ID> \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <API_KEY>'