Skip to main content

List calls

GET 

/v2/activities/calls

Fetches multiple call records. The records can be filtered, paged, and sorted according to the respective parameters.

Request

Query Parameters

    ids integer[]

    IDs of calls to fetch. If a record can't be found, that record won't be returned and your request will be successful

    created_at[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    user_guid string[]

    Filters list to only include guids

    Example: [9cc6da15-d403-4f5b-aeed-c4b8463cf9ae]
    person_id integer[]

    Filters calls by person_id. Multiple person ids can be applied

    Example: [1234]
    sentiment string[]

    Filters calls by sentiment. Sentiment matches are exact and case sensitive. Multiple sentiments are allowed.

    Example: [Interested]
    disposition string[]

    Filters calls by disposition. Disposition matches are exact and case sensitive. Multiple dispositions are allowed.

    Example: [Connected]
    sort_by string

    Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at

    sort_direction string

    Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

    per_page integer

    How many records to show per page in the range [1, 100]. Defaults to 25

    page integer

    The current page to fetch results from. Defaults to 1

    include_paging_counts boolean

    Whether to include total_pages and total_count in the metadata. Defaults to false

    limit_paging_counts boolean

    Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

Responses

Success

Schema
    id integer

    ID of Call

    to string

    Phone number that received the call

    duration integer

    Length of the call in seconds

    sentiment string

    Outcome of the conversation

    disposition string

    Result of the call

    created_at date-time

    Datetime of when the call was created

    updated_at date-time

    Datetime of when the call was last updated

    recordings object[]

    The recordings for this this call and their status

  • Array [
  • url string

    The url of the recording

    status string

    The status of the call that produced this recording. Possible values are (but not limited to):

    no-answer: The call was not answered

    failed: The call was not able to be placed

    busy: The call was busy

    ringing: The call is ringing

    in-progress: The call is ongoing

    completed: The call is finished

    recording_status string

    The processing status of the recording. Possible values are (but not limited to):

    not_recorded: there is no recording available, and there will not be one becoming available

    pending: the recording is currently being processed by the system

    processing: the recording is currently being processed by the system

    completed: the recording processing has been completed

  • ]
  • user object

    User that made the call

    id integer
    _href string
    action object

    Action associated to the call

    id integer
    task object

    Task that this call was loged from, or null if not sent through a cadence

    id integer
    called_person object

    The person called

    id integer
    _href string
    crm_activity object

    CRM Activity associated with the call

    id integer
    _href string
    note object

    Note for this call

    id integer
    _href string
    cadence object

    Cadence the call was made on

    id integer
    _href string
    step object

    Step the call was made on

    id integer
    _href string
Loading...