Number Porting Orders

GEThttps://api.voxo.co/port-in-orders/{orderId}

Get Port In Order By Id

Retrieve a single port order by id

Retrieving a media file by id will return a url to download the file.

Parameters

Path

Name
orderId*
Type
Integer
Description

Header

Name
Authorization*
Type
String
Description
Bearer {AccessToken}
Name
Content-Type*
Type
String
Description
application/json

Response

{
    "orderId": 1349286,
    "customerOrderReference": "demo-687",
    "orderStatus": "Closed",
    "desiredDueDate": "2020-07-13T00:00:00.000+00:00",
    "tnGroups": [
        {
        "telephoneNumber": "6012491040",
        "tnStatus": "Complete",
        "streetNum": "900",
        "streetPreDir": "",
        "streetName": "Cherry Street",
        "streetType": "",
        "locationType": "",
        "locationNumber": "",
        "city": "Summit",
        "state": "MS",
        "postalCode": "39666",
        "tnGroup": "Group ID 323147 - AT&T Wireline (BellSouth)/1",
        "name": "TT",
        "trunkGroup": "RCFRILRC123_1045",
        "accountNum": "123456",
        "atn": "6012491040",
        "accountPin": "9999",
        "authName": "Freddie",
        "authDate": "2020-07-09T05:00:00.000+00:00"
        }
    ]
}

cURL

curl --location -g \
--request GET 'https://api.voxo.co/port-in-orders/1234' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {accessToken}'

GEThttps://api.voxo.co/port-in-orders?orderRef={tenantId}

All Port In Orders

Retrieve all port orders for a specific account

Parameters

Query

Name
orderRef*
Type
Integer
Description
tenantId

Header

Name
Authorization*
Type
String
Description
Bearer {AccessToken}
Name
Content-Type*
Type
String
Description
application/json

Response

[
    {
        "orderId": 1349294,
        "orderStatus": "Closed",
        "customerOrderReference": "demo-687",
        "desiredDueDate": "2020-07-13T00:00:00.000+00:00",
        "tnQuantity": 1,
        "createdDate": "2020-07-10T00:00:00.000+00:00",
        "createdUser": "api_user",
        "focTnQuantity": 0,
        "rejectedTnQuantity": 0,
        "activatedTnQuantity": 1,
        "focList": {
            "focItem": [
                {
                    "tnQuantity": 1,
                    "focTnQuantity": 0,
                    "rejectedTnQuantity": 0,
                    "activatedTnQuantity": 1
                }
            ]
        }
    },
    {
        "orderId": 1349286,
        "orderStatus": "Closed",
        "customerOrderReference": "demo-687",
        "desiredDueDate": "2020-07-13T00:00:00.000+00:00",
        "tnQuantity": 1,
        "createdDate": "2020-07-10T00:00:00.000+00:00",
        "createdUser": "api_user",
        "focTnQuantity": 0,
        "rejectedTnQuantity": 0,
        "activatedTnQuantity": 1,
        "focList": {
            "focItem": [
                {
                    "tnQuantity": 1,
                    "focTnQuantity": 0,
                    "rejectedTnQuantity": 0,
                    "activatedTnQuantity": 1
                }
            ]
        }
    }
]

cURL

curl --location -g \
--request GET 'https://api.voxo.co/port-in-orders?orderRef=demo' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {accessToken}'