# Call

## Retrieve

**get** `/call/{id}`

Retrieve the full details of a call order by its unique ID. The response includes the call status, call attempts, transcript, recording URL, timestamps, and metadata. Use this endpoint to poll for call completion or inspect results after a call has finished.

### Path Parameters

- `id: string`

### Returns

- `call: object { id, assistant, call_attempts, 16 more }`

  This represent a call "order" that was requested by the user. A call order can be resolved over multiple call attempts spanning up to a few days.

  - `id: string`

    The ID of the call.

  - `assistant: object { id, background_sound, calendly, 20 more }`

    - `id: string`

    - `background_sound: "audio/office.ogg"`

      The background sound to play during the call. Useful to give the impression that your AI agent is in an office.

      - `"audio/office.ogg"`

    - `calendly: object { connection_id, event_type_id }`

      - `connection_id: string`

        The connection ID representing the link between your Calendly account and Revox.

      - `event_type_id: string`

        The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

    - `call_retry_config: object { calling_windows, max_retry_attempts, timezone }`

      Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

      - `calling_windows: array of object { calling_window_end_time, calling_window_start_time, retry_delay_seconds }`

        - `calling_window_end_time: string`

          End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

        - `calling_window_start_time: string`

          Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

        - `retry_delay_seconds: number`

          Delay between retry attempts in seconds. Default: 7200 (2 hours).

      - `max_retry_attempts: number`

        Maximum number of call retry attempts. Default: 3.

      - `timezone: optional string`

        Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

    - `created_at: unknown`

    - `end_of_call_sentence: string`

    - `first_sentence: string`

    - `first_sentence_delay_ms: number`

      Delay in milliseconds before speaking the first sentence. Default: 400.

    - `first_sentence_mode: "generated" or "static" or "none"`

      - `"generated"`

      - `"static"`

      - `"none"`

    - `ivr_navigation_enabled: boolean`

      Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

    - `llm_model: object { name, type }  or object { openrouter_model_id, openrouter_provider, type }`

      - `UnionMember0 = object { name, type }`

        - `name: "gpt-4.1" or "ministral-3-8b-instruct"`

          - `"gpt-4.1"`

          - `"ministral-3-8b-instruct"`

        - `type: "dedicated-instance"`

          - `"dedicated-instance"`

      - `UnionMember1 = object { openrouter_model_id, openrouter_provider, type }`

        - `openrouter_model_id: string`

          The model ID to use from OpenRouter. eg: openai/gpt-4.1

        - `openrouter_provider: string`

          The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

        - `type: "openrouter"`

          Use a model from OpenRouter.

          - `"openrouter"`

    - `max_call_duration_secs: number`

      The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

    - `name: string`

    - `organization_id: string`

    - `prompt: string`

    - `structured_output_config: array of object { name, required, type, 2 more }`

      The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

      - `name: string`

      - `required: boolean`

      - `type: "string" or "number" or "boolean" or 3 more`

        - `"string"`

        - `"number"`

        - `"boolean"`

        - `"enum"`

        - `"date"`

        - `"datetime"`

      - `description: optional string`

      - `enum_options: optional array of string`

    - `transfer_phone_number: string`

      Phone number to transfer calls to when users request to speak to a human agent.

    - `updated_at: unknown`

    - `voice: object { id, provider, speed }`

      - `id: string`

        The ID of the voice.

      - `provider: "cartesia" or "elevenlabs"`

        The provider of the voice.

        - `"cartesia"`

        - `"elevenlabs"`

      - `speed: optional number`

        The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

    - `voicemail_message: string`

      If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

    - `webhook_url: string`

      The webhook URL to call when the call is completed.

    - `faq_items: optional array of object { answer, question, id, 2 more }`

      - `answer: string`

      - `question: string`

      - `id: optional string`

      - `needs_human_answer: optional boolean`

      - `source: optional "human" or "ai"`

        - `"human"`

        - `"ai"`

    - `pending_faq_count: optional number`

  - `call_attempts: array of object { id, answered_at, dial_error, 10 more }`

    All call attempts for this call order, ordered by most recent first.

    - `id: string`

      The ID of the call attempt.

    - `answered_at: unknown`

      The time the call was answered.

    - `dial_error: "number_non_attributed" or "too_many_calls" or "busy" or 5 more`

      The SIP error that occurred.

      - `"number_non_attributed"`

      - `"too_many_calls"`

      - `"busy"`

      - `"temporarily_unavailable"`

      - `"no_answer"`

      - `"no_international_permission"`

      - `"precondition_failed"`

      - `"non_classified_error"`

    - `ended_at: unknown`

      The time the call ended.

    - `phone_number: string`

      The phone number that was called. Formatted in E.164 format. Example: +1234567890

    - `recording_url: string`

      The URL of the audio recording of the call.

    - `result: "IVR" or "voicemail" or "human" or 2 more`

      - `"IVR"`

      - `"voicemail"`

      - `"human"`

      - `"unknown"`

      - `"ios-screening-filter"`

    - `started_at: unknown`

      The time the call started.

    - `status: "queued" or "ringing" or "ongoing" or 2 more`

      The status of the call attempt.

      - `"queued"`

      - `"ringing"`

      - `"ongoing"`

      - `"completed"`

      - `"error"`

    - `end_reason: optional string`

      Reason for ending the call when ended_by is 'agent'. E.g. 'tool_end_call', 'voicemail', 'transfer', 'ivr_no_navigate'.

    - `ended_by: optional "agent" or "user" or "system"`

      Who ended the call: 'agent' (AI agent), 'user' (caller/callee hung up), or 'system' (e.g. max duration limit).

      - `"agent"`

      - `"user"`

      - `"system"`

    - `structured_output: optional map[unknown]`

      The data extracted from the call, using the structured output config from the parent call object.

    - `transcript: optional array of object { content, role, tool_arguments, 2 more }`

      The transcript of the call.

      - `content: string`

      - `role: "user" or "assistant" or "tool"`

        - `"user"`

        - `"assistant"`

        - `"tool"`

      - `tool_arguments: optional map[unknown] or string`

        - `UnionMember0 = map[unknown]`

        - `UnionMember1 = string`

      - `tool_is_error: optional boolean`

      - `tool_name: optional string`

  - `call_retry_config: object { calling_windows, max_retry_attempts, timezone }`

    Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

    - `calling_windows: array of object { calling_window_end_time, calling_window_start_time, retry_delay_seconds }`

      - `calling_window_end_time: string`

        End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

      - `calling_window_start_time: string`

        Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

      - `retry_delay_seconds: number`

        Delay between retry attempts in seconds. Default: 7200 (2 hours).

    - `max_retry_attempts: number`

      Maximum number of call retry attempts. Default: 3.

    - `timezone: optional string`

      Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

  - `calls_count: number`

    The number of call attempts made.

  - `campaign: object { id, name }`

    - `id: string`

    - `name: string`

  - `created_at: unknown`

    The time the call order was created.

  - `direction: "inbound" or "outbound"`

    Whether the call is inbound or outbound.

    - `"inbound"`

    - `"outbound"`

  - `first_sentence_delay_ms: number`

    Delay in milliseconds before speaking the first sentence. Default: 400.

  - `from_phone_number: string`

    The phone number that made the call. Formatted in E.164 format. Example: +1234567890

  - `is_cancelled: boolean`

    DEPRECATED: Whether the call has been cancelled. This is derived from `status`. Use `status` instead.

  - `is_completed: boolean`

    DEPRECATED: Whether the call has completed. This is derived from `status`. Use `status` instead.

  - `last_call_attempt: object { id, answered_at, dial_error, 10 more }`

    This represent a single call attempt. A call attempt is a single call made to the phone number.

    - `id: string`

      The ID of the call attempt.

    - `answered_at: unknown`

      The time the call was answered.

    - `dial_error: "number_non_attributed" or "too_many_calls" or "busy" or 5 more`

      The SIP error that occurred.

      - `"number_non_attributed"`

      - `"too_many_calls"`

      - `"busy"`

      - `"temporarily_unavailable"`

      - `"no_answer"`

      - `"no_international_permission"`

      - `"precondition_failed"`

      - `"non_classified_error"`

    - `ended_at: unknown`

      The time the call ended.

    - `phone_number: string`

      The phone number that was called. Formatted in E.164 format. Example: +1234567890

    - `recording_url: string`

      The URL of the audio recording of the call.

    - `result: "IVR" or "voicemail" or "human" or 2 more`

      - `"IVR"`

      - `"voicemail"`

      - `"human"`

      - `"unknown"`

      - `"ios-screening-filter"`

    - `started_at: unknown`

      The time the call started.

    - `status: "queued" or "ringing" or "ongoing" or 2 more`

      The status of the call attempt.

      - `"queued"`

      - `"ringing"`

      - `"ongoing"`

      - `"completed"`

      - `"error"`

    - `end_reason: optional string`

      Reason for ending the call when ended_by is 'agent'. E.g. 'tool_end_call', 'voicemail', 'transfer', 'ivr_no_navigate'.

    - `ended_by: optional "agent" or "user" or "system"`

      Who ended the call: 'agent' (AI agent), 'user' (caller/callee hung up), or 'system' (e.g. max duration limit).

      - `"agent"`

      - `"user"`

      - `"system"`

    - `structured_output: optional map[unknown]`

      The data extracted from the call, using the structured output config from the parent call object.

    - `transcript: optional array of object { content, role, tool_arguments, 2 more }`

      The transcript of the call.

      - `content: string`

      - `role: "user" or "assistant" or "tool"`

        - `"user"`

        - `"assistant"`

        - `"tool"`

      - `tool_arguments: optional map[unknown] or string`

        - `UnionMember0 = map[unknown]`

        - `UnionMember1 = string`

      - `tool_is_error: optional boolean`

      - `tool_name: optional string`

  - `llm_model: object { name, type }  or object { openrouter_model_id, openrouter_provider, type }`

    - `UnionMember0 = object { name, type }`

      - `name: "gpt-4.1" or "ministral-3-8b-instruct"`

        - `"gpt-4.1"`

        - `"ministral-3-8b-instruct"`

      - `type: "dedicated-instance"`

        - `"dedicated-instance"`

    - `UnionMember1 = object { openrouter_model_id, openrouter_provider, type }`

      - `openrouter_model_id: string`

        The model ID to use from OpenRouter. eg: openai/gpt-4.1

      - `openrouter_provider: string`

        The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

      - `type: "openrouter"`

        Use a model from OpenRouter.

        - `"openrouter"`

  - `metadata: map[string]`

    Metadata stored with the call.

  - `organization_id: string`

    The ID of the organization that owns the call.

  - `scheduled_at: unknown`

    The time the call order is scheduled to start.

  - `status: "initializing" or "queued_for_calling" or "calling" or 4 more`

    The status of the call.

    - `"initializing"`

    - `"queued_for_calling"`

    - `"calling"`

    - `"scheduled"`

    - `"completed"`

    - `"cancelled"`

    - `"errored"`

  - `to_phone_number: string`

    The phone number that received the call. Formatted in E.164 format. Example: +1234567890

