Skip to main content
GET
/
api
/
deleted_calls
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/deleted_calls \
  --header 'X-API-Key: <api-key>'
{
  "results": [
    {
      "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "deletionTime": "2023-11-07T05:31:56Z",
      "endReason": "unjoined",
      "recordingEnabled": true,
      "hadSummary": true,
      "joined": "2023-11-07T05:31:56Z",
      "ended": "2023-11-07T05:31:56Z",
      "maxDuration": "3600s"
    }
  ],
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "total": 123
}

Authorizations

X-API-Key
string
header
required

API key

Query Parameters

agentIds
string<uuid>[]

Filter calls by the agent IDs.

cursor
string

The pagination cursor value.

durationMax
string

Maximum duration of calls

durationMin
string

Minimum duration of calls

fromDate
string<date-time>

Start datetime (inclusive) for filtering calls by creation date. If no time component is present, this defaults to the start of the day (midnight).

metadata
object

Filter calls by metadata. Use metadata.key=value to filter by specific key-value pairs.

pageSize
integer

Number of results to return per page.

The search string used to filter results

Minimum string length: 1
timeOfDayEnd
string<time>
default:23:59:59.999999

Filter calls by the time of day of their creation, regardless of date. Format: HH:MM:SS. Defaults to 23:59:59 if not specified.

timeOfDayStart
string<time>
default:00:00:00

Filter calls by the time of day of their creation, regardless of date. Format: HH:MM:SS. Defaults to 00:00:00 if not specified.

toDate
string<date-time>

End datetime (inclusive) for filtering calls by creation date. If no time component is present, this defaults to the end of the day (11:59:59.999999 PM).

voiceId
string<uuid>

Filter calls by the associated voice ID

Response

200 - application/json
results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"

total
integer
Example:

123