VoiceGateway

List call summaries in a project, filtered and sorted on the server

GET
/api/v1/org/{orgId}/project/{projectId}/calls

Authorization

cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length
projectId*string

Authorised projectId; the server must verify organisation/project ownership before any read.

Length1 <= length

Query Parameters

limit?integer

Page size, 1 to 100; omitted means 25.

Range1 <= value <= 100
Default25
cursor?string

Opaque nextCursor from prior response.

snapshot?string

Snapshot from prior response; required with cursor. It expires a day after the first page; an expired, unknown or malformed snapshot, or one sent for another project or other filters, is 400 invalid_request.

from?string

Inclusive UTC start boundary applied to call startedAt.

Formatdate-time
to?string

Exclusive UTC end boundary applied to call startedAt.

Formatdate-time
room?string

Exact room-name filter; may return multiple conversations.

channel?array<>

How the call reached the agent. Repeat to match any listed channel.

issues?array<>

Highest finding severity on the call: high, medium, or none for calls with neither. Repeat to match any.

answerMsMin?number

Inclusive lower bound on the call's median answer time in milliseconds. Calls with an unknown answer time never match a bound.

Range0 <= value
answerMsMax?number

Inclusive upper bound on the call's median answer time in milliseconds. Calls with an unknown answer time never match a bound.

Range0 <= value
durationSecondsMin?number

Inclusive lower bound on call length in seconds. Unknown lengths never match a bound.

Range0 <= value
durationSecondsMax?number

Inclusive upper bound on call length in seconds. Unknown lengths never match a bound.

Range0 <= value
turnsMin?integer

Inclusive lower bound on agent turns. Unknown counts never match a bound.

Range0 <= value
turnsMax?integer

Inclusive upper bound on agent turns. Unknown counts never match a bound.

Range0 <= value
unknown?array<>

Only calls where every listed value is unknown. This is how the console's "is empty" filter reaches the server; an unknown value is never matched as zero.

field?array<>

An SDK call field as key:value. Repeat to keep calls holding every listed pair; one key with two values matches nothing. At most 16. An embed token without transcriptsAndAudio gets 403.

Itemsitems <= 16
tag?array<>

User tag. Repeat to match calls carrying any listed tag.

recorded?boolean

true for calls with a retained recording, false for calls without one. Omitted means both.

archived?boolean

true for archived calls only, false for unarchived only. Omitted means both.

sort?string

Sort key, applied on the server before paging. Unknown values sort after known values in both orders; ties break by id. A cursor is bound to the filters, sort and order it was issued for: changing any of them with a cursor is invalid_request.

Default"startedAt"
Value in"startedAt""durationSeconds""turnCount""answerMs""issues"
order?string

Sort direction.

Default"desc"
Value in"asc""desc"

Response Body

Authorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.

application/json
  1. response
items*array<>
page*
totals*

Figures over every call matching a listCalls request's range and filters, independent of paging. Design-preview calls are never counted.

Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/calls'
Example Response
{  "items": [    {      "id": "string",      "room": "string",      "roomSid": "string",      "startedAt": "2019-08-24T14:15:22Z",      "endedAt": "2019-08-24T14:15:22Z",      "durationSeconds": 0,      "participantCount": 0,      "endState": "observed",      "channel": "phone",      "pipeline": "cascaded",      "models": [        "string"      ],      "agentKey": "string",      "turnCount": 0,      "answerMs": [        0      ],      "answerMsMedian": 0,      "issues": {        "high": 0,        "medium": 0,        "titles": [          "string"        ]      },      "tags": [        "string"      ],      "archived": true,      "recorded": true    }  ],  "page": {    "nextCursor": "string",    "snapshot": "string"  },  "totals": {    "callCount": 0,    "byChannel": {      "phone": 0,      "web": 0,      "console": 0,      "local": 0,      "unknown": 0    },    "answers": {      "turns": 0,      "overBudget": 0,      "budgetMs": 100,      "p50Ms": 0,      "valuesMs": [        0      ],      "valuesTruncated": true    },    "issues": {      "high": 0,      "medium": 0,      "none": 0,      "unknown": 0    },    "recorded": 0  }}

Was this page helpful?