Voice

Endpointhttps://api.neuratel.ai

Voice Concurrency

GET

https://api.neuratel.ai

/v1/voice-sessions/concurrency

Returns current concurrent call count vs the org's limit.

Voice Concurrency › Responses

200

Successful Response

current_concurrent

integer · required

limit

integer · required

available

integer · required

unlimited

boolean · required

List Active Voice Sessions

GET

https://api.neuratel.ai

/v1/voice-sessions/active

Get all currently active voice sessions across phone, web, and WhatsApp voice channels. Returns real-time status, participants, and room details for the supervisor dashboard.

List Active Voice Sessions › query Parameters

q

Free-text search. Matches phone number (participant or business address) and agent display name (case-insensitive substring).

agent_id

Filter by agent UUID.

status

Filter by VoiceSession status (e.g. ringing, in_progress, active). Must be one of the LIVE_CALL_STATUSES.

channel

Filter by channel (phone | web | whatsapp_voice).

direction

Filter by direction (inbound | outbound).

campaign_id

Filter by outbound campaign UUID.

List Active Voice Sessions › Responses

Successful Response

success

boolean · required

object[] · required

total_active

integer · required

timestamp

string · required

GET/v1/voice-sessions/active

curl --request GET \
  --url https://api.neuratel.ai/v1/voice-sessions/active

shell

Example Responses

{
  "success": true,
  "calls": [
    {
      "id": "id",
      "channel": "channel",
      "direction": "string",
      "phone_number": "string",
      "agent_name": "string",
      "agent_id": "string",
      "status": "status",
      "connection_status": "string",
      "participants": [
        {
          "identity": "identity",
          "name": "string",
          "state": "string",
          "kind": "string",
          "joined_at": "string"
        }
      ],
      "started_at": "string",
      "duration_seconds": 0
    }
  ],
  "total_active": 0,
  "timestamp": "timestamp"
}

json

application/json

Hangup Voice Session

POST

https://api.neuratel.ai

/v1/voice-sessions/{call_id}/hangup

Terminate an active voice session by ID.

Hangup Voice Session › path Parameters

call_id

string · required

The unique identifier of the call to terminate.

Hangup Voice Session › Responses

Successful Response

success

boolean · required

call_id

string · required

status

string · required

timestamp

string · required

Listen to Voice Session

POST

https://api.neuratel.ai

/v1/voice-sessions/{call_id}/listen

Join an active voice session in listen-only mode. You can hear all participants but cannot speak; your presence is hidden.

Listen to Voice Session › path Parameters

call_id

string · required

The voice session to listen to.

Listen to Voice Session › Responses

Successful Response

success

boolean · required

mode

string · enum · required

Enum values:

listen

whisper

barge

call_id

string · required

token

string · required

required

supervisor_identity

string · required

object · required

timestamp

string · required

Whisper to Agent

POST

https://api.neuratel.ai

/v1/voice-sessions/{call_id}/whisper

Join an active voice session in whisper mode. You can hear all participants and send text coaching to the agent. The customer cannot hear you. Your presence is hidden.

Whisper to Agent › path Parameters

call_id

string · required

The voice session to whisper to.

Whisper to Agent › Responses

Successful Response

success

boolean · required

mode

string · enum · required

Enum values:

listen

whisper

barge

call_id

string · required

token

string · required

required

supervisor_identity

string · required

object · required

timestamp

string · required

Barge Into Voice Session

POST

https://api.neuratel.ai

/v1/voice-sessions/{call_id}/barge

Join an active voice session in barge mode. You can hear and speak to all participants and your presence is visible. Use this to take over or intervene in a call.

Barge Into Voice Session › path Parameters

call_id

string · required

The voice session to barge into.

Barge Into Voice Session › Responses

Successful Response

success

boolean · required

mode

string · enum · required

Enum values:

listen

whisper

barge

call_id

string · required

token

string · required

required

supervisor_identity

string · required

object · required

timestamp

string · required

List Voice Sessions

GET

https://api.neuratel.ai

/v1/voice-sessions

List voice sessions across phone (SIP), web (WebRTC), and WhatsApp voice channels. Filter by channel + direction (two-axis taxonomy), agent, status, date range, and duration.