### Example

```http
curl https://www.getrevox.com/api/call/$ID \
    -H "Authorization: Bearer $REVOX_API_KEY"
```

## Create

**post** `/call`

Place a new outbound call order. Provide either an existing assistant ID or a custom assistant configuration. The call can be scheduled for a specific time or started immediately. A single call order may be resolved over multiple call attempts spanning up to a few days, with automatic retries when voicemail is detected. You can also set concurrency limits and pass prompt variables for dynamic personalization.

### Body Parameters

- `phone_number: string`

  The phone number to call in the E.164 format. Example: +1234567890

- `assistant: optional object { prompt, background_sound, calendly, 14 more }`

  You can provide a custom assistant configuration here. If you don't provide an assistant_id, this assistant object will be used for this call.

  - `prompt: string`

    The prompt to use for the call. This will be given to the LLM (gpt-4.1)

  - `background_sound: optional "audio/office.ogg"`

    The background sound to play during the call. Useful to give the impression that your AI agent is in an office, in the street, or anywhere else you want.

    - `"audio/office.ogg"`

  - `calendly: optional object { connection_id, event_type_id }`

    - `connection_id: string`

      The connection ID representing the link between your Calendly account and Revox.

    - `event_type_id: string`

      The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

  - `call_retry_config: optional object { calling_windows, max_retry_attempts, timezone }`

    Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

    - `calling_windows: array of object { calling_window_end_time, calling_window_start_time, retry_delay_seconds }`

      - `calling_window_end_time: string`

        End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

      - `calling_window_start_time: string`

        Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

      - `retry_delay_seconds: number`

        Delay between retry attempts in seconds. Default: 7200 (2 hours).

    - `max_retry_attempts: number`

      Maximum number of call retry attempts. Default: 3.

    - `timezone: optional string`

      Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

  - `end_of_call_sentence: optional string`

    Optional message to say when the agent decides to end the call.

  - `faq_items: optional array of object { answer, question }`

    FAQ items to associate with this assistant. When provided, replaces all existing FAQ items.

    - `answer: string`

    - `question: string`

  - `first_sentence: optional string`

    The first sentence to use for the call. This will be given to the LLM

  - `first_sentence_delay_ms: optional number`

    Delay in milliseconds before speaking the first sentence. Default: 400.

  - `first_sentence_mode: optional "generated" or "static" or "none"`

    How the first sentence should be handled. "generated" means the LLM will generate a response based on the first_sentence instruction. "static" means the first_sentence will be spoken exactly as provided. "none" means the agent will not speak first and will wait for the user.

    - `"generated"`

    - `"static"`

    - `"none"`

  - `ivr_navigation_enabled: optional boolean`

    Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

  - `llm_model: optional object { name, type }  or object { openrouter_model_id, openrouter_provider, type }`

    - `UnionMember0 = object { name, type }`

      - `name: "gpt-4.1" or "ministral-3-8b-instruct"`

        - `"gpt-4.1"`

        - `"ministral-3-8b-instruct"`

      - `type: "dedicated-instance"`

        - `"dedicated-instance"`

    - `UnionMember1 = object { openrouter_model_id, openrouter_provider, type }`

      - `openrouter_model_id: string`

        The model ID to use from OpenRouter. eg: openai/gpt-4.1

      - `openrouter_provider: string`

        The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

      - `type: "openrouter"`

        Use a model from OpenRouter.

        - `"openrouter"`

  - `max_call_duration_secs: optional number`

    The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

  - `structured_output_config: optional array of object { name, required, type, 2 more }`

    The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

    - `name: string`

    - `required: boolean`

    - `type: "string" or "number" or "boolean" or 3 more`

      - `"string"`

      - `"number"`

      - `"boolean"`

      - `"enum"`

      - `"date"`

      - `"datetime"`

    - `description: optional string`

    - `enum_options: optional array of string`

  - `transfer_phone_number: optional string`

    Phone number to transfer calls to when users request to speak to a human agent in E.164 format (e.g. +1234567890).

  - `voice: optional object { id, provider, speed }`

    The voice to use for the call. You can get the list of voices using the /voices endpoint

    - `id: string`

      The ID of the voice.

    - `provider: "cartesia" or "elevenlabs"`

      The provider of the voice.

      - `"cartesia"`

      - `"elevenlabs"`

    - `speed: optional number`

      The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

  - `voicemail_message: optional string`

    If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

  - `webhook_url: optional string`

    The webhook URL to call when the call is completed.

