List calls

GET

/v1/calls

const url = 'https://api.vocapable.com/v1/calls?limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.vocapable.com/v1/calls?limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Parameters

Query Parameters

limit

Limit

integer

default: 50 >= 1 <= 200

cursor

Any of:

string
null

string

agent_id

Any of:

string
null

string

Filter on agent_id. Comma-separated values are OR.

agent_id.gte

Any of:

string
null

string

Filter on agent_id with the gte operator.

agent_id.lte

Any of:

string
null

string

Filter on agent_id with the lte operator.

agent_id.gt

Any of:

string
null

string

Filter on agent_id with the gt operator.

agent_id.lt

Any of:

string
null

string

Filter on agent_id with the lt operator.

agent_id.in

Any of:

string
null

string

Filter on agent_id with the in operator.

agent_version_id

Any of:

string
null

string

Filter on agent_version_id. Comma-separated values are OR.

agent_version_id.gte

Any of:

string
null

string

Filter on agent_version_id with the gte operator.

agent_version_id.lte

Any of:

string
null

string

Filter on agent_version_id with the lte operator.

agent_version_id.gt

Any of:

string
null

string

Filter on agent_version_id with the gt operator.

agent_version_id.lt

Any of:

string
null

string

Filter on agent_version_id with the lt operator.

agent_version_id.in

Any of:

string
null

string

Filter on agent_version_id with the in operator.

campaign_id

Any of:

string
null

string

Filter on campaign_id. Comma-separated values are OR.

campaign_id.gte

Any of:

string
null

string

Filter on campaign_id with the gte operator.

campaign_id.lte

Any of:

string
null

string

Filter on campaign_id with the lte operator.

campaign_id.gt

Any of:

string
null

string

Filter on campaign_id with the gt operator.

campaign_id.lt

Any of:

string
null

string

Filter on campaign_id with the lt operator.

campaign_id.in

Any of:

string
null

string

Filter on campaign_id with the in operator.

contact_id

Any of:

string
null

string

Filter on contact_id. Comma-separated values are OR.

contact_id.gte

Any of:

string
null

string

Filter on contact_id with the gte operator.

contact_id.lte

Any of:

string
null

string

Filter on contact_id with the lte operator.

contact_id.gt

Any of:

string
null

string

Filter on contact_id with the gt operator.

contact_id.lt

Any of:

string
null

string

Filter on contact_id with the lt operator.

contact_id.in

Any of:

string
null

string

Filter on contact_id with the in operator.

created_at

Any of:

string
null

string

Filter on created_at. Comma-separated values are OR.

created_at.gte

Any of:

string
null

string

Filter on created_at with the gte operator.

created_at.lte

Any of:

string
null

string

Filter on created_at with the lte operator.

created_at.gt

Any of:

string
null

string

Filter on created_at with the gt operator.

created_at.lt

Any of:

string
null

string

Filter on created_at with the lt operator.

created_at.in

Any of:

string
null

string

Filter on created_at with the in operator.

direction

Any of:

string
null

string

Filter on direction. Comma-separated values are OR.

direction.gte

Any of:

string
null

string

Filter on direction with the gte operator.

direction.lte

Any of:

string
null

string

Filter on direction with the lte operator.

direction.gt

Any of:

string
null

string

Filter on direction with the gt operator.

direction.lt

Any of:

string
null

string

Filter on direction with the lt operator.

direction.in

Any of:

string
null

string

Filter on direction with the in operator.

disposition

Any of:

string
null

string

Filter on disposition. Comma-separated values are OR.

disposition.gte

Any of:

string
null

string

Filter on disposition with the gte operator.

disposition.lte

Any of:

string
null

string

Filter on disposition with the lte operator.

disposition.gt

Any of:

string
null

string

Filter on disposition with the gt operator.

disposition.lt

Any of:

string
null

string

Filter on disposition with the lt operator.

disposition.in

Any of:

string
null

string

Filter on disposition with the in operator.

has_campaign

Any of:

string
null

string

Filter on has_campaign. Comma-separated values are OR.

has_campaign.gte

Any of:

string
null

string

Filter on has_campaign with the gte operator.

has_campaign.lte

Any of:

string
null

string

Filter on has_campaign with the lte operator.

has_campaign.gt

Any of:

string
null

string

Filter on has_campaign with the gt operator.

has_campaign.lt

Any of:

string
null

string

Filter on has_campaign with the lt operator.

has_campaign.in

Any of:

string
null

string

Filter on has_campaign with the in operator.

started_at

Any of:

string
null

string

Filter on started_at. Comma-separated values are OR.

started_at.gte

Any of:

string
null

string

Filter on started_at with the gte operator.

started_at.lte

Any of:

string
null

string

Filter on started_at with the lte operator.

started_at.gt

Any of:

string
null

string

Filter on started_at with the gt operator.

started_at.lt

Any of:

string
null

string

Filter on started_at with the lt operator.

started_at.in

Any of:

string
null

string

Filter on started_at with the in operator.

state

Any of:

string
null

string

Filter on state. Comma-separated values are OR.

state.gte

Any of:

string
null

string

Filter on state with the gte operator.

state.lte

Any of:

string
null

string

Filter on state with the lte operator.

state.gt

Any of:

string
null

string

Filter on state with the gt operator.

state.lt

Any of:

string
null

string

Filter on state with the lt operator.

state.in

Any of:

string
null

string

Filter on state with the in operator.

sub_code

Any of:

string
null

string

Filter on sub_code. Comma-separated values are OR.

sub_code.gte

Any of:

string
null

string

Filter on sub_code with the gte operator.

sub_code.lte

Any of:

string
null

string

Filter on sub_code with the lte operator.

sub_code.gt

Any of:

string
null

string

Filter on sub_code with the gt operator.

sub_code.lt

Any of:

string
null

string

Filter on sub_code with the lt operator.

sub_code.in

Any of:

string
null

string

Filter on sub_code with the in operator.

use_case

Any of:

string
null

string

Filter on use_case. Comma-separated values are OR.

use_case.gte

Any of:

string
null

string

Filter on use_case with the gte operator.

use_case.lte

Any of:

string
null

string

Filter on use_case with the lte operator.

use_case.gt

Any of:

string
null

string

Filter on use_case with the gt operator.

use_case.lt

Any of:

string
null

string

Filter on use_case with the lt operator.

use_case.in

Any of:

string
null

string

Filter on use_case with the in operator.

Responses

200

Successful Response

application/json

CursorPage[CallSummary]

object

data

required

Data

Array<object>

CallSummary

A call as a list endpoint returns it, with its current disposition flattened on.

object

required

string

direction

required

CallDirection

string

Allowed values: outbound inbound browser

state

required

CallState

string

Allowed values: initiated ringing in_progress completed no_answer busy failed

campaign_id

Any of:

string
null

string

contact_id

Any of:

string
null

string

contact_first_name

Any of:

string
null

string

contact_last_name

Any of:

string
null

string

contact_company

Any of:

string
null

string

counterparty_e164

Any of:

string
null

string

dialed_e164

Any of:

string
null

string

contact_attempt_id

Any of:

string
null

string

agent_version_id

required

Agent Version Id

string

agent_id

Any of:

string
null

string

agent_name

Any of:

string
null

string

use_case

Any of:

string
null

string

summary

Any of:

string
null

string

captured_fields

Captured Fields

object

key

additional properties

any

recorded_responses

Recorded Responses

Array<object>

RecordedCallResponse

Preview of a saved action, distinct from generated post-call analysis.

object

required

string

kind

required

Kind

string

Allowed values: shift_response qualification identity_capture identity_correction

subject_ref

required

Subject Ref

string

response

required

Response

string

revision

required

Revision

integer

source_turn_number

Any of:

integer
null

integer

note

Any of:

string
null

string

note_truncated

Note Truncated

boolean

value

Any of:

string
null

string

value_truncated

Value Truncated

boolean

fit_review

Any of:

QualificationFitPreview
null

QualificationFitPreview

A bounded team-decision preview for a current qualification receipt.

object

status

required

Any of:

string
string

string

Allowed values: good_fit not_a_fit needs_follow_up

reason

Any of:

string
null

string

<= 240 characters

reason_truncated

Reason Truncated

boolean

recorded_response_count

Recorded Response Count

integer

started_at

required

Started At

string format: date-time

ended_at

Any of:

string
null

string format: date-time

duration_ms

Any of:

integer
null

integer

end_reason

Any of:

CallEndReason
null

CallEndReason

string

Allowed values: agent_completed contact_hangup opt_out error max_duration

disposition

Any of:

Disposition
null

Disposition

Terminal outcome of a contact attempt (docs/06-campaign-engine.md).

string

Allowed values: completed_goal completed_no_goal answered_incomplete voicemail_machine no_answer busy failed opt_out wrong_person_opt_out dnc_hit scrub_blocked blocked_by_policy abandoned_no_slot inbound_unavailable browser_unavailable

sub_code

Any of:

string
null

string

recording_id

Any of:

string
null

string

created_at

required

Created At

string format: date-time

next_cursor

Any of:

string
null

string

has_more

Has More

boolean

Example

{
  "data": [
    {
      "direction": "outbound",
      "state": "initiated",
      "recorded_responses": [
        {
          "kind": "shift_response",
          "note_truncated": false,
          "value_truncated": false,
          "fit_review": {
            "status": "good_fit",
            "reason_truncated": false
          }
        }
      ],
      "recorded_response_count": 0,
      "end_reason": "agent_completed",
      "disposition": "completed_goal"
    }
  ],
  "has_more": false
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

List calls

Authorizations

Parameters

Query Parameters

Responses

200

Example

422

Examplegenerated

Example^generated