Call

Fields

• idstringrequired

  The ID of the call.

• organization_idstringrequired

  The ID of the organization that owns the call.

• from_phone_numberstringrequired

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

• to_phone_numberstringrequired

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

• directionenum (string)required

  Whether the call is inbound or outbound.

  One ofinboundoutbound

• channelenum (string)required

  web for a test call taken in the browser: its phone number is a placeholder, never dialed.

  One ofphoneweb

• statusenum (string)required

  The status of the call.

  One ofinitializingqueued_for_callingcallingpost_processingnot_launchedscheduledpausedcompletedcancellederrored

• is_completedbooleanrequired

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

  Default false

• is_cancelledbooleanrequired

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

  Default false

• cancel_reasonstring (constant)nullable

  Why the call was cancelled, when it can be told. prospect_called_back: the prospect called back before the next retry, so the pending retry was cancelled and their call is recorded as a separate inbound call. Null for a manual or campaign cancel, and for calls that are not cancelled.

  Always "prospect_called_back"

• retries_stoppedbooleanrequired

  Whether no further attempt will be made for this call: it was cancelled, or its future attempts were stopped while an attempt was already in progress (that attempt still finishes). Unlike is_cancelled, this is true as soon as retries are stopped, before the call reaches a terminal status.

  Default false

• callback_fromobjectnullable

  For an inbound call only: the outbound call this one answers, when the prospect rang us back after we called them. Null for every other call.

  Show 2 fieldsHide 2 fields

  • call_idstringrequired
  • created_atanyrequired
• calls_countnumberrequired

  The number of call attempts made.

• last_call_attemptCallAttemptrequirednullable
• call_retry_configCallRetryConfigrequirednullable
• llm_modelone ofrequired
  Show 2 variantsHide 2 variants

  1. One ofOption 1one of

  2. One ofLegacyobject

     • typeenum (string)required

       One ofdedicated-instancefireworksopenroutercustomgemma-4-31b-racing

• call_attemptsarray of CallAttemptrequired

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

• assistantAssistantrequirednullable
• prompt_versionobjectnullable

  The assistant prompt version the call's prompt was compiled from. Null for calls created before versions were tracked, and for calls made with an inline assistant.

  Show 3 fieldsHide 3 fields

  • idstringrequired

    The ID of the assistant prompt version.

  • numberintegerrequired

    The version's number in the assistant's prompt history (v1 is the oldest).

    min -9007199254740991 · max 9007199254740991

  • latest_numberintegerrequired

    The number of the assistant's current prompt version. Higher than number when the call was left on an older version, e.g. because it lacks a variable the newer prompt uses.

    min -9007199254740991 · max 9007199254740991

• campaignobjectrequirednullable
  Show 3 fieldsHide 3 fields

  • idstringrequired
  • namestringrequired
  • statusenum (string)required

    One ofrunningpausedcompleted

• scheduled_atanyrequirednullable

  The time the call order is scheduled to start.

• created_atanyrequired

  The time the call order was created.

• updated_atanyrequired

  The time the call order was last updated (any state change, retry, or analysis result).

• metadatamap of stringrequirednullable

  Metadata stored with the call.

• prompt_variablesmap of stringrequirednullable

  Variables used to interpolate the prompt.

• transfer_destinationsarray of objectrequirednullable

  Where this call can be transferred, if anywhere.

  Show 2 fieldsHide 2 fields

  • labelstringrequired

    min length 1 · max length 60

  • phone_numberstringrequired
• contactobjectrequired

  Magic contact variables (prospect identity) extracted from the call's input data and transcript.

  Show 5 fieldsHide 5 fields

  • first_namestringrequirednullable
  • last_namestringrequirednullable
  • emailstringrequirednullable
  • companystringrequirednullable
  • job_titlestringrequirednullable
• first_sentence_delay_msintegerrequired

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

  min -9007199254740991 · max 9007199254740991

• visual_numberintegernullable

  Campaign-scoped display number for the call ("#14" on the live campaign board), assigned when a human answers. Null outside campaigns or before a human picked up. Gaps are normal.

  min -9007199254740991 · max 9007199254740991

• outcomeenum (string)nullable

  Business outcome of the call. Null if not computed or no transcript.

  One ofnot_interestedinterestedcompletedrequested_callback_later

• outcome_summarystringnullable

  LLM explanation for the outcome, when outcome was computed from the transcript.

• do_not_callboolean

  True when the prospect's phone number is on the do-not-call list: it can no longer be called.

• assigneeobjectrequirednullable

  The team member assigned to follow up on this call. Null when unassigned.

  Show 4 fieldsHide 4 fields

  • idstringrequired

    The database user id of the assignee.

  • emailstringrequired
  • first_namestringrequirednullable
  • last_namestringrequirednullable