Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Communication V2

Get a call by ID

Returns the call identified by the given communication ID. The communication must be a call record, and the caller must have manage permission on the owning lead; otherwise 400 PERMISSION_DENIED is returned (no existence leak). Manually logged calls (those with no backing dialer record) are populated from the communication content itself — leadPhoneNumber from the logged number and direction inferred from the channel; dialer-only fields (elapsedTime, status, etc.) are omitted.

Webhook follow-up: when a Call webhook is delivered, pass each createdCall[].timelineId from the payload as the communicationId path parameter to fetch the full record. The legacy createdCall[].callId field is kept for backward compatibility but is not interchangeable across communicationType (it points at the dialer record for MANUAL calls) — prefer timelineId.

get/v2.0/communication/call/{communicationId}

Path parameters

communicationIdinteger required

Communication ID of the call.

Headers

Authorizationstring required

Bearer [access_token]

Response

Call retrieved successfully.

idinteger

ID of the call.

dialerCallRecordIdinteger

Internal dialer call record ID.

userIdinteger

User ID of the agent on the call.

userPhoneNumberstring

Phone number used by the agent.

leadIdinteger

ID of the lead on the call.

leadPhoneNumberstring

Phone number of the lead.

direction'Outbound' | 'Inbound'

Direction of the call from the agent's point of view.

status'Completed' | 'Missed' | 'Failed' | 'Busy' | 'NoAnswer' | 'VoiceMail'

Final call status.

startTimestring

Start time of the call, formatted as 'yyyy-MM-dd HH:mm:ss' in UTC.

endTimestring

End time of the call, formatted as 'yyyy-MM-dd HH:mm:ss' in UTC.

durationinteger

Call duration in seconds.

callingOutcome'Talked' | 'VoiceMessage' | 'NoAnswer' | 'BadNumber' | 'DNCNumber' | 'DNCContact'

Outcome tag assigned by the agent.

rateScoreinteger

Agent's subjective rating of the call, 0-5.

recordingSwitchboolean

Whether the call was recorded.

showUserNumberstring

Phone number displayed to the lead (caller ID).

createTimestring

Creation time of the call record, formatted as 'yyyy-MM-dd HH:mm:ss' in UTC.

updateTimestring

Last-updated time of the call record, formatted as 'yyyy-MM-dd HH:mm:ss' in UTC.

notestring

Free-text note entered by the agent for the call.

isMachineAnsweredboolean

Whether the call was answered by a voicemail / answering machine.

pricenumber double

Cost of the call in USD.

agentIdinteger

User ID of the related agent.

elapsedTimestring

Time from dialing to connection, formatted as 'mm:ss' or similar.

Example response

{
  "id": 563172647619608,
  "dialerCallRecordId": 400000012345,
  "userId": 100234,
  "userPhoneNumber": "+14155550100",
  "leadId": 100001,
  "leadPhoneNumber": "+14155550199",
  "direction": "Outbound",
  "status": "Completed",
  "startTime": "2026-04-22 10:15:00",
  "endTime": "2026-04-22 10:18:45",
  "duration": 225,
  "callingOutcome": "Talked",
  "rateScore": 4,
  "recordingSwitch": true,
  "showUserNumber": "+14155550100",
  "createTime": "2026-04-22 10:15:00",
  "updateTime": "2026-04-22 10:18:45",
  "note": "Discussed pre-approval timeline.",
  "price": 0.02,
  "agentId": 100234,
  "elapsedTime": "00:08"
}