Create SIP Endpoint

Creating SIP Endpoint allows you to make and receive, audio and video calls. Making audio and video calls can be made to APP to APP, APP to Browser and browser to browser calling.


  1. Sign up for a free PIOPIY demo account

  2. Create your endpoint and add capacity.

  3. Setup your webserver and map your POST method URL in answer URL.

Create SIP Endpoint

To create a SIP Endpoint, send your POST method request with valid parameters to the following base URL.

Base URL

Required Parameters

These are the required POST method parameters with description.

Parameter NameTypeDescription
*appidnumberYour app id
*secretstringYour app secret
*usernamestringThe name of the user
*passwordstringPassword for the user
The * marked property is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request to create SIP endpoint

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

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",
"audio": true,
"video": true,
"type": "SIP"


These are the list of properties and its description

usernamestringYour endpoint username
passwordstringYour endpoint password
connect_URLstringYour namespace SBC connection URL
audiostringAudio enabled in this call
videostringVideo enabled in this call
typestringType of call SIP or PSTN

HTTP status codes

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

Status codeStatus codeDescription
200OKWe received the request
400ErrorUsername already exists
420ErrorInvalid app id or secret, failed to authenticate token
502ErrorMissing required property