Skip to main content
POST
Connect a Telnyx account
Connect your own Telnyx account so agents can call from the numbers you already own there. Yappr places those calls on your Telnyx account, with your API key, so Telnyx bills you for the phone minutes and its calling fees. Yappr still bills the agent minutes. Requires carrier_accounts:manage, which API keys do not have by default: create a key with it (the dashboard’s full access includes it). Carrier accounts are available in every workspace. GET /carrier-accounts/status answers { "enabled": true } unless Yappr has switched them off for yours. Set Telnyx up first: Level 2 verification, an outbound voice profile with your destination countries allowed, and an API key made just for Yappr. The setup guide walks through it.
Telnyx API keys cannot be limited to certain actions, so use a key made only for Yappr: switching it off in Telnyx stops Yappr’s calls from your account at once. Next: choose the Call Control App.

Errors

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
Required string length: 1 - 100
Example:

"Main Telnyx account"

api_key
string<password>
required
write-only

A Telnyx API key created just for Yappr (Account Settings → API Keys). Checked with Telnyx before anything is saved; stored encrypted; never returned.

public_key
string
write-only

Your account's public key (Keys & Credentials → Public Key), 44 characters of base64. Recommended.

Example:

"3MYsSvZbhKUP9VZ1pRgGNlDtJGbNkFMhTqwPjGEgUoY="

Response

Connected (status untested, no app yet)

data
object

Your own Telnyx account, connected so agents can call from the numbers you own there. Yappr places each call on your Call Control App, with your API key, so the call runs on your Telnyx account and Telnyx bills you for it. The API key is write-only: no response ever contains it.

webhook_url
string<uri>

The URL a Call Control App you made must use.

telnyx
object

The Call Control Apps and outbound voice profiles your key can see (same shape as the test result's telnyx).