Calls

Initiate a Leadping phone call

The call operation validates ownership and current provider state before returning the updated Leadping call representation.

post/phone-call/initiate

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/phone-call/initiate
  • Auth: HTTP bearer

Request body

useBrowserPhoneboolean

Connect the authenticated user's browser phone to the server-controlled destination call.

fromPhoneNumberIdstring nullable

Sender phone number ID used for this outbound SMS or call.

conversationIdstring nullable

Conversation ID that links this phone call initiation request to the Leadping inbox thread.

leadIdstring required

Lead ID associated with the outbound call request.

wasManuallyOverriddenboolean

Indicates whether a user manually overrode Leadping's automatic number selection for this phone call initiation request.

campaignIdstring nullable

Messaging campaign identifier associated with this phone call initiation request.

sourceIdstring nullable

Lead source ID used for call attribution and sender selection.

outboundIdempotencyKeystring nullable

Idempotency key used to prevent duplicate outbound delivery.

Example request

{
  "leadId": "lead-123",
  "conversationId": "conversation-123",
  "wasManuallyOverridden": false,
  "outboundIdempotencyKey": "call-example-001"
}

Response

Calls was successfully initiated.

isDemoboolean
status'scheduled' | 'queued' | 'initiated' | 'ringing' | 'in_progress' | 'active' | 'completed' | 'ended' | 'busy' | 'no_answer' | 'failed' | 'canceled' | 'missed' | 'transferred' | 'voicemail' | 'blocked_billing' | 'blocked_phone_number_status' | 'blocked_configuration' | 'blocked_permission' | 'configuration_required'

Describes the durable business outcome of a Leadping phone call after provider status normalization.

statusReasonstring nullable

Human-readable reason explaining the current status of this phone call.

directionstring nullable

Communication direction for this phone call, such as inbound or outbound.

conversationIdstring nullable

Conversation ID that links this phone call to the Leadping inbox thread.

organizationIdstring nullable

The organization context required to handle this call on a mobile device.

leadIdstring nullable

Lead ID associated with the call conversation or outreach attempt.

phoneNumberstring

Phone number used by this phone call for calls, SMS, lookup, or routing.

toPhoneNumberstring nullable

Recipient phone number used for this communication.

fromPhoneNumberIdstring nullable

Sender phone number ID used for this outbound SMS or call.

fromPhoneNumberstring nullable

Sender phone number used for this communication.

callerIdstring nullable

Caller ID phone number presented during the outbound call.

selectionReason'StickyConversation' | 'LeadAssigned' | 'CampaignOrSource' | 'Preferred' | 'LocalArea' | 'HealthyPool' | 'FallbackDefault' | 'ManualOverride' nullable

Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.

wasManuallyOverriddenboolean

Indicates whether a user manually overrode Leadping's automatic number selection for this phone call.

campaignIdstring nullable

Messaging campaign identifier associated with this phone call.

sourceIdstring nullable

Lead source ID used for attribution and routing on this call.

endedAtstring date-time nullable

UTC timestamp when the call ended.

queuedAtstring date-time nullable

UTC timestamp when Leadping queued this phone call for processing.

ringingAtstring date-time nullable

UTC timestamp when the call started ringing.

answeredAtstring date-time nullable

UTC timestamp when the call was answered.

durationSecondsinteger nullable

Call duration in seconds.

billingStatusstring nullable

Billing state for this communication, charge, or transaction.

billableAmountnumber double nullable

Monetary amount billed for this Leadping communication or transaction.

voicemailUrlstring uri nullable

URL for voicemail audio, when the call resulted in a voicemail.

idstring
createdAtstring date-time
modifiedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.