Introduction
Agent API
Agent Tool API
Widget Settings API
Phone Number & Telephony API
- GETList Available Numbers
- POSTBuy Phone Number
- DELRelease Phone Number
- GETList Purchased Numbers
- POSTImport Phone Number
- GETList Imported Numbers
- GETGet Imported Number
- PUTUpdate Imported Number
- DELDelete Imported Number
- GETList Twilio Owned Numbers
- POSTAdd Twilio Number
- POSTCreate Telephony Type
- GETGet Selected Telephony
Campaign API
Contact API
Appointment API
Cal.com Integration API
RAG Knowledge Base API
Webhooks
Health API
curl "https://api.ravan.ai/api/v1/campaigns/019d5b4c-8d9e-0f1a-2b3c-4d5e6f7a8b9c/contacts?limit=20&offset=0" \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Campaign contacts fetched successfully",
"data": [
{
"id": "019d6c5d-9e0f-1a2b-3c4d-5e6f7a8b9c0d",
"contact_id": "019d3a2b-5c6d-7e8f-9a0b-1c2d3e4f5a6b",
"name": "John Smith",
"phone": "+14155550100",
"email": "john@example.com",
"status": "successful",
"attempt_count": 1,
"last_attempted_at": "2026-03-21T09:15:00Z",
"next_retry_at": null,
"call_duration_sec": 125,
"error_message": "",
"call_session_id": "019d2b3c-8e9f-7a0b-1c2d-4e5f6a7b8c9d",
"tags": ["vip", "enterprise"]
},
{
"id": "019d6c5d-af10-2b3c-4d5e-6f7a8b9c0d1e",
"contact_id": "019d3a2b-6d7e-8f9a-0b1c-2d3e4f5a6b7c",
"name": "Jane Doe",
"phone": "+14155550200",
"email": "jane@example.com",
"status": "no_answer",
"attempt_count": 2,
"last_attempted_at": "2026-03-21T10:30:00Z",
"next_retry_at": "2026-03-21T11:00:00Z",
"call_duration_sec": 0,
"error_message": "",
"call_session_id": "",
"tags": []
}
],
"meta": { "total": 150, "limit": 20, "offset": 0 }
}
Campaign API
List Campaign Contacts
List contacts assigned to a campaign with their call status, attempt count, and results.
GET
/
api
/
v1
/
campaigns
/
{id}
/
contacts
curl "https://api.ravan.ai/api/v1/campaigns/019d5b4c-8d9e-0f1a-2b3c-4d5e6f7a8b9c/contacts?limit=20&offset=0" \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Campaign contacts fetched successfully",
"data": [
{
"id": "019d6c5d-9e0f-1a2b-3c4d-5e6f7a8b9c0d",
"contact_id": "019d3a2b-5c6d-7e8f-9a0b-1c2d3e4f5a6b",
"name": "John Smith",
"phone": "+14155550100",
"email": "john@example.com",
"status": "successful",
"attempt_count": 1,
"last_attempted_at": "2026-03-21T09:15:00Z",
"next_retry_at": null,
"call_duration_sec": 125,
"error_message": "",
"call_session_id": "019d2b3c-8e9f-7a0b-1c2d-4e5f6a7b8c9d",
"tags": ["vip", "enterprise"]
},
{
"id": "019d6c5d-af10-2b3c-4d5e-6f7a8b9c0d1e",
"contact_id": "019d3a2b-6d7e-8f9a-0b1c-2d3e4f5a6b7c",
"name": "Jane Doe",
"phone": "+14155550200",
"email": "jane@example.com",
"status": "no_answer",
"attempt_count": 2,
"last_attempted_at": "2026-03-21T10:30:00Z",
"next_retry_at": "2026-03-21T11:00:00Z",
"call_duration_sec": 0,
"error_message": "",
"call_session_id": "",
"tags": []
}
],
"meta": { "total": 150, "limit": 20, "offset": 0 }
}
Authorizations
Your Agni API key.
Path Parameters
Campaign UUID.
Query Parameters
Max results per page.
Pagination offset.
Response
Whether the request succeeded.
Human-readable status message.
Array of campaign contact records.
Show data[]
Show data[]
Campaign-contact join UUID.
Contact UUID.
Contact name.
Contact phone number.
Contact email.
Call status. Values:
pending, in_progress, successful, failed, no_answer.Number of call attempts made.
ISO 8601 timestamp of last attempt.
ISO 8601 timestamp of next scheduled retry.
Duration of the last call in seconds.
Error details if the call failed.
Session UUID for the call (links to call logs).
Contact tags.
Pagination metadata with
total, limit, offset.curl "https://api.ravan.ai/api/v1/campaigns/019d5b4c-8d9e-0f1a-2b3c-4d5e6f7a8b9c/contacts?limit=20&offset=0" \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Campaign contacts fetched successfully",
"data": [
{
"id": "019d6c5d-9e0f-1a2b-3c4d-5e6f7a8b9c0d",
"contact_id": "019d3a2b-5c6d-7e8f-9a0b-1c2d3e4f5a6b",
"name": "John Smith",
"phone": "+14155550100",
"email": "john@example.com",
"status": "successful",
"attempt_count": 1,
"last_attempted_at": "2026-03-21T09:15:00Z",
"next_retry_at": null,
"call_duration_sec": 125,
"error_message": "",
"call_session_id": "019d2b3c-8e9f-7a0b-1c2d-4e5f6a7b8c9d",
"tags": ["vip", "enterprise"]
},
{
"id": "019d6c5d-af10-2b3c-4d5e-6f7a8b9c0d1e",
"contact_id": "019d3a2b-6d7e-8f9a-0b1c-2d3e4f5a6b7c",
"name": "Jane Doe",
"phone": "+14155550200",
"email": "jane@example.com",
"status": "no_answer",
"attempt_count": 2,
"last_attempted_at": "2026-03-21T10:30:00Z",
"next_retry_at": "2026-03-21T11:00:00Z",
"call_duration_sec": 0,
"error_message": "",
"call_session_id": "",
"tags": []
}
],
"meta": { "total": 150, "limit": 20, "offset": 0 }
}
⌘I