uc
call
get/uc/{connection_id}/call

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/uc/{connection_id}/call
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

contact_idstring

The contact ID to filter by (reference to UcContact)

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

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

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

Changes