Calls Endpoints

Access call records and metadata from your medical integrations

Overview

The Calls API provides access to inbound and outbound call records. This includes appointment reminders, feedback calls, and agent interactions. Retrieve metadata such as duration, timestamp, and transcriptions.

For GET /api/external/calls, the limit query parameter is enforced between 10 and 30 per request (the server clamps out-of-range values).

Endpoints

GEThttps://server.nyraai.io/api/external/calls

Fetch call records with filtering and pagination

Permission: calls:read

Headers

x-api-keyrequired

API key

x-api-secretrequired

API secret

Authorizationrequired

Bearer hospital token

Query Parameters

page(integer)

Page number (default: 1)

limit(integer)

Records per page (clamped: min 10, max 30; values outside this range are adjusted)

patient_id(uuid)

Filter by patient

branch_id(uuid)

Filter by branch

agent_type(string)

Filter by agent type (inbound, reminder, feedback)

start_date(date)

Filter from date (YYYY-MM-DD)

end_date(date)

Filter to date (YYYY-MM-DD)

Response

{
  "success": true,
  "data": {
    "total": 156,
    "results": [
      {
        "id": "call-uuid",
        "patient_id": "patient-uuid",
        "patient_name": "Ravi Kumar",
        "agent_type": "appointment_reminder",
        "duration": 245,
        "created_at": "2026-04-07T14:30:00+05:30",
        "transcription": "Thank you for scheduling your appointment with Dr. Rao...",
        "call_status": "completed"
      }
    ],
    "page": 1,
    "limit": 20,
    "total_pages": 8
  }
}

Usage Examples

Fetch Reminder Calls

curl -X GET "https://server.nyraai.io/api/external/calls?agent_type=reminder&start_date=2026-04-01&limit=30" \
  -H "x-api-key: nyra_..." \
  -H "x-api-secret: secret..." \
  -H "Authorization: Bearer token..."

Agent Types

inbound

Incoming calls from patients

reminder

Appointment reminder calls

feedback

Post-appointment feedback calls