Calls

Update Call

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

idstringRequired

Request

This endpoint expects an object.
namestringOptional<=40 characters
This is the name of the call. This is just for your own reference.

Response

idstring
This is the unique identifier for the call.
orgIdstring
This is the unique identifier for the org that this call belongs to.
createdAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the call was created.

updatedAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the call was last updated.

typeenum or null
This is the type of call.
Allowed values:
costslist of objects or null
These are the costs of individual components of the call in USD.
messageslist of objects or null
phoneCallTransportenum or null

This is the transport of the phone call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Allowed values:
statusenum or null
This is the status of the call.
endedReasonenum or null
This is the explanation for how the call ended.
destinationobject or null
This is the destination where the call ended up being transferred to. If the call was not transferred, this will be empty.
startedAtstring or nullformat: "date-time"

This is the ISO 8601 date-time string of when the call was started.

endedAtstring or nullformat: "date-time"

This is the ISO 8601 date-time string of when the call was ended.

costdouble or null
This is the cost of the call in USD.
costBreakdownobject or null
This is the cost of the call in USD.
artifactPlanobject or null

This is a copy of assistant artifact plan. This isn’t actually stored on the call but rather just returned in POST /call/web to enable artifact creation client side.

analysisobject or null

This is the analysis of the call. Configure in assistant.analysisPlan.

monitorobject or null

This is to real-time monitor the call. Configure in assistant.monitorPlan.

artifactobject or null

These are the artifacts created from the call. Configure in assistant.artifactPlan.

complianceobject or null

This is the compliance of the call. Configure in assistant.compliancePlan.

campaignIdstring or null
This is the campaign ID that the call belongs to.
assistantIdstring or null
This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead. To start a call with: - Assistant, use `assistantId` or `assistant` - Squad, use `squadId` or `squad` - Workflow, use `workflowId` or `workflow`
assistantobject or null
This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. To start a call with: - Assistant, use `assistant` - Squad, use `squad` - Workflow, use `workflow`
assistantOverridesobject or null

These are the overrides for the assistant or assistantId’s settings and template variables.

squadIdstring or null
This is the squad that will be used for the call. To use a transient squad, use `squad` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` - Workflow, use `workflow` or `workflowId`
squadobject or null
This is a squad that will be used for the call. To use an existing squad, use `squadId` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` - Workflow, use `workflow` or `workflowId`
workflowIdstring or null
This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` - Workflow, use `workflow` or `workflowId`
workflowobject or null
This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` - Workflow, use `workflow` or `workflowId`
workflowOverridesobject or null

These are the overrides for the workflow or workflowId’s settings and template variables.

phoneNumberIdstring or null

This is the phone number that will be used for the call. To use a transient number, use phoneNumber instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

phoneNumberobject or null

This is the phone number that will be used for the call. To use an existing number, use phoneNumberId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customerIdstring or null

This is the customer that will be called. To call a transient customer , use customer instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customerobject or null

This is the customer that will be called. To call an existing customer, use customerId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

namestring or null<=40 characters
This is the name of the call. This is just for your own reference.
schedulePlanobject or null
This is the schedule plan of the call.
transportobject or null
This is the transport of the call.
phoneCallProviderenum or nullDeprecated

This is the provider of the call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Allowed values:
phoneCallProviderIdstring or nullDeprecated

The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage. callControlId in Telnyx.

Only relevant for outboundPhoneCall and inboundPhoneCall type.