Quick Examples

Code
curl 'https://api.neuratel.ai/v1/voice-sessions?channel=phone&direction=inbound' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Code
curl 'https://api.neuratel.ai/v1/voice-sessions?channel=whatsapp_voice&date_preset=last_7_days' \
  -H 'Authorization: Bearer YOUR_API_KEY'

List Voice Sessions › query Parameters

channel

Filter by channel: phone | web | whatsapp_voice

direction

Filter by direction: inbound | outbound

campaign_id

Filter by outbound campaign ID

status

Filter by status

createdAtGt

Filter records created after this datetime (ISO 8601). Example: 2024-01-01T00:00:00Z

createdAtLt

Filter records created before this datetime (ISO 8601). Example: 2024-12-31T23:59:59Z

createdAtGe

Filter records created on or after this datetime (ISO 8601). Example: 2024-01-01T00:00:00Z

createdAtLe

Filter records created on or before this datetime (ISO 8601). Example: 2024-12-31T23:59:59Z

date_preset

sortOrder

string · enum

Sort order: ASC (oldest first) or DESC (newest first). Defaults to DESC.

Sort order for list endpoints

Enum values:

ASC

DESC

Default: DESC

durationGt

Filter sessions longer than this (seconds)

durationLt

Filter sessions shorter than this (seconds)

agentIdAny

Filter by agent IDs (comma-separated)

statusAny

Filter by multiple statuses (comma-separated)

skip

integer · min: 0

Number of records to skip for pagination. Defaults to 0.

Default: 0

limit

integer · min: 1 · max: 1000

Default: 100

List Voice Sessions › Responses

Successful Response

object[] · required

object · required

Pagination metadata in API responses.

GET/v1/voice-sessions

curl --request GET \
  --url https://api.neuratel.ai/v1/voice-sessions

shell

Example Responses

{
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "channel": "channel",
      "direction": "string",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "agent_id": "00000000-0000-0000-0000-000000000000",
      "agent_name": "string",
      "campaign_id": "00000000-0000-0000-0000-000000000000",
      "phone_number_id": "00000000-0000-0000-0000-000000000000",
      "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
      "from_number": "string",
      "to_number": "string",
      "participant_address": "string",
      "business_address": "string",
      "caller_id": "string",
      "status": "status",
      "analysis_status": "pending",
      "call_result": "string",
      "failure_reason": "string",
      "error_message": "string",
      "end_reason": "string",
      "retry_count": 0,
      "started_at": "2024-08-25T15:00:00Z",
      "answered_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0,
      "billed_amount": 0,
      "billing_currency": "string",
      "billable_minutes": 0,
      "billing_rate_per_minute": 0,
      "participants": [
        {
          "participant_identity": "participant_identity",
          "participant_type": "participant_type",
          "joined_at": "2024-08-25T15:00:00Z",
          "left_at": "2024-08-25T15:00:00Z",
          "duration_seconds": 0
        }
      ],
      "agent_metrics": {
        "latency_ttft_ms": 0,
        "latency_ttfb_ms": 0,
        "eou_delay_ms": 0,
        "conversation_quality_score": 0,
        "sentiment_score": 0,
        "session_duration_seconds": 0,
        "extracted_data": {},
        "llm_tokens_prompt": 0,
        "llm_tokens_completion": 0,
        "llm_tokens_total": 0,
        "stt_provider": "string",
        "stt_model": "string",
        "stt_audio_duration_seconds": 0,
        "llm_provider": "string",
        "llm_model": "string",
        "tts_provider": "string",
        "tts_model": "string",
        "tts_characters": 0,
        "estimated_cost_usd": 0
      },
      "conversation_preview": [
        {
          "speaker": "speaker",
          "text": "text",
          "timestamp": "2024-08-25T15:00:00Z",
          "sentiment_score": 0,
          "sentiment_label": "string",
          "speaker_id": "string",
          "speaker_confidence": 0
        }
      ],
      "conversation_turn_count": 0,
      "conversation": [
        {
          "speaker": "speaker",
          "text": "text",
          "timestamp": "2024-08-25T15:00:00Z",
          "sentiment_score": 0,
          "sentiment_label": "string",
          "speaker_id": "string",
          "speaker_confidence": 0
        }
      ],
      "sentiment_trend": [
        0
      ],
      "topics_discussed": [
        "string"
      ],
      "keywords_extracted": [
        "string"
      ],
      "extracted_data": {},
      "usage_metrics": {
        "stt": {},
        "llm": {},
        "tts": {},
        "realtime": {}
      },
      "estimated_cost_usd": 0,
      "tool_calls": [
        {}
      ],
      "latency": {},
      "call_summary": "string",
      "success_evaluation": {},
      "sentiment_timeline": {
        "trend": "trend",
        "average_sentiment": 0,
        "high_point": {},
        "low_point": {},
        "turns": [
          {
            "turn": 0,
            "role": "role",
            "text": "text",
            "sentiment": 0,
            "emotion": "emotion"
          }
        ]
      },
      "audio_quality": {},
      "topics": [
        "string"
      ],
      "action_items": [
        "string"
      ],
      "user_sentiment": "string",
      "user_sentiment_score": 0,
      "call_successful": "string",
      "call_successful_rationale": "string",
      "evaluation_score": {},
      "recording": {
        "id": "00000000-0000-0000-0000-000000000000",
        "recording_url": "string",
        "status": "pending",
        "duration_seconds": 0,
        "file_size_bytes": 0,
        "format": "string",
        "error_message": "string",
        "created_at": "2024-08-25T15:00:00Z"
      },
      "session_id": "string",
      "call_metadata": {},
      "contact_data": {},
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "count": 100,
    "has_more": true,
    "limit": 100,
    "skip": 0,
    "total": 250
  }
}

