Skip to main content
POST
Initiates a phone call.

Body

The call initiation request containing phone number and optional metadata.

Request schema for the Leadping API phone call initiation request, including the fields clients can send.

fromPhoneNumberId
string | null

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

conversationId
string | null

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

leadId
string

Lead ID associated with the outbound call request.

wasManuallyOverridden
boolean

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

campaignId
string | null

Messaging campaign identifier associated with this phone call initiation request.

sourceId
string | null

Lead source ID used for call attribution and sender selection.

outboundIdempotencyKey
string | null

Idempotency key used to prevent duplicate outbound delivery.

Response

Calls was successfully initiated.

Response schema for the Leadping API phone call returned to authenticated clients.

status
enum<string>

Current lifecycle status for this phone call in the Leadping API.

Available options:
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
statusReason
string | null

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

direction
string | null

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

conversationId
string | null

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

leadId
string | null

Lead ID associated with the call conversation or outreach attempt.

phoneNumber
string

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

toPhoneNumber
string | null

Recipient phone number used for this communication.

fromPhoneNumberId
string | null

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

fromPhoneNumber
string | null

Sender phone number used for this communication.

callerId
string | null

Caller ID phone number presented during the outbound call.

selectionReason
enum<string> | null

Defines the supported Outgoing Number Selection Reason values.

Available options:
StickyConversation,
LeadAssigned,
CampaignOrSource,
Preferred,
LocalArea,
HealthyPool,
FallbackDefault,
ManualOverride
wasManuallyOverridden
boolean

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

campaignId
string | null

Messaging campaign identifier associated with this phone call.

sourceId
string | null

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

endedAt
string<date-time> | null

UTC timestamp when the call ended.

queuedAt
string<date-time> | null

UTC timestamp when Leadping queued this phone call for processing.

ringingAt
string<date-time> | null

UTC timestamp when the call started ringing.

answeredAt
string<date-time> | null

UTC timestamp when the call was answered.

durationSeconds
string<int32> | null

Call duration in seconds.

Pattern: ^-?(?:0|[1-9]\d*)$
billingStatus
string | null

Billing state for this communication, charge, or transaction.

billableAmount
string<double> | null

Monetary amount billed for this Leadping communication or transaction.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
recordingUrl
string | null

URL for the call recording, when the provider makes one available.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.