Check username-and-password trunks are available
curl --request GET \
--url https://api.goyappr.com/sip-endpoints/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.goyappr.com/sip-endpoints/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.goyappr.com/sip-endpoints/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.goyappr.com/sip-endpoints/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.goyappr.com/sip-endpoints/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.goyappr.com/sip-endpoints/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/sip-endpoints/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"credentials_available": true
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}SIP Endpoints
SIP Endpoints Status
Whether this workspace can create username-and-password trunks right now.
credentials_available is true when trunks are switched on for your
workspace and Yappr’s voice servers answer calls on them. While it is
false, creating one is refused
with 403 SIP_TRUNKS_NOT_ENABLED (not switched on for your workspace: ask
Yappr support) or 409 VOICE_NOT_READY (for example during an update: try
again in a few minutes), and the dashboard offers SIP address endpoints
only. Existing endpoints can still be listed, changed and deleted, and a
trunk can still get a new password with
rotate-password. Yappr
checks its voice servers at most once a minute, so the answer can be up to
a minute old. Requires sip_endpoints:read.
GET
/
sip-endpoints
/
status
Check username-and-password trunks are available
curl --request GET \
--url https://api.goyappr.com/sip-endpoints/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.goyappr.com/sip-endpoints/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.goyappr.com/sip-endpoints/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.goyappr.com/sip-endpoints/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.goyappr.com/sip-endpoints/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.goyappr.com/sip-endpoints/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/sip-endpoints/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"credentials_available": true
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Whether this workspace can create username-and-password trunks right now. Requires
sip_endpoints:read.
curl https://api.goyappr.com/sip-endpoints/status \
-H "Authorization: Bearer ypr_live_..."
{ "credentials_available": true }
true means both of these hold:
- username-and-password trunks are switched on for your workspace;
- Yappr’s voice servers answer calls on them.
false:
- Creating a trunk is refused and nothing is
created. The answer says why:
403 SIP_TRUNKS_NOT_ENABLEDwhen trunks aren’t switched on for your workspace (ask Yappr support to switch them on), or409 VOICE_NOT_READYwhile Yappr can’t take trunk calls, for example during an update (try again in a few minutes). - The dashboard offers SIP address endpoints only.
- SIP address endpoints can still be created.
- Existing endpoints can still be listed, changed and deleted, and a trunk can still get a new password with rotate-password.
Errors
| Status | code | Meaning |
|---|---|---|
| 400 | SIP_ENDPOINT_QUERY_INVALID | The request has a query parameter: this call takes none. |
| 401 | MISSING_KEY, INVALID_KEY, EXPIRED_KEY | The API key is missing, not recognised or expired. |
| 403 | INSUFFICIENT_SCOPE | The API key lacks sip_endpoints:read. |