OUoutcallerai
public

Create call

Changed on

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

Request

  • Base URL
    https://api.outcallerai.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.outcallerai.com/api/v1/public/agents/{agent_id}/calls
  • Auth
    none declared

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

  • f31729b3306dRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f7903dc1bdbbRevision changes
    • breaking

      removed the success response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      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

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

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

    • info

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

    • info

      added the success response with the status