API docs by Redocly

iNumbering Porting API (v2.1.6)

Download OpenAPI specification:Download

E-mail: support@voicetel.com License: Apache 2.0

iNumbering Porting. Authenticate every request with Authorization: Bearer <apikey>. To obtain your API key, POST {"username": <id>, "password": "<password>"} to /v2.2/account/apikey on the same host — this endpoint does not require an Authorization header. The response is {"status":"success","data":{"apikey":"<32-hex-string>"}}.

iNumbering

Carrier port-in/port-out operations.

Port Status

Get port status summary for the authenticated account, ordered by timestamp descending.

Authorizations:
apikey
Request Body schema: application/json

/v2.1/iNumbering/portStatus/

apikey
required
string

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key"
}

Response samples

Content type
application/json
{
  • "statusCode": "200",
  • "status": "Success",
  • "portStatusSummary": [ ]
}

Portability Check

Check number portability. All TNs must be verified here before submitting a portInOrder — returns 412 if any TN was not pre-verified. The portability result is cached for one hour; re-checking within that window returns the cached result.

Authorizations:
apikey
Request Body schema: application/json

/v2/iNumbering/portInAvailability/

apikey
required
string
required
object (tnList)

Tn list shape.

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "tnList": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "serviceAvailable": [ ],
  • "statusCode": "200"
}

Submit Port

Submit a port-in order directly. ADMIN ONLY — customer port submissions must use POST /v2.2/account/port which routes through the LNP review queue. All TNs must first be verified via portInAvailability (returns 412 if not). authDate is auto-set. The configured per-TN port fee is deducted from the account balance.

Authorizations:
apikey
Request Body schema: application/json

/v2/iNumbering/portInOrder/

apikey
required
string
required
object (portInOrder_portInOrder)

Port in order port in order shape.

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "portInOrder": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "orderId": 102644,
  • "statusCode": "200"
}

Update Pin Numbers

Update port-out PINs for phone numbers. portOutPin is optional for each tnItem — if omitted, a random 4-digit PIN (1000-9999) is auto-generated. Only TNs belonging to the authenticated account are processed.

Authorizations:
apikey
Request Body schema: application/json

/v2/iNumbering/portOutPinUpdate/

apikey
required
string
required
object (portOutPin_portOutPin)

Port out pin port out pin shape.

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "portOutPin": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": "200",
  • "portOutPin": {
    },
  • "status": "Success"
}