Phone numbers

Provision managed numbers, import SIP-trunk numbers, update routing, and manage phone-number business verification.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

[
  {
    "id": "string",
    "organizationId": "string",
    "e164": "+12015551234",
    "source": "managed",
    "providerResourceId": "string",
    "telnyxPhoneNumberId": "string",
    "sipTrunkId": "string",
    "sipConnectionInstallationId": "string",
    "sipProviderName": "string",
    "direction": "inbound",
    "dispatchMetadataTemplate": {},
    "agentId": "string",
    "routeToBrokerId": "string",
    "label": "string",
    "sms10dlcProfileId": "string",
    "smsCampaignId": "string",
    "smsAssignmentStatus": "string",
    "smsAssignmentUpdatedAt": "2019-08-24T14:15:22Z",
    "telnyxMessagingProfileId": "string",
    "smsMessagingProfileStatus": "pending",
    "smsMessagingProfileUpdatedAt": "2019-08-24T14:15:22Z",
    "smsMessagingProfileError": "string",
    "smsAutomationEnabled": true,
    "setupStatus": {
      "status": "ready",
      "inboundReady": true,
      "outboundReady": true,
      "agentReady": true,
      "forwardingRequired": true,
      "forwardingSipUri": "string",
      "sipConnectionReady": true,
      "issues": [
        "string"
      ]
    },
    "nextChargeAt": "2019-08-24T14:15:22Z",
    "lastChargedAt": "2019-08-24T14:15:22Z",
    "suspendedAt": "2019-08-24T14:15:22Z",
    "billingSuspendedAt": "2019-08-24T14:15:22Z",
    "complianceSuspendedAt": "2019-08-24T14:15:22Z",
    "suspensionReason": "billing",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

e164*E164

Match^\+[1-9]\d{6,14}$

direction?PhoneNumberDirection

Value in"inbound" | "outbound" | "both"

dispatchMetadataTemplate?

label?string

Lengthlength <= 120

agentId?string

Response Body

`application/json`

{
  "id": "string",
  "organizationId": "string",
  "e164": "+12015551234",
  "source": "managed",
  "providerResourceId": "string",
  "telnyxPhoneNumberId": "string",
  "sipTrunkId": "string",
  "sipConnectionInstallationId": "string",
  "sipProviderName": "string",
  "direction": "inbound",
  "dispatchMetadataTemplate": {},
  "agentId": "string",
  "routeToBrokerId": "string",
  "label": "string",
  "sms10dlcProfileId": "string",
  "smsCampaignId": "string",
  "smsAssignmentStatus": "string",
  "smsAssignmentUpdatedAt": "2019-08-24T14:15:22Z",
  "telnyxMessagingProfileId": "string",
  "smsMessagingProfileStatus": "pending",
  "smsMessagingProfileUpdatedAt": "2019-08-24T14:15:22Z",
  "smsMessagingProfileError": "string",
  "smsAutomationEnabled": true,
  "setupStatus": {
    "status": "ready",
    "inboundReady": true,
    "outboundReady": true,
    "agentReady": true,
    "forwardingRequired": true,
    "forwardingSipUri": "string",
    "sipConnectionReady": true,
    "issues": [
      "string"
    ]
  },
  "nextChargeAt": "2019-08-24T14:15:22Z",
  "lastChargedAt": "2019-08-24T14:15:22Z",
  "suspendedAt": "2019-08-24T14:15:22Z",
  "billingSuspendedAt": "2019-08-24T14:15:22Z",
  "complianceSuspendedAt": "2019-08-24T14:15:22Z",
  "suspensionReason": "billing",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "Invalid request body",
  "code": "VALIDATION_ERROR"
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

areaCode?string

Match^\d{3}$

locality?string

limit?integer

Default10

Range1 <= value <= 50

Response Body

`application/json`

[
  {
    "e164": "+12015551234",
    "friendlyName": "string",
    "monthlyCostUsd": 0,
    "upfrontCostUsd": 0,
    "features": [
      "string"
    ],
    "region": {}
  }
]

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

e164*E164

Match^\+[1-9]\d{6,14}$

sipConnectionInstallationId?string

Installed SIP connection integration id. Preferred for new imports.

sipTrunkId?string

Legacy outbound trunk id. Required when sipConnectionInstallationId is omitted.

sipProviderName?string

direction?PhoneNumberDirection

Value in"inbound" | "outbound" | "both"

dispatchMetadataTemplate?

label?string

Lengthlength <= 120

agentId?string

Response Body

`application/json`

{
  "id": "string",
  "organizationId": "string",
  "e164": "+12015551234",
  "source": "managed",
  "providerResourceId": "string",
  "telnyxPhoneNumberId": "string",
  "sipTrunkId": "string",
  "sipConnectionInstallationId": "string",
  "sipProviderName": "string",
  "direction": "inbound",
  "dispatchMetadataTemplate": {},
  "agentId": "string",
  "routeToBrokerId": "string",
  "label": "string",
  "sms10dlcProfileId": "string",
  "smsCampaignId": "string",
  "smsAssignmentStatus": "string",
  "smsAssignmentUpdatedAt": "2019-08-24T14:15:22Z",
  "telnyxMessagingProfileId": "string",
  "smsMessagingProfileStatus": "pending",
  "smsMessagingProfileUpdatedAt": "2019-08-24T14:15:22Z",
  "smsMessagingProfileError": "string",
  "smsAutomationEnabled": true,
  "setupStatus": {
    "status": "ready",
    "inboundReady": true,
    "outboundReady": true,
    "agentReady": true,
    "forwardingRequired": true,
    "forwardingSipUri": "string",
    "sipConnectionReady": true,
    "issues": [
      "string"
    ]
  },
  "nextChargeAt": "2019-08-24T14:15:22Z",
  "lastChargedAt": "2019-08-24T14:15:22Z",
  "suspendedAt": "2019-08-24T14:15:22Z",
  "billingSuspendedAt": "2019-08-24T14:15:22Z",
  "complianceSuspendedAt": "2019-08-24T14:15:22Z",
  "suspensionReason": "billing",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "Invalid request body",
  "code": "VALIDATION_ERROR"
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

{
  "status": "missing",
  "submission": {
    "id": "string",
    "organizationId": "string",
    "status": "draft",
    "businessProfile": {
      "legalName": "string",
      "displayName": "string",
      "entityType": "string",
      "country": "string",
      "registrationId": "string",
      "website": "http://example.com",
      "address": {},
      "useCase": "string",
      "expectedUsage": "string"
    },
    "authorizedRepresentative": {
      "name": "string",
      "title": "string",
      "email": "user@example.com",
      "phone": "+12015551234"
    },
    "declaration": {
      "businessName": "string",
      "useCase": "string"
    },
    "attestor": {
      "kind": "user",
      "userId": "string",
      "name": "string",
      "email": "user@example.com",
      "organizationRole": "string"
    },
    "attestationAccepted": true,
    "attestationVersion": "string",
    "attestationText": "string",
    "termsVersion": "string",
    "attestedAt": "2019-08-24T14:15:22Z",
    "accessHoldAt": "2019-08-24T14:15:22Z",
    "accessHoldReason": "rejected",
    "submittedByUserId": "string",
    "submittedByEmail": "user@example.com",
    "submittedByApiKeyId": "string",
    "submittedAt": "2019-08-24T14:15:22Z",
    "reviewerUserId": "string",
    "reviewerEmail": "user@example.com",
    "reviewedAt": "2019-08-24T14:15:22Z",
    "rejectionReason": "string",
    "slackNotificationStatus": "not_queued",
    "slackNotificationJobId": "string",
    "slackNotificationError": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "declarationPrefill": {
    "businessName": "string",
    "useCase": "string"
  },
  "requiredAttestation": {
    "version": "string",
    "text": "string",
    "termsVersion": "string",
    "termsUrl": "http://example.com"
  },
  "attestationRequired": true,
  "complianceAccess": "enabled",
  "prefill": {
    "businessProfile": {
      "legalName": "string",
      "displayName": "string",
      "entityType": "string",
      "country": "string",
      "registrationId": "string",
      "website": "http://example.com",
      "address": {},
      "useCase": "string",
      "expectedUsage": "string"
    },
    "authorizedRepresentative": {
      "name": "string",
      "title": "string",
      "email": "user@example.com",
      "phone": "+12015551234"
    }
  }
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

businessProfile*

authorizedRepresentative*

attestationAccepted?boolean

Defaultfalse

Response Body

`application/json`

{
  "id": "string",
  "organizationId": "string",
  "status": "draft",
  "businessProfile": {
    "legalName": "string",
    "displayName": "string",
    "entityType": "string",
    "country": "string",
    "registrationId": "string",
    "website": "http://example.com",
    "address": {},
    "useCase": "string",
    "expectedUsage": "string"
  },
  "authorizedRepresentative": {
    "name": "string",
    "title": "string",
    "email": "user@example.com",
    "phone": "+12015551234"
  },
  "declaration": {
    "businessName": "string",
    "useCase": "string"
  },
  "attestor": {
    "kind": "user",
    "userId": "string",
    "name": "string",
    "email": "user@example.com",
    "organizationRole": "string"
  },
  "attestationAccepted": true,
  "attestationVersion": "string",
  "attestationText": "string",
  "termsVersion": "string",
  "attestedAt": "2019-08-24T14:15:22Z",
  "accessHoldAt": "2019-08-24T14:15:22Z",
  "accessHoldReason": "rejected",
  "submittedByUserId": "string",
  "submittedByEmail": "user@example.com",
  "submittedByApiKeyId": "string",
  "submittedAt": "2019-08-24T14:15:22Z",
  "reviewerUserId": "string",
  "reviewerEmail": "user@example.com",
  "reviewedAt": "2019-08-24T14:15:22Z",
  "rejectionReason": "string",
  "slackNotificationStatus": "not_queued",
  "slackNotificationJobId": "string",
  "slackNotificationError": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "Invalid request body",
  "code": "VALIDATION_ERROR"
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

declaration*

attestationAccepted*boolean

Value intrue

attestationVersion*string

businessProfile*

authorizedRepresentative*

attestationAccepted*boolean

Defaultfalse

Value intrue

attestationVersion?string

Response Body

`application/json`

{
  "id": "string",
  "organizationId": "string",
  "status": "draft",
  "businessProfile": {
    "legalName": "string",
    "displayName": "string",
    "entityType": "string",
    "country": "string",
    "registrationId": "string",
    "website": "http://example.com",
    "address": {},
    "useCase": "string",
    "expectedUsage": "string"
  },
  "authorizedRepresentative": {
    "name": "string",
    "title": "string",
    "email": "user@example.com",
    "phone": "+12015551234"
  },
  "declaration": {
    "businessName": "string",
    "useCase": "string"
  },
  "attestor": {
    "kind": "user",
    "userId": "string",
    "name": "string",
    "email": "user@example.com",
    "organizationRole": "string"
  },
  "attestationAccepted": true,
  "attestationVersion": "string",
  "attestationText": "string",
  "termsVersion": "string",
  "attestedAt": "2019-08-24T14:15:22Z",
  "accessHoldAt": "2019-08-24T14:15:22Z",
  "accessHoldReason": "rejected",
  "submittedByUserId": "string",
  "submittedByEmail": "user@example.com",
  "submittedByApiKeyId": "string",
  "submittedAt": "2019-08-24T14:15:22Z",
  "reviewerUserId": "string",
  "reviewerEmail": "user@example.com",
  "reviewedAt": "2019-08-24T14:15:22Z",
  "rejectionReason": "string",
  "slackNotificationStatus": "not_queued",
  "slackNotificationJobId": "string",
  "slackNotificationError": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "Invalid request body",
  "code": "VALIDATION_ERROR"
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

{
  "error": "string",
  "code": "string",
  "requiredAttestation": {
    "version": "string",
    "text": "string",
    "termsVersion": "string",
    "termsUrl": "http://example.com"
  }
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Resource id.

Response Body

`application/json`

{
  "id": "string",
  "organizationId": "string",
  "e164": "+12015551234",
  "source": "managed",
  "providerResourceId": "string",
  "telnyxPhoneNumberId": "string",
  "sipTrunkId": "string",
  "sipConnectionInstallationId": "string",
  "sipProviderName": "string",
  "direction": "inbound",
  "dispatchMetadataTemplate": {},
  "agentId": "string",
  "routeToBrokerId": "string",
  "label": "string",
  "sms10dlcProfileId": "string",
  "smsCampaignId": "string",
  "smsAssignmentStatus": "string",
  "smsAssignmentUpdatedAt": "2019-08-24T14:15:22Z",
  "telnyxMessagingProfileId": "string",
  "smsMessagingProfileStatus": "pending",
  "smsMessagingProfileUpdatedAt": "2019-08-24T14:15:22Z",
  "smsMessagingProfileError": "string",
  "smsAutomationEnabled": true,
  "setupStatus": {
    "status": "ready",
    "inboundReady": true,
    "outboundReady": true,
    "agentReady": true,
    "forwardingRequired": true,
    "forwardingSipUri": "string",
    "sipConnectionReady": true,
    "issues": [
      "string"
    ]
  },
  "nextChargeAt": "2019-08-24T14:15:22Z",
  "lastChargedAt": "2019-08-24T14:15:22Z",
  "suspendedAt": "2019-08-24T14:15:22Z",
  "billingSuspendedAt": "2019-08-24T14:15:22Z",
  "complianceSuspendedAt": "2019-08-24T14:15:22Z",
  "suspensionReason": "billing",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Resource id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

direction?PhoneNumberDirection

Value in"inbound" | "outbound" | "both"

dispatchMetadataTemplate?

label?string

Lengthlength <= 120

agentId?string

routeToBrokerId?string

Org-defined broker id whose softphone this number rings instead of an agent. Mutually exclusive with agentId — setting one clears the other. Requires human calling to be enabled for the workspace.

smsAutomationEnabled?boolean

Owner/admin-only opt-in for inbound SMS agent replies on this number.

Response Body

`application/json`

{
  "id": "string",
  "organizationId": "string",
  "e164": "+12015551234",
  "source": "managed",
  "providerResourceId": "string",
  "telnyxPhoneNumberId": "string",
  "sipTrunkId": "string",
  "sipConnectionInstallationId": "string",
  "sipProviderName": "string",
  "direction": "inbound",
  "dispatchMetadataTemplate": {},
  "agentId": "string",
  "routeToBrokerId": "string",
  "label": "string",
  "sms10dlcProfileId": "string",
  "smsCampaignId": "string",
  "smsAssignmentStatus": "string",
  "smsAssignmentUpdatedAt": "2019-08-24T14:15:22Z",
  "telnyxMessagingProfileId": "string",
  "smsMessagingProfileStatus": "pending",
  "smsMessagingProfileUpdatedAt": "2019-08-24T14:15:22Z",
  "smsMessagingProfileError": "string",
  "smsAutomationEnabled": true,
  "setupStatus": {
    "status": "ready",
    "inboundReady": true,
    "outboundReady": true,
    "agentReady": true,
    "forwardingRequired": true,
    "forwardingSipUri": "string",
    "sipConnectionReady": true,
    "issues": [
      "string"
    ]
  },
  "nextChargeAt": "2019-08-24T14:15:22Z",
  "lastChargedAt": "2019-08-24T14:15:22Z",
  "suspendedAt": "2019-08-24T14:15:22Z",
  "billingSuspendedAt": "2019-08-24T14:15:22Z",
  "complianceSuspendedAt": "2019-08-24T14:15:22Z",
  "suspensionReason": "billing",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "Invalid request body",
  "code": "VALIDATION_ERROR"
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Resource id.

Response Body

`application/json`

{
  "released": true
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

200application/json

401application/json

200application/json

400application/json

401application/json

200application/json

401application/json

200application/json

400application/json

401application/json

200application/json

401application/json

200application/json

400application/json

401application/json

200application/json

400application/json

401application/json

409application/json

200application/json

401application/json

200application/json

400application/json

401application/json

200application/json

401application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`