Test carrier account
curl --request POST \
--url https://api.goyappr.com/carrier-accounts/{id}/test \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.goyappr.com/carrier-accounts/{id}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.goyappr.com/carrier-accounts/{id}/test', 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/carrier-accounts/{id}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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/carrier-accounts/{id}/test"
req, _ := http.NewRequest("POST", 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.post("https://api.goyappr.com/carrier-accounts/{id}/test")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/carrier-accounts/{id}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ok": true,
"checks": [
{
"name": "api_key",
"ok": true,
"detail": "<string>"
}
],
"telnyx": {
"connections": [
{
"id": "<string>",
"name": "<string>",
"active": true,
"outbound_voice_profile_id": "<string>"
}
],
"outbound_voice_profiles": [
{
"id": "<string>",
"name": "<string>",
"enabled": true,
"allowed_destinations": [
"<string>"
],
"daily_spend_limit": "<string>",
"daily_spend_limit_enabled": true,
"channel_limit": 123
}
]
},
"numbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"verified": true
}
]
}{
"error": "Calling out through your own Telnyx account is switched off for this workspace. Contact Yappr support.",
"code": "CARRIER_ACCOUNTS_NOT_ENABLED",
"enabled": false
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Carrier accounts
Test Carrier Account
Checks the key, the app and its outbound voice profile with Telnyx, and
re-checks that every number is still in your account. Places no call.
A number Telnyx no longer lists stops being callable until a later test finds
it again. If Telnyx refuses the API key, the account pauses right away
(pause_reason: key_rejected) and its numbers stop calling, as a refused call
would pause it; reactivate it once the key works. Requires
carrier_accounts:manage. Limit: 60 per workspace per day.
POST
/
carrier-accounts
/
{id}
/
test
Test carrier account
curl --request POST \
--url https://api.goyappr.com/carrier-accounts/{id}/test \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.goyappr.com/carrier-accounts/{id}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.goyappr.com/carrier-accounts/{id}/test', 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/carrier-accounts/{id}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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/carrier-accounts/{id}/test"
req, _ := http.NewRequest("POST", 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.post("https://api.goyappr.com/carrier-accounts/{id}/test")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/carrier-accounts/{id}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ok": true,
"checks": [
{
"name": "api_key",
"ok": true,
"detail": "<string>"
}
],
"telnyx": {
"connections": [
{
"id": "<string>",
"name": "<string>",
"active": true,
"outbound_voice_profile_id": "<string>"
}
],
"outbound_voice_profiles": [
{
"id": "<string>",
"name": "<string>",
"enabled": true,
"allowed_destinations": [
"<string>"
],
"daily_spend_limit": "<string>",
"daily_spend_limit_enabled": true,
"channel_limit": 123
}
]
},
"numbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"verified": true
}
]
}{
"error": "Calling out through your own Telnyx account is switched off for this workspace. Contact Yappr support.",
"code": "CARRIER_ACCOUNTS_NOT_ENABLED",
"enabled": false
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Checks the account with Telnyx and places no call. Requires
carrier_accounts:manage.
curl -X POST https://api.goyappr.com/carrier-accounts/7c1e…/test \
-H "Authorization: Bearer ypr_live_..."
{
"ok": true,
"checks": [
{ "name": "api_key", "ok": true, "detail": "Telnyx accepts the API key." },
{ "name": "connection", "ok": true, "detail": "The Call Control App is active and points at Yappr." },
{ "name": "outbound_voice_profile", "ok": true, "detail": "Calls may go to: IL." },
{ "name": "numbers", "ok": true, "detail": "2 number(s) are in this Telnyx account." }
],
"telnyx": { "connections": ["…"], "outbound_voice_profiles": ["…"] },
"numbers": [{ "id": "e2a4…", "number": "+972501234567", "verified": true }]
}
ok covers the key, the app and its outbound voice profile. The test also asks
Telnyx again whether each number is still in your account: a number it no longer
lists gets ownership_verified_at: null and cannot make calls until a later test
finds it again. Limit: 60 per workspace per day.
If Telnyx refuses the API key, the account pauses right away (status: "paused",
pause_reason: "key_rejected") and its numbers stop calling, exactly as a refused
call would pause it, so no lead spends an attempt on a key that no longer works.
Fix the key in Telnyx (or rotate it), then
turn the account back on.Authorizations
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Path Parameters
Response
Test result