CallLogs

Call logs describe the outcome of a phone call managed by an integrated provider. Since these logs are also considered activities, they can be associated with a Deal, a Person and/or an Organization. Call logs do differ from other activities, as they only receive the information needed to describe the phone call.

Get all call logs assigned to a particular user

Copy link
Copy to clipboard
GET

/v1/callLogs

Returns all call logs assigned to a particular user

Query parameters

start

integer

Pagination start

Default

0

limit

integer

Items shown per page

Response
200

A list of call logs.

Expand all
Copy code
    • true
    • [ ... ]
      • { ... }

      Get details of a call log

      Copy link
      Copy to clipboard
      GET

      /v1/callLogs/{id}

      Returns details of a specific call log

      Path parameters

      id

      string

      required

      The ID received when you create the call log

      Response
      200

      The requested call log object.

      Expand all
      Copy code
        • true
        • { ... }

        Add a call log

        Copy link
        Copy to clipboard
        POST

        /v1/callLogs

        Adds a new call log

        Body parameters

        application/json

        user_id

        integer

        The ID of the owner of the call log

        activity_id

        integer

        If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify deal_id, person_id or org_id, as they will be ignored in favor of the values already available in the activity.

        subject

        string

        Name of the activity this call is attached to

        duration

        string

        Call duration in seconds

        outcome

        string

        required

        Describes the outcome of the call

        Values

        connected

        no_answer

        left_message

        left_voicemail

        wrong_number

        busy

        from_phone_number

        string

        The number that made the call

        to_phone_number

        string

        required

        The number called

        start_time

        string

        required

        The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.

        Format

        date

        end_time

        string

        required

        The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.

        Format

        date

        person_id

        integer

        The ID of the Person this call is associated with

        org_id

        integer

        The ID of the Organization this call is associated with

        deal_id

        integer

        The ID of the Deal this call is associated with

        note

        string

        Note for the call log in HTML format

        Response
        200

        The call log was successfully created.

        Expand all
        Copy code
          • true
          • { ... }

          Attach an audio file to the call log

          Copy link
          Copy to clipboard
          POST

          /v1/callLogs/{id}/recordings

          Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.

          Path parameters

          id

          string

          required

          The ID received when you create the call log

          Body parameters

          multipart/form-data

          file

          string

          required

          Audio file supported by the HTML5 specification

          Format

          binary

          Response
          200

          The audio recording was successfully added to the log.

          Expand all
          Copy code
            • true

          Delete a call log

          Copy link
          Copy to clipboard
          DELETE

          /v1/callLogs/{id}

          Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.

          Path parameters

          id

          string

          required

          The ID received when you create the call log

          Response
          200

          The call log was successfully deleted.

          Expand all
          Copy code
            • true

          Subscribe to Pipedrive’s Developer Newsletter