Skip to main content
POST
/
api
/
telephony_configs
/
telnyx
cURL
curl --request POST \
  --url https://api.ultravox.ai/api/telephony_configs/telnyx \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "accountSid": "<string>",
  "apiKey": "<string>",
  "publicKey": "<string>",
  "applicationSid": "<string>",
  "callCreationAllowedAgentIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "callCreationAllowAllAgents": false,
  "requestContextMapping": {}
}
'
{
  "accountSid": "<string>",
  "apiKeyPrefix": {
    "prefix": "<string>"
  },
  "publicKeyPrefix": {
    "prefix": "<string>"
  },
  "applicationSid": "<string>",
  "callCreationAllowedAgentIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "callCreationAllowAllAgents": false,
  "requestContextMapping": {}
}

Authorizations

​
X-API-Key
string
header
required

API key

Body

application/json
​
accountSid
string
required

Your Telnyx Account SID. See https://portal.telnyx.com/#/account/general

​
apiKey
string
required

Your Telnyx API Key. See https://portal.telnyx.com/#/api-keys

​
publicKey
string
required

Your Telnyx Public Key. See https://portal.telnyx.com/#/api-keys/public-key

​
applicationSid
string
required

Your Telnyx Application SID. This must be configured with an Outbound Voice Profile that allows calls to your destination. See https://portal.telnyx.com/#/call-control/texml

Maximum string length: 40
​
callCreationAllowedAgentIds
string<uuid>[]

List of agents for whom calls may be directly created by this telephony provider to facilitate incoming calls. May not be set if callCreationAllowAllAgents is true.

Maximum array length: 100
​
callCreationAllowAllAgents
boolean
default:false

If true, calls may be directly created by this telephony provider for all agents. If false, only agents listed in callCreationAllowedAgentIds are allowed.

​
requestContextMapping
object

Maps (dot separated) request fields to (dot separated) context fields for incoming call creation.

Response

201 - application/json
​
accountSid
string
required

Your Telnyx Account SID. See https://portal.telnyx.com/#/account/general

​
apiKeyPrefix
object
required

The prefix of your Telnyx API Key.

​
publicKeyPrefix
object
required

The prefix of your Telnyx Public Key.

​
applicationSid
string
required

Your Telnyx Application SID. This must be configured with an Outbound Voice Profile that allows calls to your destination. See https://portal.telnyx.com/#/call-control/texml

Maximum string length: 40
​
callCreationAllowedAgentIds
string<uuid>[]

List of agents for whom calls may be directly created by this telephony provider to facilitate incoming calls. May not be set if callCreationAllowAllAgents is true.

Maximum array length: 100
​
callCreationAllowAllAgents
boolean
default:false

If true, calls may be directly created by this telephony provider for all agents. If false, only agents listed in callCreationAllowedAgentIds are allowed.

​
requestContextMapping
object

Maps (dot separated) request fields to (dot separated) context fields for incoming call creation.