json

application/json

Get Voice Session

GET

https://api.neuratel.ai

/v1/voice-sessions/{session_id}

Get Voice Session › path Parameters

session_id

string · uuid · required

The unique identifier of the voice session.

Get Voice Session › query Parameters

include

Include extras: 'full' | 'transcript' | 'analytics'

Get Voice Session › Responses

Successful Response

One voice session — phone, web, or WhatsApp voice.

id

string · uuid · required

channel

string · required

status

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

analysis_status

string

Default: pending

retry_count

integer

Default: 0

duration_seconds

integer

Default: 0

object[]

object[] · maxItems: 5

conversation_turn_count

integer

Default: 0

sentiment_trend

number[]

topics_discussed

string[]

keywords_extracted

string[]

object

object[]

object

topics

string[]

action_items

string[]

object

GET/v1/voice-sessions/{session_id}

curl --request GET \
  --url https://api.neuratel.ai/v1/voice-sessions/:session_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "direction": "string",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "agent_name": "string",
  "campaign_id": "00000000-0000-0000-0000-000000000000",
  "phone_number_id": "00000000-0000-0000-0000-000000000000",
  "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
  "from_number": "string",
  "to_number": "string",
  "participant_address": "string",
  "business_address": "string",
  "caller_id": "string",
  "status": "status",
  "analysis_status": "pending",
  "call_result": "string",
  "failure_reason": "string",
  "error_message": "string",
  "end_reason": "string",
  "retry_count": 0,
  "started_at": "2024-08-25T15:00:00Z",
  "answered_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z",
  "duration_seconds": 0,
  "billed_amount": 0,
  "billing_currency": "string",
  "billable_minutes": 0,
  "billing_rate_per_minute": 0,
  "participants": [
    {
      "participant_identity": "participant_identity",
      "participant_type": "participant_type",
      "joined_at": "2024-08-25T15:00:00Z",
      "left_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "agent_metrics": {
    "latency_ttft_ms": 0,
    "latency_ttfb_ms": 0,
    "eou_delay_ms": 0,
    "conversation_quality_score": 0,
    "sentiment_score": 0,
    "session_duration_seconds": 0,
    "extracted_data": {},
    "llm_tokens_prompt": 0,
    "llm_tokens_completion": 0,
    "llm_tokens_total": 0,
    "stt_provider": "string",
    "stt_model": "string",
    "stt_audio_duration_seconds": 0,
    "llm_provider": "string",
    "llm_model": "string",
    "tts_provider": "string",
    "tts_model": "string",
    "tts_characters": 0,
    "estimated_cost_usd": 0
  },
  "conversation_preview": [
    {
      "speaker": "speaker",
      "text": "text",
      "timestamp": "2024-08-25T15:00:00Z",
      "sentiment_score": 0,
      "sentiment_label": "string",
      "speaker_id": "string",
      "speaker_confidence": 0
    }
  ],
  "conversation_turn_count": 0,
  "conversation": [
    {
      "speaker": "speaker",
      "text": "text",
      "timestamp": "2024-08-25T15:00:00Z",
      "sentiment_score": 0,
      "sentiment_label": "string",
      "speaker_id": "string",
      "speaker_confidence": 0
    }
  ],
  "sentiment_trend": [
    0
  ],
  "topics_discussed": [
    "string"
  ],
  "keywords_extracted": [
    "string"
  ],
  "extracted_data": {},
  "usage_metrics": {
    "stt": {},
    "llm": {},
    "tts": {},
    "realtime": {}
  },
  "estimated_cost_usd": 0,
  "tool_calls": [
    {}
  ],
  "latency": {},
  "call_summary": "string",
  "success_evaluation": {},
  "sentiment_timeline": {
    "trend": "trend",
    "average_sentiment": 0,
    "high_point": {},
    "low_point": {},
    "turns": [
      {
        "turn": 0,
        "role": "role",
        "text": "text",
        "sentiment": 0,
        "emotion": "emotion"
      }
    ]
  },
  "audio_quality": {},
  "topics": [
    "string"
  ],
  "action_items": [
    "string"
  ],
  "user_sentiment": "string",
  "user_sentiment_score": 0,
  "call_successful": "string",
  "call_successful_rationale": "string",
  "evaluation_score": {},
  "recording": {
    "id": "00000000-0000-0000-0000-000000000000",
    "recording_url": "string",
    "status": "pending",
    "duration_seconds": 0,
    "file_size_bytes": 0,
    "format": "string",
    "error_message": "string",
    "created_at": "2024-08-25T15:00:00Z"
  },
  "session_id": "string",
  "call_metadata": {},
  "contact_data": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete Voice Session

DELETE

https://api.neuratel.ai

/v1/voice-sessions/{session_id}

Delete voice-session data (GDPR right to erasure).

Delete Voice Session › path Parameters

session_id

string · uuid · required

The voice session to delete.

Delete Voice Session › query Parameters

delete_recording

boolean

Whether to delete the associated recording.

Default: true

delete_transcript

boolean

Whether to delete transcript + analytics.

Default: true

Delete Voice Session › Responses

Voice session deleted

No data returned

Update Voice Session

PATCH

https://api.neuratel.ai

/v1/voice-sessions/{session_id}

Partial update of a voice session. Only call_metadata is mutable — the dict is JSONB-merged into the existing column (existing keys preserved, collisions overwritten, new keys added). Used by operators to attach CRM IDs, ticket numbers, or post-call notes after a call ends.

Update Voice Session › path Parameters

session_id

string · uuid · required

The voice session to update.

Update Voice Session › Request Body

Partial update for a voice session. Only `call_metadata` is mutable today: operators attach CRM IDs / ticket numbers / post-call notes after the call ends. The dict is JSONB-merged into the existing column (not replaced wholesale). Other fields are either auto-managed (status, timing — written by the media-server webhook receiver) or don't exist on the schema (no `tags` column).

object · required

Keys to merge into the existing call_metadata JSONB column.

Update Voice Session › Responses

Successful Response

One voice session — phone, web, or WhatsApp voice.

id

string · uuid · required

channel

string · required

status

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

analysis_status

string

Default: pending

retry_count

integer

Default: 0

duration_seconds

integer

Default: 0

object[]

object[] · maxItems: 5

conversation_turn_count

integer

Default: 0

sentiment_trend

number[]

topics_discussed

string[]

keywords_extracted

string[]

object

object[]

object

topics

string[]

action_items

string[]

object

PATCH/v1/voice-sessions/{session_id}

curl --request PATCH \
  --url https://api.neuratel.ai/v1/voice-sessions/:session_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "call_metadata": {}
}
'

