Skip to main content
POST
json

Body

application/json
PortInNumber
string
required

Phone number to port in (E.164 format)

Example:

"+11234567890"

CurrentCarrierName
string
required

Name of the losing carrier

Example:

"Company LLC"

CurrentAccountNumber
string
required

Account number with current carrier

Example:

"4651234567"

CurrentBillingAddress
object
required
CurrentAccountPassword
string

Account PIN/password with current carrier (optional)

Example:

"0550"

ICCID
string

SIM card ICCID (optional)

Example:

"8901240397190557414F"

TargetPortinClassification
enum<string>

Classification type for the port-in

Available options:
mvno,
iot
Example:

"mvno"

SubscriberName
string

Name of the subscriber (optional)

Example:

"John Doe"

MessageType
enum<string>

Message type: a2p (Application-to-Person) or p2p (Person-to-Person)

Available options:
a2p,
p2p
Example:

"a2p"

MessageEnabled
boolean

Enable SMS on the ported-in number. Independent of MMS — set the MmsMessageEnabled field to control MMS.

Example:

true

MmsMessageEnabled
boolean

Optional. Enable MMS on the ported-in number. Independent of MessageEnabled (SMS). MMS can also be changed later via POST /v1.0/numbers/mms/update.

Example:

true

MessageRouteId
string

MRID for message routing configuration (required when SMS or MMS is enabled)

Example:

"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee"

VoiceEnabled
boolean

Enable voice call capabilities

Example:

true

VoiceRouteId
string

CRID for voice routing configuration (required when voice is enabled)

Example:

"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe"

DataEnabled
boolean

Enable data capabilities (for IoT numbers)

Example:

true

AssignedSubscriberId
string

Telegent Subscriber ID to assign to the number (optional). Format: TSUID- followed by a UUID.

Example:

"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d"

ProductType
enum<string>

Product type for the number

Available options:
Sms-Only,
Data-Only,
Sms+Data,
Sms+Data+Voice
Example:

"Sms+Data+Voice"

Response

Success — returns the port-in order ID and initial status

The response is of type object.