Skip to main content
POST
Add a number
Add a number you own in the connected Telnyx account. Yappr asks Telnyx, with your API key, whether it is an active number in your account, and adds it only if it is. It becomes a phone number of your workspace with provider: "external", and from then on it works everywhere a number you bought does for outbound: from on POST /calls, a campaign’s number, or the number an outbound agent calls from. Requires carrier_accounts:manage. Choose the Call Control App first.

Outbound only

Calls to the number keep going where they go today in Telnyx. The agent calls out from it but does not answer it. Setting inbound_agent_id on it answers 422 INBOUND_NOT_AVAILABLE_ON_EXTERNAL_NUMBER. To have an agent answer, route the number in Telnyx to a SIP endpoint. Leave the number’s own settings in Telnyx as they are.

A number someone else registered

Every number is in Yappr once. If another workspace registered your number but its Telnyx key no longer proves it, Yappr releases that claim and adds the number to you. If it is a number bought from Yappr, or its holder still proves it, the answer is 409 NUMBER_ALREADY_REGISTERED, which does not say where. The same 409 comes back when the lapsed claim is still in use there (a campaign calls from it, or past calls were made from it): that claim is switched off so it can never call, but it is not removed, so the other workspace’s history stays intact. Contact Yappr support to move the number.

Errors

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

Body

application/json
number
string
required

An active number in the Telnyx account you connected, in E.164 (+972 numbers are 12 or 13 characters). Yappr checks it with your key before adding it.

Example:

"+972501234567"

friendly_name
string | null
Maximum string length: 100
outbound_agent_id
string<uuid> | null

The agent that calls from this number by default.

Response

Number added

data
object