Raw schema
{
"type": "object",
"properties": {
"filter": {
"description": "Free-text search over calls.",
"type": "string"
},
"internal_numbers": {
"description": "Only calls on these internal (Rinkel) numbers, as listed by rinkel_list_numbers.",
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"external_number": {
"description": "Only calls with this external (caller or callee) number.",
"type": "string"
},
"date_preset": {
"description": "A relative period. It overrides start_date and end_date.",
"type": "string",
"enum": [
"TODAY",
"THIS-WEEK",
"LAST-TWO-WEEKS",
"LAST-MONTH"
]
},
"start_date": {
"description": "Only calls on or after this date (yyyy-mm-dd, or an ISO date-time with timezone). Sent as a Unix timestamp.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$"
},
"end_date": {
"description": "Only calls on or before this date (yyyy-mm-dd = end of that day UTC, or an ISO date-time with timezone).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$"
},
"has_notes": {
"description": "Only calls that have (true) or lack (false) notes.",
"type": "boolean"
},
"is_anonymous": {
"description": "Only calls from a hidden number (true) or not (false).",
"type": "boolean"
},
"contact_lookup": {
"description": "Include the matching contact in each record.",
"type": "boolean"
},
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Items per page (default 10, max 50).",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"directions": {
"description": "Only these directions.",
"type": "array",
"items": {
"type": "string",
"enum": [
"INBOUND",
"OUTBOUND"
]
}
},
"statuses": {
"description": "Only these call outcomes.",
"type": "array",
"items": {
"type": "string",
"enum": [
"MISSED",
"ANSWERED",
"VOICEMAIL"
]
}
},
"user_ids": {
"description": "Only calls handled by these user ids (rinkel_list_users).",
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"sentiments": {
"description": "Only calls with this AI-insights sentiment.",
"type": "array",
"items": {
"type": "string",
"enum": [
"POSITIVE",
"NEGATIVE",
"NEUTRAL"
]
}
},
"duration_preset": {
"description": "Duration buckets in minutes ('30-0' = 30 minutes or more). Overrides min/max duration.",
"type": "array",
"items": {
"type": "string",
"enum": [
"1-5",
"5-15",
"15-30",
"30-0"
]
}
},
"min_duration_seconds": {
"description": "Minimum duration in seconds (ignored with duration_preset).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"max_duration_seconds": {
"description": "Maximum duration in seconds (ignored with duration_preset).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"has_transcription": {
"description": "Only calls that have a transcription.",
"type": "boolean"
},
"has_insights": {
"description": "Only calls that have AI insights.",
"type": "boolean"
},
"include_details": {
"description": "Include insights and notes in each record.",
"type": "boolean"
},
"contact": {
"description": "Only calls with this contact (id).",
"type": "string"
},
"sort": {
"description": "Sort field (default date).",
"type": "string",
"enum": [
"date",
"duration",
"status",
"internalNumber",
"externalNumber",
"user"
]
},
"sort_order": {
"description": "Sort order (default DESC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}