- `assistant_id: optional string`

  The ID of the assistant to use for this call.

- `concurrency: optional object { key, max }`

  Limit the number of concurrent calls for a given concurrency key.

  - `key: string`

    The key for which you want to limit the number of concurrent calls.

  - `max: number`

    The maximum number of concurrent calls to allow for the given concurrency key.

- `force_now: optional boolean`

  The prompt to use for the call. This will be given to the LLM (gpt-4.1)

- `from_phone_number: optional string`

  The phone number to use for making the call (e.g., +1234567890). If not provided, uses the default trunk.

- `metadata: optional map[string]`

  Metadata to store with the call.

- `prompt_variables: optional map[string]`

  Variables to interpolate into the prompt. Wether you use an assistant_id or an assistant object, this will be used to interpolate the variables into the prompt.

- `scheduled_at: optional string or unknown`

  Schedule the call to start at a specific date and time (ISO 8601 format). If not provided, the call will start immediately.

  - `UnionMember0 = string`

  - `UnionMember1 = unknown`

### Returns

- `call: object { id, assistant, call_attempts, 16 more }`

  This represent a call "order" that was requested by the user. A call order can be resolved over multiple call attempts spanning up to a few days.

  - `id: string`

    The ID of the call.

  - `assistant: object { id, background_sound, calendly, 20 more }`

    - `id: string`

    - `background_sound: "audio/office.ogg"`

      The background sound to play during the call. Useful to give the impression that your AI agent is in an office.

      - `"audio/office.ogg"`

    - `calendly: object { connection_id, event_type_id }`

      - `connection_id: string`

        The connection ID representing the link between your Calendly account and Revox.

      - `event_type_id: string`

        The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

    - `call_retry_config: object { calling_windows, max_retry_attempts, timezone }`

      Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

      - `calling_windows: array of object { calling_window_end_time, calling_window_start_time, retry_delay_seconds }`

        - `calling_window_end_time: string`

          End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

        - `calling_window_start_time: string`

          Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

        - `retry_delay_seconds: number`

          Delay between retry attempts in seconds. Default: 7200 (2 hours).

      - `max_retry_attempts: number`

        Maximum number of call retry attempts. Default: 3.

      - `timezone: optional string`

        Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

    - `created_at: unknown`

    - `end_of_call_sentence: string`

    - `first_sentence: string`

    - `first_sentence_delay_ms: number`

      Delay in milliseconds before speaking the first sentence. Default: 400.

    - `first_sentence_mode: "generated" or "static" or "none"`

      - `"generated"`

      - `"static"`

      - `"none"`

    - `ivr_navigation_enabled: boolean`

      Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

    - `llm_model: object { name, type }  or object { openrouter_model_id, openrouter_provider, type }`

      - `UnionMember0 = object { name, type }`

        - `name: "gpt-4.1" or "ministral-3-8b-instruct"`

          - `"gpt-4.1"`

          - `"ministral-3-8b-instruct"`

        - `type: "dedicated-instance"`

          - `"dedicated-instance"`

      - `UnionMember1 = object { openrouter_model_id, openrouter_provider, type }`

        - `openrouter_model_id: string`

          The model ID to use from OpenRouter. eg: openai/gpt-4.1

        - `openrouter_provider: string`

          The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

        - `type: "openrouter"`

          Use a model from OpenRouter.

          - `"openrouter"`

    - `max_call_duration_secs: number`

      The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

    - `name: string`

    - `organization_id: string`

    - `prompt: string`

    - `structured_output_config: array of object { name, required, type, 2 more }`

      The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

      - `name: string`

      - `required: boolean`

      - `type: "string" or "number" or "boolean" or 3 more`

        - `"string"`

        - `"number"`

        - `"boolean"`

        - `"enum"`

        - `"date"`

        - `"datetime"`

      - `description: optional string`

      - `enum_options: optional array of string`

    - `transfer_phone_number: string`

      Phone number to transfer calls to when users request to speak to a human agent.

    - `updated_at: unknown`

    - `voice: object { id, provider, speed }`

      - `id: string`

        The ID of the voice.

      - `provider: "cartesia" or "elevenlabs"`

        The provider of the voice.

        - `"cartesia"`

        - `"elevenlabs"`

      - `speed: optional number`

        The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

    - `voicemail_message: string`

      If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

    - `webhook_url: string`

      The webhook URL to call when the call is completed.

    - `faq_items: optional array of object { answer, question, id, 2 more }`

      - `answer: string`

      - `question: string`

      - `id: optional string`

      - `needs_human_answer: optional boolean`

      - `source: optional "human" or "ai"`

        - `"human"`

        - `"ai"`

    - `pending_faq_count: optional number`

  - `call_attempts: array of object { id, answered_at, dial_error, 10 more }`

    All call attempts for this call order, ordered by most recent first.

    - `id: string`

      The ID of the call attempt.

    - `answered_at: unknown`

      The time the call was answered.

    - `dial_error: "number_non_attributed" or "too_many_calls" or "busy" or 5 more`

      The SIP error that occurred.

      - `"number_non_attributed"`

      - `"too_many_calls"`

      - `"busy"`

      - `"temporarily_unavailable"`

      - `"no_answer"`

      - `"no_international_permission"`

      - `"precondition_failed"`

      - `"non_classified_error"`

    - `ended_at: unknown`

      The time the call ended.

    - `phone_number: string`

      The phone number that was called. Formatted in E.164 format. Example: +1234567890

    - `recording_url: string`

      The URL of the audio recording of the call.

    - `result: "IVR" or "voicemail" or "human" or 2 more`

      - `"IVR"`

      - `"voicemail"`

      - `"human"`

      - `"unknown"`

      - `"ios-screening-filter"`

    - `started_at: unknown`

      The time the call started.

    - `status: "queued" or "ringing" or "ongoing" or 2 more`

      The status of the call attempt.

      - `"queued"`

      - `"ringing"`

      - `"ongoing"`

      - `"completed"`

      - `"error"`

    - `end_reason: optional string`

      Reason for ending the call when ended_by is 'agent'. E.g. 'tool_end_call', 'voicemail', 'transfer', 'ivr_no_navigate'.

    - `ended_by: optional "agent" or "user" or "system"`

      Who ended the call: 'agent' (AI agent), 'user' (caller/callee hung up), or 'system' (e.g. max duration limit).

      - `"agent"`

      - `"user"`

      - `"system"`

    - `structured_output: optional map[unknown]`

      The data extracted from the call, using the structured output config from the parent call object.

    - `transcript: optional array of object { content, role, tool_arguments, 2 more }`

      The transcript of the call.

      - `content: string`

      - `role: "user" or "assistant" or "tool"`

        - `"user"`

        - `"assistant"`

        - `"tool"`

      - `tool_arguments: optional map[unknown] or string`

        - `UnionMember0 = map[unknown]`

        - `UnionMember1 = string`

      - `tool_is_error: optional boolean`

      - `tool_name: optional string`

  - `call_retry_config: object { calling_windows, max_retry_attempts, timezone }`

    Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

    - `calling_windows: array of object { calling_window_end_time, calling_window_start_time, retry_delay_seconds }`

      - `calling_window_end_time: string`

        End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

      - `calling_window_start_time: string`

        Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

      - `retry_delay_seconds: number`

        Delay between retry attempts in seconds. Default: 7200 (2 hours).

    - `max_retry_attempts: number`

      Maximum number of call retry attempts. Default: 3.

    - `timezone: optional string`

      Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

  - `calls_count: number`

    The number of call attempts made.

  - `campaign: object { id, name }`

    - `id: string`

    - `name: string`

  - `created_at: unknown`

    The time the call order was created.

  - `direction: "inbound" or "outbound"`

    Whether the call is inbound or outbound.

    - `"inbound"`

    - `"outbound"`

  - `first_sentence_delay_ms: number`

    Delay in milliseconds before speaking the first sentence. Default: 400.

  - `from_phone_number: string`

    The phone number that made the call. Formatted in E.164 format. Example: +1234567890

  - `is_cancelled: boolean`

    DEPRECATED: Whether the call has been cancelled. This is derived from `status`. Use `status` instead.

  - `is_completed: boolean`

    DEPRECATED: Whether the call has completed. This is derived from `status`. Use `status` instead.

  - `last_call_attempt: object { id, answered_at, dial_error, 10 more }`

    This represent a single call attempt. A call attempt is a single call made to the phone number.

    - `id: string`

      The ID of the call attempt.

    - `answered_at: unknown`

      The time the call was answered.

    - `dial_error: "number_non_attributed" or "too_many_calls" or "busy" or 5 more`

      The SIP error that occurred.

      - `"number_non_attributed"`

      - `"too_many_calls"`

      - `"busy"`

      - `"temporarily_unavailable"`

      - `"no_answer"`

      - `"no_international_permission"`

      - `"precondition_failed"`

      - `"non_classified_error"`

    - `ended_at: unknown`

      The time the call ended.

    - `phone_number: string`

      The phone number that was called. Formatted in E.164 format. Example: +1234567890

    - `recording_url: string`

      The URL of the audio recording of the call.

    - `result: "IVR" or "voicemail" or "human" or 2 more`

      - `"IVR"`

      - `"voicemail"`

      - `"human"`

      - `"unknown"`

      - `"ios-screening-filter"`

    - `started_at: unknown`

      The time the call started.

    - `status: "queued" or "ringing" or "ongoing" or 2 more`

      The status of the call attempt.

      - `"queued"`

      - `"ringing"`

      - `"ongoing"`

      - `"completed"`

      - `"error"`

    - `end_reason: optional string`

      Reason for ending the call when ended_by is 'agent'. E.g. 'tool_end_call', 'voicemail', 'transfer', 'ivr_no_navigate'.

    - `ended_by: optional "agent" or "user" or "system"`

      Who ended the call: 'agent' (AI agent), 'user' (caller/callee hung up), or 'system' (e.g. max duration limit).

      - `"agent"`

      - `"user"`

      - `"system"`

    - `structured_output: optional map[unknown]`

      The data extracted from the call, using the structured output config from the parent call object.

    - `transcript: optional array of object { content, role, tool_arguments, 2 more }`

      The transcript of the call.

      - `content: string`

      - `role: "user" or "assistant" or "tool"`

        - `"user"`

        - `"assistant"`

        - `"tool"`

      - `tool_arguments: optional map[unknown] or string`

        - `UnionMember0 = map[unknown]`

        - `UnionMember1 = string`

      - `tool_is_error: optional boolean`

      - `tool_name: optional string`

  - `llm_model: object { name, type }  or object { openrouter_model_id, openrouter_provider, type }`

    - `UnionMember0 = object { name, type }`

      - `name: "gpt-4.1" or "ministral-3-8b-instruct"`

        - `"gpt-4.1"`

        - `"ministral-3-8b-instruct"`

      - `type: "dedicated-instance"`

        - `"dedicated-instance"`

    - `UnionMember1 = object { openrouter_model_id, openrouter_provider, type }`

      - `openrouter_model_id: string`

        The model ID to use from OpenRouter. eg: openai/gpt-4.1

      - `openrouter_provider: string`

        The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

      - `type: "openrouter"`

        Use a model from OpenRouter.

        - `"openrouter"`

  - `metadata: map[string]`

    Metadata stored with the call.

  - `organization_id: string`

    The ID of the organization that owns the call.

  - `scheduled_at: unknown`

    The time the call order is scheduled to start.

  - `status: "initializing" or "queued_for_calling" or "calling" or 4 more`

    The status of the call.

    - `"initializing"`

    - `"queued_for_calling"`

    - `"calling"`

    - `"scheduled"`

    - `"completed"`

    - `"cancelled"`

    - `"errored"`

  - `to_phone_number: string`

    The phone number that received the call. Formatted in E.164 format. Example: +1234567890

