Skip to main content
POST
/
calls
Send Call
curl --request POST \
  --url https://api.revring.ai/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "toNumber": "<string>",
  "fromNumber": "<string>",
  "variables": {},
  "callerIdName": "<string>",
  "skipQueue": false
}
'
{
  "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
  }
}

Authorizations

​
x-api-key
string
header
required

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

Body

application/json
​
agentId
string<uuid>
required
​
toNumber
string
required

Destination number (E.164)

Pattern: ^\+[1-9]\d{1,14}$
​
fromNumber
string
required

Caller ID number (E.164)

Pattern: ^\+[1-9]\d{1,14}$
​
variables
object

Template variables for this call

​
callerIdName
string

Caller ID name displayed to the recipient (max 15 characters)

Required string length: 1 - 15
​
skipQueue
boolean
default:false

When true, returns a 429 error immediately if the concurrency limit is reached instead of queuing the call

Response

Outbound call initiated

​
data
object

Phone call record