Skip to main content
POST
Handle Inbound Call

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
createEngagement
boolean
required

A boolean indicating whether an engagement should be created for this call.

engagementProperties
object
required

A map of custom property names to their values, used to store additional information about the engagement.

externalCallId
string
required

A unique identifier for the call provided by the external system.

finalCallStatus
enum<string>
required

The final status of the call. Valid values include 'QUEUED', 'RINGING', 'IN_PROGRESS', 'CANCELED', 'COMPLETED', 'BUSY', 'FAILED', 'NO_ANSWER', 'CONNECTING', 'CALLING_CRM_USER', 'MISSED', 'HOLD', and 'UNKNOWN'.

Available options:
BUSY,
CALLING_CRM_USER,
CANCELED,
COMPLETED,
CONNECTING,
FAILED,
HOLD,
IN_PROGRESS,
MISSED,
NO_ANSWER,
QUEUED,
RINGING,
UNKNOWN
fromNumber
object
required
potentialRecipientUserIds
integer<int32>[]
required

An array of integers representing the user IDs of potential recipients of the call.

toNumber
object
required
callStartedTimestamp
string<date-time>

The date and time when the call started, in ISO 8601 format.

durationSeconds
integer<int32>

The duration of the call in seconds, represented as an integer.

userId
integer<int32>

The unique identifier of the user associated with the call. This is an integer.

Response

successful operation

callerIdMatches
(CONTACT · object | COMPANY · object)[]
required

An array containing information about the caller ID matches. Each item in the array can be either a ContactCallerId or a CompanyCallerId object.

Last modified on September 9, 2026