Skip to main content
POST
Test carrier account
Checks the account with Telnyx and places no call. Requires carrier_accounts:manage.
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

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Path Parameters

id
string<uuid>
required

Response

Test result

ok
boolean

True when the key, the app and the outbound voice profile all pass. Numbers are reported, not required.

checks
object[]
telnyx
object | null

What your key can see. null when Telnyx refused the key.

numbers
object[]