shell

Example Request Body

{
  "call_metadata": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "direction": "string",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "agent_name": "string",
  "campaign_id": "00000000-0000-0000-0000-000000000000",
  "phone_number_id": "00000000-0000-0000-0000-000000000000",
  "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
  "from_number": "string",
  "to_number": "string",
  "participant_address": "string",
  "business_address": "string",
  "caller_id": "string",
  "status": "status",
  "analysis_status": "pending",
  "call_result": "string",
  "failure_reason": "string",
  "error_message": "string",
  "end_reason": "string",
  "retry_count": 0,
  "started_at": "2024-08-25T15:00:00Z",
  "answered_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z",
  "duration_seconds": 0,
  "billed_amount": 0,
  "billing_currency": "string",
  "billable_minutes": 0,
  "billing_rate_per_minute": 0,
  "participants": [
    {
      "participant_identity": "participant_identity",
      "participant_type": "participant_type",
      "joined_at": "2024-08-25T15:00:00Z",
      "left_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "agent_metrics": {
    "latency_ttft_ms": 0,
    "latency_ttfb_ms": 0,
    "eou_delay_ms": 0,
    "conversation_quality_score": 0,
    "sentiment_score": 0,
    "session_duration_seconds": 0,
    "extracted_data": {},
    "llm_tokens_prompt": 0,
    "llm_tokens_completion": 0,
    "llm_tokens_total": 0,
    "stt_provider": "string",
    "stt_model": "string",
    "stt_audio_duration_seconds": 0,
    "llm_provider": "string",
    "llm_model": "string",
    "tts_provider": "string",
    "tts_model": "string",
    "tts_characters": 0,
    "estimated_cost_usd": 0
  },
  "conversation_preview": [
    {
      "speaker": "speaker",
      "text": "text",
      "timestamp": "2024-08-25T15:00:00Z",
      "sentiment_score": 0,
      "sentiment_label": "string",
      "speaker_id": "string",
      "speaker_confidence": 0
    }
  ],
  "conversation_turn_count": 0,
  "conversation": [
    {
      "speaker": "speaker",
      "text": "text",
      "timestamp": "2024-08-25T15:00:00Z",
      "sentiment_score": 0,
      "sentiment_label": "string",
      "speaker_id": "string",
      "speaker_confidence": 0
    }
  ],
  "sentiment_trend": [
    0
  ],
  "topics_discussed": [
    "string"
  ],
  "keywords_extracted": [
    "string"
  ],
  "extracted_data": {},
  "usage_metrics": {
    "stt": {},
    "llm": {},
    "tts": {},
    "realtime": {}
  },
  "estimated_cost_usd": 0,
  "tool_calls": [
    {}
  ],
  "latency": {},
  "call_summary": "string",
  "success_evaluation": {},
  "sentiment_timeline": {
    "trend": "trend",
    "average_sentiment": 0,
    "high_point": {},
    "low_point": {},
    "turns": [
      {
        "turn": 0,
        "role": "role",
        "text": "text",
        "sentiment": 0,
        "emotion": "emotion"
      }
    ]
  },
  "audio_quality": {},
  "topics": [
    "string"
  ],
  "action_items": [
    "string"
  ],
  "user_sentiment": "string",
  "user_sentiment_score": 0,
  "call_successful": "string",
  "call_successful_rationale": "string",
  "evaluation_score": {},
  "recording": {
    "id": "00000000-0000-0000-0000-000000000000",
    "recording_url": "string",
    "status": "pending",
    "duration_seconds": 0,
    "file_size_bytes": 0,
    "format": "string",
    "error_message": "string",
    "created_at": "2024-08-25T15:00:00Z"
  },
  "session_id": "string",
  "call_metadata": {},
  "contact_data": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Voice Analytics Dashboard

GET

https://api.neuratel.ai

/v1/voice-sessions/analytics/dashboard

Voice Analytics Dashboard › query Parameters

start_date

YYYY-MM-DD

end_date

YYYY-MM-DD

agent_id

campaign_id

channel

phone | web | whatsapp_voice

direction

inbound | outbound

interval

string · enum

Enum values:

hour

day

week

Default: day

campaign_attributed_only

boolean

When true, narrow every metric to sessions where campaign_id IS NOT NULL. Used by the Outbound > Analytics tab so the dashboard reflects campaign activity rather than total org voice traffic. Mutually compatible with campaign_id (specific campaign always wins).

Default: false

Voice Analytics Dashboard › Responses

Successful Response

COMPREHENSIVE ANALYTICS RESPONSE - Single Source of Truth This is the primary analytics endpoint. Backend returns everything the frontend needs - no client-side calculations required.

start_date

string · required

Start date YYYY-MM-DD

end_date

string · required

End date YYYY-MM-DD

object · required

Primary KPI metrics

Named time range if applicable

object[]

Call volume over time

object[]

Activity heatmap data

object

Call outcome breakdown

object[]

By hour of day

object[]

By day of week

Per-agent performance

Per-campaign performance

Average latency metrics

GET/v1/voice-sessions/analytics/dashboard

curl --request GET \
  --url https://api.neuratel.ai/v1/voice-sessions/analytics/dashboard

shell

Example Responses

{
  "start_date": "start_date",
  "end_date": "end_date",
  "time_range": "today",
  "kpis": {
    "total_calls": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "answered_calls": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "error_calls": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "answer_rate": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "error_rate": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "success_rate": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "avg_handle_time": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "total_duration_minutes": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "booking_rate": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "latency": {
      "ttft_ms": 0,
      "ttfb_ms": 0,
      "eou_delay_ms": 0,
      "asr_p50_ms": 0,
      "total_response_ms": 0
    },
    "avg_sentiment_score": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "avg_quality_score": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    },
    "total_cost": {
      "value": 0,
      "formatted": "formatted",
      "trend_percent": 0,
      "trend_direction": "string",
      "previous_value": 0
    }
  },
  "call_volume": [
    {
      "date": "date",
      "hour": 0,
      "calls": 0,
      "answered": 0,
      "errors": 0,
      "inbound": 0,
      "outbound": 0,
      "duration_minutes": 0,
      "avg_handle_time_sec": 0,
      "answer_rate": 0,
      "error_rate": 0,
      "booking_rate": 0,
      "avg_latency_ttft_ms": 0,
      "avg_latency_ttfb_ms": 0,
      "avg_eou_delay_ms": 0,
      "asr_latency_ms_p50": 0
    }
  ],
  "contribution_data": [
    {
      "date": "date",
      "count": 0,
      "level": 0
    }
  ],
  "call_outcomes": {
    "completed": 0,
    "failed": 0,
    "no_answer": 0,
    "voicemail": 0,
    "busy": 0,
    "canceled": 0,
    "other": 0
  },
  "hourly_distribution": [
    {
      "hour": 0,
      "calls": 0,
      "avg_duration_sec": 0
    }
  ],
  "daily_distribution": [
    {
      "day": 0,
      "day_name": "day_name",
      "calls": 0,
      "avg_duration_sec": 0
    }
  ],
  "agents": [
    {
      "agent_id": "agent_id",
      "agent_name": "agent_name",
      "total_calls": 0,
      "completed_calls": 0,
      "failed_calls": 0,
      "total_duration_sec": 0,
      "avg_duration_sec": 0,
      "success_rate": 0,
      "answer_rate": 0,
      "estimated_cost_usd": 0,
      "avg_latency_ms": 0
    }
  ],
  "campaigns": [
    {
      "campaign_id": "campaign_id",
      "campaign_name": "campaign_name",
      "total_calls": 0,
      "answered": 0,
      "completed": 0,
      "failed": 0,
      "no_answer": 0,
      "voicemail": 0,
      "answer_rate": 0,
      "completion_rate": 0,
      "conversion_rate": 0,
      "total_duration_min": 0,
      "avg_duration_sec": 0
    }
  ],
  "latency": {
    "ttft_ms": 0,
    "ttfb_ms": 0,
    "eou_delay_ms": 0,
    "asr_p50_ms": 0,
    "total_response_ms": 0
  }
}

json

application/json

Voice Analytics Summary

GET

https://api.neuratel.ai

/v1/voice-sessions/analytics/summary

Voice Analytics Summary › query Parameters

start_date

end_date

agent_id

group_by

agent | phoneNumber

Voice Analytics Summary › Responses

Successful Response

No data returned

Voice Call Volume

GET

https://api.neuratel.ai

/v1/voice-sessions/analytics/volume

Voice Call Volume › query Parameters

start_date

end_date

agent_id

interval

string · enum

Enum values:

hour

day

week

Default: day

Voice Call Volume › Responses

Successful Response

No data returned

Initiate Outbound Voice Call

POST

https://api.neuratel.ai

/v1/voice-sessions/outbound

Initiate a single outbound voice call to a phone number using an AI agent.

Prerequisites

Agent with valid configuration
Phone number with outbound trunk configured
Dynamic variables if agent template uses {{variable}} placeholders

Example

Code
curl -X POST https://api.neuratel.ai/v1/voice-sessions/outbound \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "550e8400-e29b-41d4-a716-446655440000",
    "to_number": "+15551234567",
    "number_id": "660e8400-e29b-41d4-a716-446655440001",
    "dynamic_variables": {"customer_name": "John Doe"}
  }'

