Sign in
Developer
Developer - Outbound Calls

Get Outbound Dial Status

Changed on

Today's outbound dial budget for this customer and how much is spent.

Read-only view of what the dialer sees, so the callback dial share can be set with its live effect on screen instead of inferred from logs.

The counters here are the async twins of the synchronous ones in app.tasks.outbound_tasks; each is commented with the sync original it mirrors. The ET day bounds come from the same shared helper both use, which is what keeps the two from disagreeing about which day it is.

get/developer/outbound-dial-status

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/developer/outbound-dial-status
  • Auth: none declared

Response

Successful Response

max_calls_per_number_per_dayinteger nullable

Per-number daily cap. Null means no limit.

callback_dial_share_percentinteger required

Share of the daily budget callback re-dials may spend

eligible_number_countinteger required

Outbound numbers the dialer may currently use

daily_dial_budgetinteger nullable

eligible_number_count x max_calls_per_number_per_day. Null when there is no per-number cap.

callback_sub_capinteger nullable

Callback dials allowed today. Null means no reservation is in force.

reserved_for_new_leadsinteger nullable

Dials held back from callbacks for first attempts. Null when there is no reservation.

dials_todayinteger required

Outbound calls this customer placed today (ET)

callback_dials_todayinteger required

Of those, callback re-dials

first_attempt_dials_todayinteger required

Of those, first attempts

callback_budget_remaininginteger nullable

Callback dials left today. Null when there is no reservation.

in_calling_windowboolean required
calling_window_startstring time nullable
calling_window_endstring time nullable
next_calling_window_openstring date-time nullable
current_time_etstring time required
hours_follow_lead_timezoneboolean
queued_first_attempt_countinteger required
queued_callback_countinteger required

Changes

  • d61063451a04Revision changes
    • info

      added the optional property to the response with the status

  • 7255c82c55a0Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      response property calling_window_end list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property calling_window_start list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the optional property to the response with the status