LNP Requests

Table of Contents

Overview

Want to port numbers? You're in the right place. You can check the status on your current port orders, see if a number is even portable or add new port orders. We like it when you bring us numbers.

Controller: /lnp Full Url: https://apiv1.teleapi.net/lnp/

Functions

/create

Full Url: https://apiv1.teleapi.net/lnp/create

Arguments:

Info: This is a big one, huh? Yeah.. Unfortunately LNP isn't exactly an easy process. But, we do what we can to help you along. Let's see, numbers should a comma separated list of numbers. btn is the billing telephone number on the order. Other than that, read the above arguments list, it specifies all of the gotcha's here. Probably want to POST this one.

Example Success
{
    "code": 200,
    "status": "success",
    "data": {
        "id": 53,
        "btn": 5555555555,
        "location_type": "business"
        "business_contact": "Bobby McFrobby",
        "business_name": "Bob's Teleco",
        "first_name": null,
        "last_name": null,
        "account_number": "123456",
        "service_address": "123 Some Street",
        "service_city": "Englewood",
        "service_state": "CO",
        "service_zip": "80112",
        "partial_port": 0,
        "partial_port_details": null,
        "wireless_number": 0,
        "wireless_pin": null,
        "caller_id": null,
        "foc_date": null,
        "numbers": [
            { "number": "5555555555" },
            { "number": "5555555544" }
        ]
    }
}
Example Error
{
    "code": 400,
    "status": "error",
    "data": "location_type must be business or residential"
}

/list

Full Url: https://apiv1.teleapi.net/lnp/list

Arguments:

Info: Get a list of all of your lnp requests. Note, no numbers on this one. To check numbers, use /get

Example Success
{
    "code": 200,
    "status": "success",
    "data": {
        "id": 53,
        "btn": 5555555555,
        "location_type": "business"
        "business_contact": "Bobby McFrobby",
        "business_name": "Bob's Teleco",
        "first_name": null,
        "last_name": null,
        "account_number": "123456",
        "service_address": "123 Some Street",
        "service_city": "Englewood",
        "service_state": "CO",
        "service_zip": "80112",
        "partial_port": 0,
        "partial_port_details": null,
        "wireless_number": 0,
        "wireless_pin": null,
        "caller_id": null,
        "foc_date": null
    }
}
Example Error
{
    "code": 400,
    "status": "error",
    "data": "Missing variable: token"
}

/get

Full Url: https://apiv1.teleapi.net/lnp/get

Arguments:

Info: Get all the details about a given port request, with a list of numbers

Example Success
{
    "code": 200,
    "status": "success",
    "data": {
        "id": 53,
        "btn": 5555555555,
        "location_type": "business"
        "business_contact": "Bobby McFrobby",
        "business_name": "Bob's Teleco",
        "first_name": null,
        "last_name": null,
        "account_number": "123456",
        "service_address": "123 Some Street",
        "service_city": "Englewood",
        "service_state": "CO",
        "service_zip": "80112",
        "partial_port": 0,
        "partial_port_details": null,
        "wireless_number": 0,
        "wireless_pin": null,
        "caller_id": null,
        "foc_date": null,
        "numbers": [
            { "number": "5555555555" },
            { "number": "5555555544" }
        ]
    }
}
Example Error
{
    "code": 400,
    "status": "error",
    "data": "Missing variable: request_id"
}

/check

Full Url: https://apiv1.teleapi.net/lnp/check

Arguments:

Info: Check to see if a given number or numbers is portable to our platform

Example Success
{
    "code": 200,
    "status": "success",
    "data": {
        "asdf": {
            "status": "error",
            "message": "Not a valid US/CAN number"
        },
        "5555555555": {
            "status": "error",
            "message": "Unsupported"
        },
        "5555555554": {
            "status": "success",
            "message": "portable"
        }
    }
}
Example Error
{
    "code": 400,
    "status": "error",
    "data": "Missing variable: numbers"
}