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

Authorizations

​
X-API-Key
string
header
required

API key

Body

application/json
​
authId
string
required

Your Plivo Auth ID.

​
authToken
string
required

Your Plivo Auth Token.

​
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
​
authId
string
required

Your Plivo Auth ID.

​
authTokenPrefix
object
required

The prefix of your Plivo Auth Token.

​
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.