Skip to main content

PowerDialerCampaignConsole

Live per-campaign progress: lead counts, live and recent calls, and line capacity.

serverTimestampstring<date-time>
campaign object
idstring<uuid>
namestring
statestring

Possible values: [DRAFT, VALIDATING, READY, SCHEDULED, RUNNING, PAUSED, DRAINING, COMPLETED, STOPPED, BLOCKED_ENTITLEMENT, BLOCKED_CONFIGURATION, ERROR]

lockVersioninteger
concurrencyCapinteger
targetAttemptsPerMinuteinteger | nullnullable
maxAttemptsPerLeadinteger
property name*any
leads object
totalinteger
calledinteger
completedinteger
inProgressinteger
remaininginteger
retryScheduledinteger
byState object
property name*integer
property name*any
calls object
liveinteger
connectedNowinteger
placedinteger
connectedinteger
placedLastFiveMinutesinteger
property name*any
capacity object
planSlotsinteger
retellLimitinteger
retellCurrentinteger
property name*any
liveCalls object[]
  • Array [
  • idstring<uuid>
    statestring
    leadNamestring | nullnullable
    destinationstring

    Masked destination number.

    startedAt(string | null)<date-time>nullable
    answeredAt(string | null)<date-time>nullable
    retellCallIdstring | nullnullable
    property name*any
  • ]
  • recentCalls object[]
  • Array [
  • idstring<uuid>
    statestring
    leadNamestring | nullnullable
    destinationstring
    endedAt(string | null)<date-time>nullable
    connectedboolean
    durationSecondsinteger | nullnullable
    outcomestring | nullnullable
    analytics object
    property name*any
    property name*any
  • ]
  • property name*any

    Live per-campaign progress: lead counts, live and recent calls, and line capacity.

    PowerDialerCampaignConsole
    {
    "serverTimestamp": "2024-07-29T15:51:28.071Z",
    "campaign": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "state": "DRAFT",
    "lockVersion": 0,
    "concurrencyCap": 0,
    "targetAttemptsPerMinute": 0,
    "maxAttemptsPerLead": 0
    },
    "leads": {
    "total": 0,
    "called": 0,
    "completed": 0,
    "inProgress": 0,
    "remaining": 0,
    "retryScheduled": 0,
    "byState": {}
    },
    "calls": {
    "live": 0,
    "connectedNow": 0,
    "placed": 0,
    "connected": 0,
    "placedLastFiveMinutes": 0
    },
    "capacity": {
    "planSlots": 0,
    "retellLimit": 0,
    "retellCurrent": 0
    },
    "liveCalls": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "state": "string",
    "leadName": "string",
    "destination": "string",
    "startedAt": "2024-07-29T15:51:28.071Z",
    "answeredAt": "2024-07-29T15:51:28.071Z",
    "retellCallId": "string"
    }
    ],
    "recentCalls": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "state": "string",
    "leadName": "string",
    "destination": "string",
    "endedAt": "2024-07-29T15:51:28.071Z",
    "connected": true,
    "durationSeconds": 0,
    "outcome": "string",
    "analytics": {}
    }
    ]
    }