Log an external Call activity | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/activity/call/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "contact_id": "cont_bulY73zoaAwTCLdjHrKzGkzZ942OwtEelJR7kNku9RK",
  "direction": "outbound",
  "duration": 153,
  "lead_id": "lead_fioU1Nk5LC0H0iei9XBGHW2CFZU0yeP2zZCJQP9pC4m",
  "note_html": "<body><p>call notes go here</p></body>",
  "phone": "+16505551234",
  "status": "completed",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}'

{
  "_type": "Call",
  "activity_at": "2013-02-01T00:51:33+00:00",
  "contact_id": "cont_bulY73zoaAwTCLdjHrKzGkzZ942OwtEelJR7kNku9RK",
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2014-05-22T17:39:04.509000+00:00",
  "date_updated": "2014-05-22T17:39:04.509000+00:00",
  "id": "acti_wJGiBIXXBCpBAQacZ7axeOhgTS7TWxyU7ml4WqAswOb",
  "lead_id": "lead_fioU1Nk5LC0H0iei9XBGHW2CFZU0yeP2zZCJQP9pC4m",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "source": "External",
  "status": "completed",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "created_by_name": "Stefan Wójcik",
  "updated_by_name": "Phil Freo",
  "user_name": "Stefan Wójcik",
  "call_method": "external",
  "cost": "0",
  "direction": "outbound",
  "disposition": "answered",
  "duration": 153,
  "local_country_iso": "US",
  "note": "call notes go here",
  "note_html": "<body><p>call notes go here</p></body>",
  "phone": "+16505551234",
  "remote_country_iso": "US",
  "remote_phone": "+16505551234",
  "remote_phone_formatted": "+1 650-555-1234"
}

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://)

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://)

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

activity_atdatetime or nullOptional

contact_idstring or nullOptional

conversation_type_idstring or nullOptional

created_by_idstring or nullOptional

custom_fieldsmap from strings to any or nullOptional

date_createddatetime or nullOptional

directionenumOptional

Allowed values:

durationinteger or nullOptional<=604800

lead_idstring or nullOptional

notestring or nullOptional

note_htmlstring or nullOptional

organization_idstring or nullOptional

outcome_idstring or nullOptional

phonestring or nullOptional

Phone number in E.164 format

playbook_idstring or nullOptional

quality_infostring or nullOptional

recording_urlstring or nullOptionalformat: "uri"

sourceenumOptional

Allowed values:

statusenumOptional

user_idstring or nullOptional

voicemail_urlstring or nullOptionalformat: "uri"

Response

Successful response

_typestring

activity_atdatetime or null

contact_idstring or null

created_bystring or null

date_createddatetime

date_updateddatetime

idstring

lead_idstring or null

organization_idstring

outcome_idstring or null

sourceenum

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.

Allowed values:

statusenum

Current status of the call.

updated_bystring or null

user_idstring or null

userslist of strings

created_by_namestring or null

sequence_idstring or null

sequence_namestring or null

sequence_subscription_idstring or null

updated_by_namestring or null

user_namestring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error