API ReferenceCalls

Create Client Call

Create a new phone call record associated with a client

Authentication

x-api-keystring
API Key authentication via header

Path parameters

clientIdstringRequired
Client identifier

Request

This endpoint expects an object.
fromNumberstringRequired
Phone number that initiated the call
toNumberstringRequired
Phone number that received the call
isInboundbooleanRequiredDefaults to false

Whether the call was inbound (true) or outbound (false)

startTimestringRequiredformat: "date-time"
When the call started
endTimestringRequiredformat: "date-time"
When the call ended
reasonenumRequired
Reason for the call
dispositionenumRequired
Call disposition
outcomeenumOptional
Call outcome
Allowed values:
notestringOptional
Notes about the call
recordingUrlstringOptional
URL to the call recording
transcriptUrlstringOptional
URL to the call transcript

Response

Call record created successfully
idinteger
Call identifier
fromNumberstring
Phone number that initiated the call
toNumberstring
Phone number that received the call
isInboundboolean

Whether the call was inbound (true) or outbound (false)

createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
outcomeenum or null
Call outcome
Allowed values:
startTimestring or nullformat: "date-time"
When the call started
endTimestring or nullformat: "date-time"
When the call ended
reasonenum or null
Reason for the call
dispositionenum or null
Call disposition
notestring or null
Notes about the call
recordingUrlstring or null
URL to the call recording
transcriptUrlstring or null
URL to the call transcript
missedCountinteger or null
Number of times the call was missed

Errors