Skip to main content
POST
Gérer un appel entrant

Supported products

Autorisations

Authorization
string
header
requis

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

Corps

application/json
createEngagement
boolean
requis

Un booléen indiquant si un engagement doit être créé pour cet appel.

engagementProperties
object
requis

Une carte des noms de propriétés personnalisées et de leurs valeurs, utilisée pour stocker des informations supplémentaires sur l'engagement.

externalCallId
string
requis

Un identifiant unique pour l'appel fourni par le système externe.

finalCallStatus
enum<string>
requis

Le statut final de l'appel. Les valeurs valides incluent « QUEUED », « RINGING », « IN_PROGRESS », « CANCELED », « COMPLETED », « BUSY », « FAILED », « NO_ANSWER », « CONNECTING », « CALLING_CRM_USER », « MISSED », « HOLD » et « UNKNOWN ».

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

Un tableau d'entiers représentant les identifiants d'utilisateur des destinataires potentiels de l'appel.

toNumber
object
requis
callStartedTimestamp
string<date-time>

La date et l'heure de début de l'appel, au format ISO 8601.

durationSeconds
integer<int32>

La durée de l'appel en secondes, représentée par un entier.

userId
integer<int32>

L'identifiant unique de l'utilisateur associé à l'appel, représenté par un entier.

Réponse

successful operation

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

Un tableau contenant des informations sur les correspondances d'identification de l'appelant. Chaque élément du tableau peut être un objet ContactCallerId ou CompanyCallerId.

Dernière modification le 6 octobre 2026