CLclose
activities.calls

Log an external Call activity

Changed on

Use this endpoint to log calls made outside of the Close built-in VoIP system.

status: defaults to completed

direction (optional): outbound or inbound

recording_url: you can post a URL pointing to the MP3 recording of your call. For security reasons, we require the URL to be secure (i.e. starting with https://)

post/activity/call/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/activity/call/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Request body

activity_atstring date-time nullable
contact_idstring nullable
conversation_type_idstring nullable
created_bystring nullable
date_createdstring date-time nullable
direction'inbound' | 'outbound' | 'null' nullable
durationinteger nullable
lead_idstring nullable
notestring nullable
note_htmlstring nullable
organization_idstring nullable
outcome_idstring nullable
phonestring nullable

Phone number in E.164 format

playbook_idstring nullable
quality_infostring nullable
recording_urlstring uri nullable
source'Close.io' | 'External' | 'null' nullable
status'created' | 'in-progress' | 'completed' | 'cancel' | 'no-answer' | 'busy' | 'failed' | 'timeout' | 'null' nullable
user_idstring nullable
voicemail_urlstring uri nullable

Response

Successful response

_typestring required
activity_atstring date-time nullable required
contact_idstring nullable required
created_bystring nullable required
created_by_namestring nullable
date_createdstring date-time required
date_updatedstring date-time required
idstring required
lead_idstring nullable required
organization_idstring required
outcome_idstring nullable required
sequence_idstring nullable
sequence_namestring nullable
sequence_subscription_idstring nullable
source'Close.io' | 'External' required

Source of a phone activity. Describes whether the phone activity (such as a call or an SMS) was handled by Close's telephony provider or handled externally by a 3rd party and is merely logged in Close.

status'created' | 'in-progress' | 'completed' | 'cancel' | 'no-answer' | 'busy' | 'failed' | 'timeout' required

Current status of the call.

updated_bystring nullable required
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
usersstring[] required

Changes

  • 8e360c61058cRevision changes
    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the response body for the status

  • 7bdb9cfcca22Revision changes
    • breaking

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+(\.(add|remove))?$ to the request body

    • info

      removed the pattern property ^custom\. from the request body