List SIP Endpoint

To list all the SIP endpoint, send your POST method request with valid parameters to the following base URL.

Base URL

https://piopiy.telecmi.com/v1/endpoint/list_sip

Required Parameters

These are the required POST method parameters with description.

Parameter Name	Type	Description
*appid	number	Your app id
*secret	string	Your app secret
*page	number	The Number of page per 10 record

Note

The * marked property is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request to list all the SIP endpoint.

{
"appid": 2222223,
"secret": "635a5e93-3e5f-4aa5-b7ab-2a04cd5es039",
"page": 1
}

Sample JSON Response

If the provided information is valid, your web server will get a sample response from PIOPIY Platform as given below

{
    "code": "cmi-200",
    "list": {
        "count": 4,
        "rows": [
            {
                "username": "YOUR_USERNAME",
                "password": "YOUR_PASSWORD"
            },
            {
                "username": "YOUR_USERNAME_1",
                "password": "YOUR_PASSWORD"
            },
            {
                "username": "YOUR_USERNAME_2",
                "password": "YOUR_PASSWORD"
            },
            {
                "username": "YOUR_USERNAME_3",
                "password": "YOUR_PASSWORD"
            }
        ]
    }
}

Properties

These are the list of properties and its description

Property	Type	Description
count	number	Total number of SIP endpoints
username	string	Your endpoint username
password	string	Your endpoint password

HTTP status codes

PIOPIY API platform represents the following status code to identity the errors.

Status code	Status code	Description
200	OK	We received the request
420	Error	Invalid app id or secret, failed to authenticate token
502	Error	Missing required property