Calls

Export Calls

GEThttps://voxa.abhinavyadav.in/api/v1/calls/export

Calls as CSV, newest first: one row per call with its outcome, cost, summary and one column per extracted field (extracted.<key>). At most 50,000 rows.

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

Query parameters

daysintegerdefault: 30

calls from the last N days

1 to 365

agent_idstring

The agent's id.

at most 64 characters

statusstring

comma-separated statuses

at most 80 characters

directionstring

at most 10 characters

timezonestringdefault: "Asia/Kolkata"

IANA zone for created_at

at most 64 characters

Response

200Success.

No body.

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/export?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>'

import requests

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

response = requests.get(url, params=params, headers=headers)
print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/calls/export?timezone=Asia/Kolkata", {
  headers: {
    "X-API-Key": "<api-key>",
  },
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "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"
}