Browse the API reference

Campaigns

Launch a campaign's calls

View as Markdown
posthttps://www.getrevox.com/api/campaigns/{id}/launch-calls

Send the campaign's calls matching a selection. In ai_first mode each call is handed to the admission scheduler at the requested time and follows the retry configuration from there. In speed_dial mode a live operator session dials them, and any call waiting on an AI retry is un-scheduled first so the same contact is never dialed twice. Calls the AI is already dialing are skipped; any other call, finished or cancelled included, is launched again.

Path parameters

  • idstringrequired

Request body

  • modeenum (string)required

    One ofai_firstspeed_dial

  • scheduled_atstring (date-time)

    When to place the calls (ISO 8601). Omit to launch now. ai_first only — a speed dial session cannot be scheduled.

  • max_attemptsinteger

    ai_first only. How many more attempts each launched call gets from now, replacing whatever it had left. Defaults to the campaign's max_retry_attempts. With the campaign's call_twice_in_a_row on, the double call counts as 2 of these attempts when both calls happen: with 1, there is no double call.

    max 9007199254740991 · > 0

  • selectionobjectrequired
    Show 2 fields
    • filtersobjectrequired
      Show 7 fields
      • querystring
      • statusesarray of enum (string)required

        Default []

      • directionsarray of enum (string)required

        Default []

      • resultsarray of enum (string)required

        Default []

      • outcomesarray of enum (string)required

        Default []

      • assignee_idsarray of one ofrequired

        Default []

        Show 2 variants

        1. One ofstringstring

        2. One ofstringstring (constant)

      • variablesarray of object
        Show 2 fields
        • keystringrequired
        • valuestringrequired
    • rowsobjectrequired

      Default {"mode":"all_except","call_ids":[]}

      Show 2 fields
      • modeenum (string)required

        One ofall_exceptonly

      • call_idsarray of stringrequired

Responses

200Success
  • launchednumberrequired
  • skippedobjectrequired
    Show 4 fields
    • activenumberrequired
    • already_reachednumberrequired
    • attempts_exhaustednumberrequired
    • cancellednumberrequired
  • sessionobject
    Show 11 fields
    • idstring (uuid)required
    • campaign_idstring (uuid)required
    • statusenum (string)required

      One ofdialingconnectedcompletedstoppederrored

    • outcome_filterarray of enum (string)required
    • current_call_idstring (uuid)requirednullable
    • total_targetsnumberrequired
    • dialed_countnumberrequired
    • connected_countnumberrequired
    • in_flight_callsarray of Callrequired
    • created_atone ofrequired
      Show 2 variants

      1. One ofstringstring (date-time)

      2. One ofOption 2any

    • ended_atone ofrequirednullable
      Show 2 variants

      1. One ofstringstring (date-time)

      2. One ofOption 2any

400Invalid request: the body or a parameter failed validation
  • messagestring
  • errorstring
  • bodyErrorsobject

    The validation errors returned from the API.

    Show 1 field
    • issuesarray of objectrequired
      Show 3 fields
      • patharray of one ofrequired
        Show 2 variants

        1. One ofstringstring

        2. One ofnumbernumber

      • messagestringrequired
      • codestring
402Not enough credits on the organization
  • errorstringrequired
  • codestring (constant)required

    Always "INSUFFICIENT_BALANCE"

404Not found in your organization
  • errorstringrequired
409Conflict with the resource's current state
  • errorstringrequired