List 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",
      "direction": "INBOUND",
      "status": "INITIATED",
      "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,
      "postCallWebhookStatus": "<string>",
      "preCallWebhookStatus": "<string>"
    }
  ],
  "page": 2,
  "pageSize": 50,
  "total": 123,
  "hasNextPage": true
}

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",
      "direction": "INBOUND",
      "status": "INITIATED",
      "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,
      "postCallWebhookStatus": "<string>",
      "preCallWebhookStatus": "<string>"
    }
  ],
  "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

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)

string

Search query

Maximum string length: 64

Response

Paginated list of calls

data

object[]

required

Array of call records

Show child attributes

data.id

string<uuid>

required

data.organizationId

string<uuid>

required

data.direction

enum<string>

required

Call direction

Available options:

INBOUND,

OUTBOUND

data.status

enum<string>

required

Current call status

Available options:

INITIATED,

ONGOING,

TRANSFERRED,

COMPLETED,

FAILED,

CANCELED

data.fromNumber

string

required

Caller's number (E.164)

data.toNumber

string

required

Called number (E.164)

data.initiatedAt

string<date-time>

required

When call was initiated

data.createdAt

string<date-time>

required

data.updatedAt

string<date-time>

required

data.agentId

string<uuid> | null

data.sipTrunkId

string<uuid> | null

data.agentCallerIdName

string | null

Caller ID name shown to recipient

data.agentName

string | null

Name of the agent that handled this call

data.variables

object

Template variables used

data.recordingUrl

string | null

URL to call recording (available after call ends)

data.hangupCause

string | null

Reason call ended. Common values: USER_ENDED, END_CALL_TOOL, SILENCE_TIMEOUT, MAX_DURATION, VOICEMAIL_DETECTED

data.errorMessage

string | null

Error message if call failed

data.transcript

object[] | null

Conversation transcript

data.summary

string | null

AI-generated summary

data.metrics

object

Call quality and performance metrics

data.startedAt

string<date-time> | null

When call was answered (null if never answered)

data.endedAt

string<date-time> | null

When call ended (null if still ongoing)

data.durationSeconds

integer | null

Call duration in seconds (null if never answered)

data.postCallWebhookStatus

string | null

Status of post-call webhook delivery

data.preCallWebhookStatus

string | null

Status of pre-call webhook delivery

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

Delete Custom Tool Get Call

⌘I

API documentation

SIP Trunks

Agents

Agent Phone Numbers

Agent Custom Tools

Calls

Analytics

Webhooks

Authorizations

Query Parameters

Response