Initiate Outbound Voice Call › Request Body

POST /v1/voice-sessions/outbound — initiate a single phone-channel call.

agent_id

string · uuid · required

to_number

string · minLength: 10 · maxLength: 20 · required

Destination phone number (E.164 format, e.g., +15551234567)

number_id

string · uuid · required

Phone number ID to use for caller ID

Override caller ID number (E.164). Defaults to number_id's DID.

Caller ID display name (max 50 chars).

Dynamic variables injected into agent prompts via {{var}} syntax.

Per-call deep-merged agent config overrides.

force_dnc_override

boolean

When true AND the org has DNC protection_enabled=False, allows the call to proceed even if the destination is on the DNC directory. Requires force_dnc_override_reason. Opt-IN orgs cannot override.

Default: false

Free-text justification for the DNC override (logged to dnc_check_log for audit). Required when force_dnc_override=True.

Initiate Outbound Voice Call › Responses

Successful Response

Response from outbound voice-session creation.

success

boolean · required

to_number

string · required

agent_id

string · uuid · required

POST/v1/voice-sessions/outbound

curl --request POST \
  --url https://api.neuratel.ai/v1/voice-sessions/outbound \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "to_number": "to_numbera",
  "number_id": "00000000-0000-0000-0000-000000000000",
  "caller_id_number": "string",
  "caller_id_name": "string",
  "dynamic_variables": {},
  "agent_override": {},
  "force_dnc_override": false,
  "force_dnc_override_reason": "string"
}
'

