Submit a port-out request for a number
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"losing_carrier_account_number": "1234567890",
"authorized_person": "Jane Operator",
"target_carrier_ocn": "0451",
"port_out_pin": "8321"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out"
payload = {
"losing_carrier_account_number": "1234567890",
"authorized_person": "Jane Operator",
"target_carrier_ocn": "0451",
"port_out_pin": "8321"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
losing_carrier_account_number: '1234567890',
authorized_person: 'Jane Operator',
target_carrier_ocn: '0451',
port_out_pin: '8321'
})
};
fetch('https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'losing_carrier_account_number' => '1234567890',
'authorized_person' => 'Jane Operator',
'target_carrier_ocn' => '0451',
'port_out_pin' => '8321'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out"
payload := strings.NewReader("{\n \"losing_carrier_account_number\": \"1234567890\",\n \"authorized_person\": \"Jane Operator\",\n \"target_carrier_ocn\": \"0451\",\n \"port_out_pin\": \"8321\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"losing_carrier_account_number\": \"1234567890\",\n \"authorized_person\": \"Jane Operator\",\n \"target_carrier_ocn\": \"0451\",\n \"port_out_pin\": \"8321\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"losing_carrier_account_number\": \"1234567890\",\n \"authorized_person\": \"Jane Operator\",\n \"target_carrier_ocn\": \"0451\",\n \"port_out_pin\": \"8321\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"phoneNumber": "<string>",
"provider": "telnyx",
"providerOrderId": "<string>",
"providerStatus": "<string>",
"focDate": "2023-11-07T05:31:56Z",
"portStatus": "port_out_pending"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Numbers
Submit a port-out request for a number
Start moving a number to another carrier without contacting support: the platform dispatches the port-out to the number’s current provider and, on success, records the carrier-confirmed order id and FOC date. Requires the losing-carrier account number, an authorized signatory, and the winning carrier’s OCN; include the port-out PIN when protection is enabled on the number.
POST
/
api
/
v1
/
numbers
/
{id}
/
port-out
Submit a port-out request for a number
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"losing_carrier_account_number": "1234567890",
"authorized_person": "Jane Operator",
"target_carrier_ocn": "0451",
"port_out_pin": "8321"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out"
payload = {
"losing_carrier_account_number": "1234567890",
"authorized_person": "Jane Operator",
"target_carrier_ocn": "0451",
"port_out_pin": "8321"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
losing_carrier_account_number: '1234567890',
authorized_person: 'Jane Operator',
target_carrier_ocn: '0451',
port_out_pin: '8321'
})
};
fetch('https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'losing_carrier_account_number' => '1234567890',
'authorized_person' => 'Jane Operator',
'target_carrier_ocn' => '0451',
'port_out_pin' => '8321'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out"
payload := strings.NewReader("{\n \"losing_carrier_account_number\": \"1234567890\",\n \"authorized_person\": \"Jane Operator\",\n \"target_carrier_ocn\": \"0451\",\n \"port_out_pin\": \"8321\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"losing_carrier_account_number\": \"1234567890\",\n \"authorized_person\": \"Jane Operator\",\n \"target_carrier_ocn\": \"0451\",\n \"port_out_pin\": \"8321\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/numbers/{id}/port-out")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"losing_carrier_account_number\": \"1234567890\",\n \"authorized_person\": \"Jane Operator\",\n \"target_carrier_ocn\": \"0451\",\n \"port_out_pin\": \"8321\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"phoneNumber": "<string>",
"provider": "telnyx",
"providerOrderId": "<string>",
"providerStatus": "<string>",
"focDate": "2023-11-07T05:31:56Z",
"portStatus": "port_out_pending"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Body
application/json
Account number with the number's current carrier.
Name of the LoA signatory authorizing the release.
Operating Company Number (OCN) of the winning carrier.
Required only when port-out PIN protection is enabled on the number (4-32 characters).
⌘I