Getting started
Your first API request
Authenticate on your server and read your SIP identities.
Prepare your account
Open Settings → Developer tools in your account. The account owner can reveal or generate an API key after the required verification. Keep the key in your server environment as ILLYVOIP_API_KEY.
Make a read-only request
This request lists SIP identities. It does not place a call. Select the language you use on your backend.
cURL
curl -X GET "https://api.illyvoip.com/api/v1/sip/identities" \
-H "X-Api-Key: ${ILLYVOIP_API_KEY:?Set ILLYVOIP_API_KEY}"Node.js
const response = await fetch("https://api.illyvoip.com/api/v1/sip/identities", {
method: "GET",
headers: {
"X-Api-Key": process.env.ILLYVOIP_API_KEY
}
});
const data = await response.json();
console.log(response.status, data);PHP
<?php
$ch = curl_init('https://api.illyvoip.com/api/v1/sip/identities');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-Api-Key: ' . getenv('ILLYVOIP_API_KEY')
],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status . PHP_EOL;
echo $response;Python
import os
import json
import requests
response = requests.request(
"GET",
"https://api.illyvoip.com/api/v1/sip/identities",
headers={
"X-Api-Key": os.environ["ILLYVOIP_API_KEY"]
},
)
print(response.status_code)
print(response.json())Read the result
A successful JSON response contains status: success and identities. An empty list is valid. Use available_actions to determine which public SIP actions can be offered for an identity. The API still checks ownership and eligibility when an action runs.
For a 401 response, check the key and header. For a 403 response, check account access before retrying. See the full identity reference for response fields and errors.