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": {}
}
'{
"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>"
}
}Initiate an outbound call with an agent
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": {}
}
'{
"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>"
}
}API key for authentication. Generate API keys from the RevRing dashboard.
Outbound call initiated
Phone call record
Show child attributes
Call direction
INBOUND, OUTBOUND Current call status
INITIATED, ONGOING, TRANSFERRED, COMPLETED, FAILED, CANCELED Caller's number (E.164)
Called number (E.164)
When call was initiated
Caller ID name shown to recipient
Name of the agent that handled this call
Template variables used
URL to call recording (available after call ends)
Reason call ended. Common values: USER_ENDED, END_CALL_TOOL, SILENCE_TIMEOUT, MAX_DURATION, VOICEMAIL_DETECTED
Error message if call failed
Conversation transcript
AI-generated summary
Call quality and performance metrics
When call was answered (null if never answered)
When call ended (null if still ongoing)
Call duration in seconds (null if never answered)
Status of post-call webhook delivery
Status of pre-call webhook delivery