Sign in
public

Create call

Initiate one or more outbound calls to leads assigned to a voice agent. Accepts a single lead_id or an array of lead_ids.

post/api/v1/public/agents/{agent_id}/calls

Path parameters

agent_idstring required

Headers

Idempotency-Keystring nullable

Request body

lead_idstring nullable
lead_idsstring[] nullable
phonestring nullable

Response

Successful Response

idstring required
leadIdstring required
useCaseIdstring nullable
useCaseNamestring nullable
agentIdstring nullable
agentNamestring nullable
transcriptionstring nullable
summarystring nullable
recordingUrlstring nullable
billDurationinteger nullable
callDurationinteger nullable
startTimestring date-time nullable
endTimestring date-time nullable
callConclusionstring nullable
apiCallbackUrlstring nullable
billedDurationinteger nullable
billableDurationSecondsinteger nullable
billableCostInrnumber nullable
statusstring nullable
callSuccessboolean nullable
callRatingnumber nullable
aiCallRatingnumber nullable
humanCallRatingnumber nullable
callFeedbackstring nullable

Changes

Changed in 2 of the 16 revisions of this API.1212

  • f31729b3306d4See the full diff
    • ○

      added the optional property items/agentId to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property items/agentName to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property items/useCaseId to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property items/useCaseName to the response with the 201 status

      response-optional-property-added

  • f7903dc1bdbb128See the full diff
    • ▲

      removed the success response with the status 200

      response-success-status-removed

    • ●

      removed the request property description

      request-property-removed

    • ●

      removed the request property name

      request-property-removed

    • ○

      api operation id start_public_agent_call_api_v1_public_agents__agent_id__calls_post removed and replaced with create_public_agent_call_api_v1_public_agents__agent_id__calls_post

      api-operation-id-removed

    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • ○

      added the new optional request property lead_id

      new-optional-request-property

    • ○

      added the new optional request property lead_ids

      new-optional-request-property

    • ○

      the request property phone became optional

      request-property-became-optional

    • ○

      request property phone list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      the phone request property's minLength was decreased from 4 to 0

      request-property-min-length-decreased

    • ○

      added the success response with the status 201

      response-success-status-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog