Skip to main content
GET
/
calls
List Calls
curl --request GET \
  --url https://api.revring.ai/v1/calls \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fromNumber": "<string>",
      "toNumber": "<string>",
      "initiatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentCallerIdName": "<string>",
      "agentName": "<string>",
      "variables": {},
      "recordingUrl": "<string>",
      "hangupCause": "<string>",
      "errorMessage": "<string>",
      "transcript": [
        {}
      ],
      "summary": "<string>",
      "metrics": {},
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "durationSeconds": 123
    }
  ],
  "page": 2,
  "pageSize": 50,
  "total": 123,
  "hasNextPage": true
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
pageSize
integer
default:25

Items per page

Required range: 1 <= x <= 100
​
sortBy
enum<string>
default:createdAt

Sort field

Available options:
createdAt,
startedAt,
endedAt,
durationSeconds,
status,
direction
​
sortDir
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
status
string

Filter by status (comma-separated)

​
direction
enum<string>

Filter by direction

Available options:
INBOUND,
OUTBOUND
​
agentId
string<uuid>

Filter by agent ID

​
folderId
string

Filter by the call's agent folder. Pass a folder ID to only return calls whose agent is in that folder, or none to only return calls whose agent has no folder. Calls whose agent has been deleted are not returned by this filter.

​
sipTrunkId
string<uuid>

Filter by SIP trunk ID

​
fromNumber
string

Filter by from number (E.164)

​
toNumber
string

Filter by to number (E.164)

​
createdFrom
string<date-time>

Filter by creation date (ISO 8601)

​
createdTo
string<date-time>

Filter by creation date (ISO 8601)

​
q
string

Search query

Maximum string length: 64

Response

Paginated list of calls

Paginated list of calls

​
data
object[]
required

Array of call records

​
page
integer
required

Current page number

Required range: x >= 1
​
pageSize
integer
required

Number of items per page

Required range: 1 <= x <= 100
​
total
integer
required

Total number of calls matching filters

​
hasNextPage
boolean
required

Whether there are more pages available