Skip to main content
POST
/
phone-numbers
Creates a phone number.
curl --request POST \
  --url https://api.leadping.ai/phone-numbers \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "number": "<string>",
  "businessId": "<string>",
  "enabled": true,
  "id": "<string>"
}
'
{
  "number": "<string>",
  "business": {
    "id": "<string>",
    "name": "<string>"
  },
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "teamId": "<string>",
  "campaignId": "<string>",
  "sourceId": "<string>",
  "leadpingOwned": true,
  "provider": "<string>",
  "providerPhoneNumberId": "<string>",
  "providerOrderId": "<string>",
  "providerOrderStatus": "<string>",
  "providerStatus": "<string>",
  "providerError": "<string>",
  "providerSyncedAt": "2023-11-07T05:31:56Z",
  "providerReleasedAt": "2023-11-07T05:31:56Z",
  "capabilities": {
    "sms": true,
    "voice": true,
    "warmup": true,
    "testing": true
  },
  "routing": {
    "smsEnabled": true,
    "voiceEnabled": true,
    "warmupOnly": true,
    "internalTestOnly": true,
    "teamId": "<string>",
    "sourceId": "<string>",
    "campaignId": "<string>",
    "messagingProfileId": "<string>",
    "voiceConnectionId": "<string>"
  },
  "tenDlc": {
    "brandId": "<string>",
    "campaignId": "<string>",
    "campaignStatus": "<string>",
    "assignmentStatus": "<string>",
    "messagingProfileId": "<string>",
    "statusUpdatedAt": "2023-11-07T05:31:56Z",
    "failureReason": "<string>",
    "lastProviderEventId": "<string>"
  },
  "billing": {
    "businessId": "<string>",
    "businessName": "<string>",
    "userId": "<string>",
    "userName": "<string>",
    "subscriptionItemId": "<string>",
    "monthlyAmount": "<string>",
    "channel": "<string>"
  },
  "isPreferred": true,
  "isDefault": true,
  "location": {
    "location": "<string>",
    "state": "<string>",
    "countryCode": "<string>"
  },
  "enabled": true,
  "isInternalPool": true,
  "isApprovedTestDestination": true,
  "isMessagingProgramApproved": true,
  "warmupEnabled": true,
  "warmupHealthScore": "<string>",
  "warmupProgressPercent": "<string>",
  "warmupNextActionAt": "2023-11-07T05:31:56Z",
  "warmupPauseReason": "<string>",
  "healthReason": "<string>",
  "events": [
    {
      "id": "<string>",
      "type": "<string>",
      "title": "<string>",
      "details": "<string>",
      "actorId": "<string>",
      "actorName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Body

The phone number details to create.

Request payload for phone number.

​
name
string
required
Maximum string length: 255
​
number
string

The number value for this phone number.

​
businessId
string | null

The business ID associated with this phone number.

​
enabled
boolean

Whether this phone number is enabled.

​
id
string | null

Response

Returns the phone number response.

API response containing phone number data returned to callers.

​
number
string

The number value for this phone number.

​
business
object

The business value for this phone number.

​
user
object

The user value for this phone number.

​
teamId
string | null

The team ID associated with this phone number.

​
campaignId
string | null

The campaign ID associated with this phone number.

​
sourceId
string | null

The source ID associated with this phone number.

​
leadpingOwned
boolean

Whether this phone number is Leadping owned.

​
provider
string | null

The provider value for this phone number.

​
providerPhoneNumberId
string | null

The provider phone number ID associated with this phone number.

​
providerOrderId
string | null

The provider order ID associated with this phone number.

​
providerOrderStatus
string | null

The current provider order status for this phone number.

​
providerStatus
string | null

The current provider status for this phone number.

​
providerError
string | null

The provider error value for this phone number.

​
providerSyncedAt
string<date-time> | null

The date and time for the provider synced at value on this phone number.

​
providerReleasedAt
string<date-time> | null

The date and time for the provider released at value on this phone number.

​
inventoryState
enum<string>

The current inventory state for this phone number.

Available options:
Available,
Assigned,
Pending verification,
Ready for SMS,
Ready for voice,
Restricted,
Suspended,
Failed,
Released,
Warmup-only,
Internal/test-only
​
capabilities
object

The capabilities value for this phone number.

​
routing
object

The routing value for this phone number.

​
tenDlc
object

The 10DLC value for this phone number.

​
billing
object

The billing value for this phone number.

​
isPreferred
boolean

Whether this phone number is preferred.

​
isDefault
boolean

Whether this phone number is default.

​
location
object

The location value for this phone number.

​
status
enum<string>

The current status for this phone number.

Available options:
Unregistered,
Provisioning,
FailedProvisioning,
Active,
Expired,
Suspended
​
enabled
boolean

Whether this phone number is enabled.

​
isInternalPool
boolean

Whether this phone number is internal pool.

​
isApprovedTestDestination
boolean

Whether this phone number is approved test destination.

​
isMessagingProgramApproved
boolean

Whether this phone number is messaging program approved.

​
warmupEnabled
boolean

Whether warmup is enabled for this phone number.

​
warmupState
enum<string> | null

Defines the supported SMS Warmup Health State values.

Available options:
Not Started,
Warming,
Healthy,
Needs Attention,
Paused,
Blocked,
Ready
​
healthStatus
enum<string> | null

Defines the supported SMS Warmup Health State values.

Available options:
Not Started,
Warming,
Healthy,
Needs Attention,
Paused,
Blocked,
Ready
​
warmupHealthScore
string<int32>

The warmup health score metric for this phone number.

Pattern: ^-?(?:0|[1-9]\d*)$
​
warmupProgressPercent
string<int32>

The warmup progress percent metric for this phone number.

Pattern: ^-?(?:0|[1-9]\d*)$
​
warmupNextActionAt
string<date-time> | null

The date and time for the warmup next action at value on this phone number.

​
warmupPauseReason
string | null

The human-readable warmup pause reason explaining this phone number.

​
healthReason
string | null

The human-readable health reason explaining this phone number.

​
events
object[]

The events included with this phone number.

​
name
string
​
id
string
​
createdAt
string<date-time>
​
modifiedAt
string<date-time> | null