Sign in
Advanced

Submit details of an inbound call to the CRM.

This endpoint allows you to submit information about an inbound call to the CRM system. The request must include details such as the external call ID, call status, and involved phone numbers. This operation helps in logging and managing inbound call data within the CRM.

post/crm/v3/extensions/calling/inbound-call

Request body

callStartedTimestampstring date-time

The timestamp indicating when the call started, formatted as a date-time string.

createEngagementboolean required

Indicates whether an engagement should be created for the call.

durationSecondsinteger

The duration of the call in seconds.

engagementPropertiesobject required

Contains additional properties related to the engagement.

externalCallIdstring required

The unique identifier for the call from an external system.

finalCallStatus'BUSY' | 'CALLING_CRM_USER' | 'CANCELED' | 'COMPLETED' | 'CONNECTING' | 'FAILED' | 'HOLD' | 'IN_PROGRESS' | 'MISSED' | 'NO_ANSWER' | 'QUEUED' | 'RINGING' | 'UNKNOWN' required

The final status of the call, with accepted values including: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN.

potentialRecipientUserIdsinteger[] required
userIdinteger

The ID of the user associated with the call.

Response

successful operation