shell

Example Request Body

{
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "to_number": "to_numbera",
  "number_id": "00000000-0000-0000-0000-000000000000",
  "caller_id_number": "string",
  "caller_id_name": "string",
  "dynamic_variables": {},
  "agent_override": {},
  "force_dnc_override": false,
  "force_dnc_override_reason": "string"
}

json

Example Responses

{
  "success": true,
  "call_id": "string",
  "to_number": "to_number",
  "from_number": "string",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "error": "string"
}

json

application/json

Start Web Call

POST

https://api.neuratel.ai

/v1/agents/{agent_id}/web-call

Start a browser-based WebRTC voice session with an agent. Returns a token and server_url — pass these to the Neuratel Web SDK to open the audio connection in the browser. No phone number required.

Start Web Call › path Parameters

agent_id

string · uuid · required

Agent ID

Start Web Call › Request Body

Request to start a browser (WebRTC) call with an agent.

Optional session name override

Display name for the caller

Dynamic {{variables}} to inject for this call

Start Web Call › Responses

Successful Response

Response containing connection details for a browser (WebRTC) call.

success

boolean · required

Whether the session was successfully created

session_id

string · required

Unique identifier for this call session

participant_token

string · required

JWT access token for the participant

token

string · required

JWT access token (alias of participant_token for backward compat)

server_url

string · required

WebSocket URL of the realtime media server

participant_identity

string · required

Your participant identity in this session

expires_in

integer

Token expiry in seconds from now

Default: 3600

Campaigns Conversations