IP Address Endpoints

Table of Contents

Overview

IP Endpoints are used to do ip based authentication with sip servers. Here you can create, list and remove ip address endpoints.

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

Functions

/create

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

Arguments:

Info: Creates an ip address endpoint for use in call flows

Example Success
{
    "code": 200,
    "status": "success",
    "data": "Successfully created ip endpoint"
}
Example Error
{
    "code": 400,
    "status": "error",
    "data": "Invalid IP address"
}

/list

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

Arguments:

Info: Get a list of all of your current ip endpoints

Example Success
{
    "code": 200,
    "status": "success",
    "data": [
        {
            "id": 42,
            "ip_address": "123.123.123.123"
        },
        {
            "id": 55,
            "ip_address": "111.111.111.111"
        }
    ]
}
Example Error
{
    "code": 200,
    "status": "success",
    "data": []
}

/remove

Full Url: https://apiv1.teleapi.net/ipendpoints/remove

Arguments:

Info: Remove an ip address endpoint by id

Example Success
{
    "code": 200,
    "status": "success",
    "data": "Successfully remove ip address endpoint"
}
Example Error
{
    "code": 400,
    "status": "error",
    "data": "Invalid endpoint id"
}