uc
call

Updates the UcCall identified by id. Provide the unified UcCall fields to change in the request body.

patch/uc/{connection_id}/call/{id}

Request

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Call

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

Unique identifier for this call object

created_atstring date-time

The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

contact_idstring

The contact ID for call (reference to UcContact)

start_atstring date-time

The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring

(reference to HrisEmployee)

is_privateboolean
user_namestring
user_phonestring
type'INBOUND' | 'OUTBOUND'
rawobject

The raw data returned by the integration for this call

conversation_identifierstring

opaque identifier shared across legs of one interaction

status'QUEUED' | 'RINGING' | 'IN_PROGRESS' | 'COMPLETED' | 'BUSY' | 'NO_ANSWER' | 'FAILED' | 'CANCELED' | 'OTHER'

The current or final status of the call

answer_atstring date-time

When the call was answered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

duration_secondsnumber

Call length in seconds

cost_amountnumber

What the integration charged for the call

currencystring

ISO 4217 currency of cost_amount

parent_idstring

The parent call (leg) that this call belongs to

Response

Successful

idstring

Unique identifier for this call object

created_atstring date-time

The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

contact_idstring

The contact ID for call (reference to UcContact)

start_atstring date-time

The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring

(reference to HrisEmployee)

is_privateboolean
user_namestring
user_phonestring
type'INBOUND' | 'OUTBOUND'
rawobject

The raw data returned by the integration for this call

conversation_identifierstring

opaque identifier shared across legs of one interaction

status'QUEUED' | 'RINGING' | 'IN_PROGRESS' | 'COMPLETED' | 'BUSY' | 'NO_ANSWER' | 'FAILED' | 'CANCELED' | 'OTHER'

The current or final status of the call

answer_atstring date-time

When the call was answered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

duration_secondsnumber

Call length in seconds

cost_amountnumber

What the integration charged for the call

currencystring

ISO 4217 currency of cost_amount

parent_idstring

The parent call (leg) that this call belongs to

Changes