PhoneNumbers

Select conversation sender number

Selects the outgoing phone number for an existing conversation, considering assignments, overrides, and delivery eligibility.

post/phone-numbers/outgoing/conversation/{conversationId}

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}
  • Auth: HTTP bearer

Path parameters

conversationIdstring required

The conversation identifier.

Request body

conversationIdstring nullable

Conversation ID that links this outgoing number selection request to the Leadping inbox thread.

leadIdstring nullable

Lead ID used to choose the best outgoing sender number.

recipientPhoneNumberstring nullable

Recipient phone number that receives the outbound message or call.

channel'sms' | 'call' nullable

Identifies whether an outgoing phone number is eligible for voice, SMS, MMS, or another communication channel.

campaignIdstring nullable

Messaging campaign identifier associated with this outgoing number selection request.

sourceIdstring nullable

Lead source ID used to choose the best outgoing sender number.

teamIdstring nullable

Organization ID used to choose the best outgoing sender number.

Response

Returns the outgoing number selection response.

canSendboolean

Indicates whether Leadping can send outbound messages using this outgoing number selection response.

setupMessagestring nullable

Human-readable setup guidance shown for this outgoing number selection response.

phoneNumberIdstring nullable

Leadping phone number ID connected to this outgoing number selection response.

numberstring nullable

E.164 phone number exposed by this outgoing number selection response.

displayNumberstring nullable

Human-readable phone number shown in Leadping UI and API responses.

healthStatus'Not Evaluated' | 'Evaluating' | 'Healthy' | 'Needs Attention' | 'Blocked' nullable

Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.

healthLabelstring nullable

Short label describing the health state for display in dashboards.

healthWarningstring nullable

Warning text that explains a potential health or readiness issue.

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

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

reasonLabelstring nullable

Human-readable label for the reason code on this outgoing number selection response.

wasManuallyOverriddenboolean

Indicates whether a user manually overrode Leadping's automatic number selection for this outgoing number selection response.

campaignIdstring nullable

Messaging campaign identifier associated with this outgoing number selection response.

sourceIdstring nullable

Lead source ID considered when Leadping selected the outgoing phone number.

Changes

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