Pular para o conteúdo principal
POST
Atender chamada recebida

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
createEngagement
boolean
obrigatório

Booleano que indica se um engajamento deve ser criado para esta chamada.

engagementProperties
object
obrigatório

Um mapa de nomes de propriedades personalizadas para seus valores, usado para armazenar informações adicionais sobre o engajamento.

externalCallId
string
obrigatório

O identificador exclusivo da chamada fornecido pelo sistema externo.

finalCallStatus
enum<string>
obrigatório

O status final da chamada. Os valores válidos incluem 'QUEUED', 'RINGING', 'IN_PROGRESS', 'CANCELED', 'COMPLETED', 'BUSY', 'FAILED', 'NO_ANSWER', 'CONNECTING', 'CALLING_CRM_USER', 'MISSED', 'HOLD' e 'UNKNOWN'.

Opções disponíveis:
BUSY,
CALLING_CRM_USER,
CANCELED,
COMPLETED,
CONNECTING,
FAILED,
HOLD,
IN_PROGRESS,
MISSED,
NO_ANSWER,
QUEUED,
RINGING,
UNKNOWN
fromNumber
object
obrigatório
potentialRecipientUserIds
integer<int32>[]
obrigatório

Matriz de números inteiros que representa IDs de usuário dos potenciais destinatários da chamada.

toNumber
object
obrigatório
callStartedTimestamp
string<date-time>

Data e hora em que a chamada começou, no formato ISO 8601.

durationSeconds
integer<int32>

A duração da chamada em segundos, representada como um número inteiro.

userId
integer<int32>

Identificador exclusivo do usuário associado à chamada. É um número inteiro.

Resposta

successful operation

callerIdMatches
(CONTACT · object | COMPANY · object)[]
obrigatório

Matriz que contém informações sobre as correspondências de ID do chamador. Cada item na matriz pode ser um objeto ContactCallerId ou CompanyCallerId.

Última modificação em 6 de outubro de 2026