Skip to main content
POST
Connect a carrier account

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Body

application/json
carrier
enum<string>
required
Available options:
twilio,
vonage,
exotel,
vobiz,
sip-gateway,
pronto_connects
name
string
accountSid
string

Twilio.

apiKeySid
string

Twilio.

apiKeySecret
string<password>

Twilio.

authToken
string<password>

Twilio — alternative to the key pair.

apiKey
string

Vonage / Pronto.

apiSecret
string<password>

Vonage.

terminationUri
string

Manually provisioned carriers.

authUsername
string
authPassword
string<password>
allowedIps
string[]
accountId
string

Pronto.

campaignId
string

Pronto.

from
string

Pronto default sender (E.164).

Response

Connected.

id
string
carrier
string
name
string
accountRef
string

Twilio Account SID or carrier SIP host — safe to show.

accountName
string
status
enum<string>
Available options:
connected,
error
lastError
string
trunkId
string
carrierTrunkSid
string

The trunk id inside the carrier's account (API-provisioned carriers).

terminationUri
string
credentialFingerprint
string

Non-reversible; for display and audit only.

hasCredentials
boolean
secretsBackend
string
Example:

"secret-manager"

provisioning
enum<string>
Available options:
api,
manual
displayName
string
transferSupport
enum<string>
Available options:
supported,
verify,
unsupported
channel
enum<string>

An sms integration has no trunk and no numbers.

Available options:
voice,
sms
sipUri
string
connectedAt
integer<int64>