Skip to main content
GET
Get organization phone number warmup status

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

phoneNumberId
string
required

The phone number identifier.

Query Parameters

windowDays
null | integer<int32>

The window days.

startDate
string<date>

The start date.

endDate
string<date>

The end date.

Response

Returns the phone number status response.

Describes a phone number's current warmup stage, limits, progress, and readiness for production traffic.

location
object | null

Public Leadping API schema for phone number location data.

number
string

E.164 phone number exposed by this phone number warmup status.

messagesPossible
integer<int32>

Indicates whether this phone number can currently send SMS messages.

callsPossible
integer<int32>

Indicates whether this phone number can currently place outbound calls.

smsWarmup
object | null

Describes SMS warmup status data returned by Leadping.

outboundCapacity
object | null

Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery.

optOutMetrics
object

Describes phone number opt-out metrics data returned by Leadping.

trafficMetrics
object

Describes phone number traffic metrics data returned by Leadping.

recentEvents
object[]

Recent workflow events returned for timeline and troubleshooting.