Get SIP Endpoint

To get a SIP endpoint details, send your POST method request with valid parameters to the following base URL.

Base URL

https://piopiy.telecmi.com/v1/endpoint/get_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
*username	string	The name of the existing user

Note

The * marked property is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request to get SIP endpoint details.

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

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",
    "username": "YOUR_USERNAME",
    "password": "YOUR_PASSWORD",
    "connect_URL": "YOUR_NAMESPACE_SBC_URL",
    "audio": true,
    "video": true,
    "type": "SIP"
}

Properties

These are the list of properties and its description

Property	Type	Description
username	string	Your endpoint username
password	string	Your endpoint password
connect_URL	string	Your namespace SBC connection URL
audio	string	Audio enabled in this call
video	string	Video enabled in this call
type	string	Type of call SIP or PSTN

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
400	Error	Username does not exists
420	Error	Invalid app id or secret, failed to authenticate token
502	Error	Missing required property

#Base URL

#Required Parameters

Note

#Sample JSON Request

#Sample JSON Response

#Properties