> ## Documentation Index > Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get business phone number warmup status > Returns warmup status for a phone number, including limits and recent events used for delivery pacing. ## OpenAPI ````yaml /openapi.json get /phone-numbers/{phoneNumberId}/warmup openapi: 3.0.4 info: title: Leadping API description: >- Leadping API for lead intake, messaging, calling, automations, billing, business settings, and compliant lead communication workflows. license: name: MIT url: https://opensource.org/licenses/MIT version: v1 servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: Analytics - name: Automations - name: Contact - name: Conversations - name: Dispositions - name: Feedback - name: Leads - name: LeadStatuses - name: Notifications - name: OutboundDelivery - name: Sources - name: Suppressions - name: Tags - name: Users - name: Calls - name: PhoneNumbers - name: Sms - name: Telephony - name: UserDataExports - name: CallEvents - name: Events - name: SmsEvents - name: Businesses - name: PaymentMethods - name: Transactions - name: Usage - name: Wallets paths: /phone-numbers/{phoneNumberId}/warmup: get: tags: - PhoneNumbers summary: Get business phone number warmup status description: >- Returns warmup status for a phone number, including limits and recent events used for delivery pacing. operationId: PhoneNumbers_GetWarmupStatus parameters: - name: phoneNumberId in: path description: The phone number identifier. required: true schema: type: string - name: windowDays in: query description: The window days. schema: pattern: ^-?(?:0|[1-9]\d*)$ format: int32 - name: startDate in: query description: The start date. schema: type: string format: date - name: endDate in: query description: The end date. schema: type: string format: date responses: '200': description: Returns the phone number status response. content: application/json: schema: allOf: - $ref: '#/components/schemas/PhoneNumberStatusResponse' description: >- Response schema for the Leadping API phone number warmup status returned to authenticated clients. '400': description: The request was invalid or failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' components: schemas: PhoneNumberStatusResponse: type: object properties: number: type: string description: E.164 phone number exposed by this phone number warmup status. messagesPossible: pattern: ^-?(?:0|[1-9]\d*)$ description: Indicates whether this phone number can currently send SMS messages. format: int32 callsPossible: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Indicates whether this phone number can currently place outbound calls. format: int32 smsWarmup: type: object allOf: - $ref: '#/components/schemas/SmsReadinessStatusResponse' description: SMS warmup status for this phone number. nullable: true outboundCapacity: type: object allOf: - $ref: '#/components/schemas/OutboundPhoneNumberCapacity' description: Current outbound SMS and voice capacity for this phone number. nullable: true optOutMetrics: allOf: - $ref: '#/components/schemas/PhoneNumberOptOutMetricsResponse' description: >- Recent SMS opt-out metrics used to evaluate sender health and compliance risk. trafficMetrics: allOf: - $ref: '#/components/schemas/PhoneNumberTrafficMetricsResponse' description: Phone number traffic metrics for recent SMS and call activity. recentEvents: type: array items: allOf: - $ref: '#/components/schemas/PhoneNumberMessagingEventResponse' description: >- Response schema for the Leadping API phone number messaging event returned to authenticated clients. description: Recent workflow events returned for timeline and troubleshooting. description: >- Response schema for the Leadping API phone number warmup status returned to authenticated clients. ProblemDetails: type: object properties: type: type: string description: URI reference that identifies the problem type. nullable: true title: type: string description: Short, human-readable summary of the problem. nullable: true status: pattern: ^-?(?:0|[1-9]\d*)$ description: HTTP status code returned for the problem. format: int32 nullable: true detail: type: string description: >- Human-readable explanation specific to this occurrence of the problem. nullable: true instance: type: string description: >- URI reference that identifies this specific occurrence of the problem. nullable: true SmsReadinessStatusResponse: type: object properties: phoneNumberId: type: string description: The phone number ID associated with this SMS warmup status. phoneNumber: type: string description: The phone number associated with this SMS warmup status. status: allOf: - $ref: '#/components/schemas/SmsReadinessState' description: The current state for this SMS warmup status. healthStatus: allOf: - $ref: '#/components/schemas/SmsReadinessHealthStatus' description: The current delivery-health assessment for this SMS warmup status. healthScore: pattern: ^-?(?:0|[1-9]\d*)$ description: The health score metric for this SMS warmup status. format: int32 progressPercent: pattern: ^-?(?:0|[1-9]\d*)$ description: The progress percent metric for this SMS warmup status. format: int32 warmupEnabled: type: boolean description: Whether warmup is enabled for this SMS warmup status. uiState: allOf: - $ref: '#/components/schemas/SmsReadinessUiState' description: The current UI state for this SMS warmup status. description: API response containing SMS warmup status data returned to callers. OutboundPhoneNumberCapacity: type: object properties: capacityAvailable: type: boolean description: >- Indicates whether Leadping successfully calculated capacity for this phone number. phoneNumberId: type: string description: >- Unique identifier of the phone number associated with this Leadping outbound phone number capacity. nullable: true phoneNumber: type: string description: >- Phone number associated with this Leadping outbound phone number capacity. nullable: true healthStatus: allOf: - $ref: '#/components/schemas/PhoneNumberOutboundHealthStatus' description: >- Current health status for this Leadping outbound phone number capacity. smsRemainingToday: pattern: ^-?(?:0|[1-9]\d*)$ description: >- SMS remaining today for the applicable messaging or voice capacity window. format: int32 smsUsedToday: pattern: ^-?(?:0|[1-9]\d*)$ description: >- SMS used today for the applicable messaging or voice capacity window. format: int32 smsLimitToday: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Number of SMS limit today represented by this Leadping outbound phone number capacity. format: int32 smsDailyResetsAt: type: string description: Next midnight Eastern time, when SMS daily capacity resets. format: date-time nullable: true smsRemainingThisHour: pattern: ^-?(?:0|[1-9]\d*)$ description: >- SMS remaining this hour for the applicable messaging or voice capacity window. format: int32 smsUsedThisHour: pattern: ^-?(?:0|[1-9]\d*)$ description: >- SMS used this hour for the applicable messaging or voice capacity window. format: int32 smsLimitThisHour: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Number of SMS limit this hour represented by this Leadping outbound phone number capacity. format: int32 smsHourlyResetsAt: type: string description: >- Start of the next Eastern time hour, when SMS hourly capacity resets. format: date-time nullable: true voiceRemainingToday: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Voice remaining today for the applicable messaging or voice capacity window. format: int32 voiceUsedToday: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Voice used today for the applicable messaging or voice capacity window. format: int32 voiceLimitToday: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Voice limit today associated with this Leadping outbound phone number capacity. format: int32 voiceDailyResetsAt: type: string description: Next midnight Eastern time, when voice daily capacity resets. format: date-time nullable: true voiceRemainingThisHour: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Voice remaining this hour for the applicable messaging or voice capacity window. format: int32 voiceUsedThisHour: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Voice used this hour for the applicable messaging or voice capacity window. format: int32 voiceLimitThisHour: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Voice limit this hour associated with this Leadping outbound phone number capacity. format: int32 voiceHourlyResetsAt: type: string description: >- Start of the next Eastern time hour, when voice hourly capacity resets. format: date-time nullable: true description: Represents outbound phone number capacity data used by Leadping. PhoneNumberOptOutMetricsResponse: type: object properties: windowDays: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of days included in the metrics reporting window. format: int32 windowStartedAt: type: string description: UTC timestamp when the metrics reporting window starts. format: date-time distinctContactedCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of distinct recipients contacted during this metrics window. format: int32 optOutCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of recipients who opted out during this metrics window. format: int32 optOutRatePercent: pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ description: >- Percentage of contacted recipients who opted out during this metrics window. format: double description: >- Response schema for the Leadping API phone number opt-out metrics response returned to authenticated clients. PhoneNumberTrafficMetricsResponse: type: object properties: windowDays: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of days included in the metrics reporting window. format: int32 windowStartedAt: type: string description: UTC timestamp when the metrics reporting window starts. format: date-time smsSentCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of SMS messages sent during this metrics window. format: int32 smsFailedCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of SMS messages that failed during this metrics window. format: int32 callPlacedCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of outbound calls placed during this metrics window. format: int32 callFailedCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of outbound calls that failed during this metrics window. format: int32 callConnectedCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of outbound calls that connected during this metrics window. format: int32 callShortCount: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Number of connected outbound calls shorter than 30 seconds during this metrics window. format: int32 callInvalidNumberCount: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Number of outbound calls that failed because the destination number was invalid during this metrics window. format: int32 trend: type: array items: allOf: - $ref: '#/components/schemas/PhoneNumberTrafficTrendPoint' description: >- Time-series data point schema for Leadping API phone number traffic trend bucket charts and metrics. description: >- Time-series buckets that show how the metric changes across the reporting window. description: >- Response schema for the Leadping API phone number traffic metrics response returned to authenticated clients. PhoneNumberMessagingEventResponse: type: object properties: id: type: string description: Unique Leadping identifier for this phone number messaging event. createdAt: type: string description: UTC timestamp when this phone number messaging event was created. format: date-time label: type: string description: >- Short display label for this phone number messaging event, formatted for charts, filters, or list views. eventType: type: string description: >- Event type used to classify this timeline, SMS, call, or automation event. direction: type: string description: >- Communication direction for this phone number messaging event, such as inbound or outbound. fromPhoneNumber: type: string description: Sender phone number used for this communication. toPhoneNumber: type: string description: Recipient phone number used for this communication. textPreview: type: string description: >- Short preview of the SMS or conversation text for this phone number messaging event. isOptOut: type: boolean description: >- Indicates whether the recipient has opted out of further SMS communication. description: >- Response schema for the Leadping API phone number messaging event returned to authenticated clients. SmsReadinessState: enum: - Not Started - In Progress - Paused - Blocked - Ready type: string description: Defines the supported SMS readiness states. SmsReadinessHealthStatus: enum: - Not Evaluated - Evaluating - Healthy - Needs Attention - Blocked type: string description: Defines the supported SMS readiness health assessments. SmsReadinessUiState: type: object properties: label: allOf: - $ref: '#/components/schemas/SmsReadinessState' description: The human-readable label shown for this SMS readiness UI state. tone: type: string description: The tone value for this SMS readiness UI state. description: type: string description: The human-readable description of this SMS readiness UI state. description: >- API DTO containing SMS readiness UI state data used by Leadping API contracts. PhoneNumberOutboundHealthStatus: enum: - unknown - new - healthy - warmup - limited - cooling_down - suspended - disabled type: string description: Defines phone-number outbound health states used by pacing. PhoneNumberTrafficTrendPoint: type: object properties: startAt: type: string description: UTC timestamp when this reporting bucket starts. format: date-time endAt: type: string description: UTC timestamp when this reporting bucket ends. format: date-time label: type: string description: >- Short display label for this phone number traffic trend bucket, formatted for charts, filters, or list views. smsSentCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of SMS messages sent during this metrics window. format: int32 smsFailedCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of SMS messages that failed during this metrics window. format: int32 callPlacedCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of outbound calls placed during this metrics window. format: int32 callFailedCount: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of outbound calls that failed during this metrics window. format: int32 description: >- Time-series data point schema for Leadping API phone number traffic trend bucket charts and metrics. ````