### Example

```http
curl https://www.getrevox.com/api/call \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $REVOX_API_KEY" \
    -d '{
          "phone_number": "phone_number"
        }'
```

## List

**get** `/call`

Retrieve a paginated list of call attempts. Each entry includes the call status, phone number, assistant used, transcript, and timestamps. Use the page and page_size query parameters to navigate through results.

### Query Parameters

- `page: number`

  The page number you want to get. Starting at 0.

- `page_size: number`

  The number of calls to return per page.

- `statuses: optional array of "initializing" or "queued_for_calling" or "calling" or 4 more`

  - `"initializing"`

  - `"queued_for_calling"`

  - `"calling"`

  - `"scheduled"`

  - `"completed"`

  - `"cancelled"`

  - `"errored"`

### Returns

- `calls: array of object { id, answered_at, dial_error, 10 more }`

  - `id: string`

    The ID of the call attempt.

  - `answered_at: unknown`

    The time the call was answered.

  - `dial_error: "number_non_attributed" or "too_many_calls" or "busy" or 5 more`

    The SIP error that occurred.

    - `"number_non_attributed"`

    - `"too_many_calls"`

    - `"busy"`

    - `"temporarily_unavailable"`

    - `"no_answer"`

    - `"no_international_permission"`

    - `"precondition_failed"`

    - `"non_classified_error"`

  - `ended_at: unknown`

    The time the call ended.

  - `phone_number: string`

    The phone number that was called. Formatted in E.164 format. Example: +1234567890

  - `recording_url: string`

    The URL of the audio recording of the call.

  - `result: "IVR" or "voicemail" or "human" or 2 more`

    - `"IVR"`

    - `"voicemail"`

    - `"human"`

    - `"unknown"`

    - `"ios-screening-filter"`

  - `started_at: unknown`

    The time the call started.

  - `status: "queued" or "ringing" or "ongoing" or 2 more`

    The status of the call attempt.

    - `"queued"`

    - `"ringing"`

    - `"ongoing"`

    - `"completed"`

    - `"error"`

  - `end_reason: optional string`

    Reason for ending the call when ended_by is 'agent'. E.g. 'tool_end_call', 'voicemail', 'transfer', 'ivr_no_navigate'.

  - `ended_by: optional "agent" or "user" or "system"`

    Who ended the call: 'agent' (AI agent), 'user' (caller/callee hung up), or 'system' (e.g. max duration limit).

    - `"agent"`

    - `"user"`

    - `"system"`

  - `structured_output: optional map[unknown]`

    The data extracted from the call, using the structured output config from the parent call object.

  - `transcript: optional array of object { content, role, tool_arguments, 2 more }`

    The transcript of the call.

    - `content: string`

    - `role: "user" or "assistant" or "tool"`

      - `"user"`

      - `"assistant"`

      - `"tool"`

    - `tool_arguments: optional map[unknown] or string`

      - `UnionMember0 = map[unknown]`

      - `UnionMember1 = string`

    - `tool_is_error: optional boolean`

    - `tool_name: optional string`

### Example

```http
curl https://www.getrevox.com/api/call \
    -H "Authorization: Bearer $REVOX_API_KEY"
```