Calls

Download a recording

GEThttps://voxa.abhinavyadav.in/api/v1/calls/{call_id}/recording

The call’s stereo WAV recording (caller on the left channel, agent on the right). Add download=true to get it as an attachment. Returns 404 when the call wasn’t recorded.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the calls.view permission.

X-API-KeyAuthorization: Bearercalls.view

Path parameters

call_idstringrequired

The call's id.

Query parameters

downloadbooleandefault: false

Send as an attachment (Content-Disposition).

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.

The file itself (audio/wav).

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request GET \
  --url 'https://voxa.abhinavyadav.in/api/v1/calls/{call_id}/recording?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>' \
  --output response.wav

import requests

url = "https://voxa.abhinavyadav.in/api/v1/calls/{call_id}/recording"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}

response = requests.get(url, params=params, headers=headers)
response.raise_for_status()
with open("response.wav", "wb") as f:
    f.write(response.content)

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/calls/{call_id}/recording?timezone=Asia/Kolkata", {
  headers: {
    "X-API-Key": "<api-key>",
  },
})
const file = await response.blob()

Response

A file (audio/wav).

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (calls.view)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}

{
  "detail": "rate limit exceeded; slow down"
}