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 or a lead, 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
Returns all call logs assigned to a particular user.
Request
/v1/callLogs
Query parameters
start
integer
Pagination start
Default
0
limit
integer
For pagination, the limit of entries to be returned. The upper limit is 50.
Response
OK
Expand all
Copy code- true
- [ ... ]▶
- { ... }▶
Get details of a call log
Returns details of a specific call log.
Request
/v1/callLogs/{id}
Path parameters
id
string
required
The ID received when you create the call log
Response
OK
Expand allCopy code- true
- { ... }▶
Add a call log
Adds a new call log.
Request
/v1/callLogs
Body parameters
application/json
user_id
integer
The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users.
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. The activity_id must refer to a call type activity.
subject
string
The name of the activity this call is attached to
duration
string
The duration of the call 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-time
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-time
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. A call log can be associated with either a deal or a lead, but not both at once.
lead_id
string
The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once.
Format
uuid
note
string
The note for the call log in HTML format
Response
OK
Expand allCopy code- true
- { ... }▶
Attach an audio file to the call log
Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.
Request
/v1/callLogs/{id}/recordings
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
OK
Expand allCopy code- true
Delete a call log
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.
Request
/v1/callLogs/{id}
Path parameters
id
string
required
The ID received when you create the call log
Response
OK
Expand allCopy code- true