Skip to main content
POST
Change how a gateway is dialed

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
port
integer
Required range: 1 <= x <= 65535
transport
enum<string>
Available options:
udp,
tcp,
tls
dialRules
object[]
Maximum array length: 10
Example:
callerIdRules
object[]

Rewrites the caller ID the gateway is sent, by the same rules as dialRules. Omitted keeps the current rules; an empty list clears them. Direct gateways only: a registered gateway presents its registered identity, and two of the gateway's numbers may not end up presented identically (400). The outbound trunk holds the rewritten numbers, so a change updates it on the cell.

Maximum array length: 10
Example:
connection
enum<string>

SIP gateway only; omitted keeps the current mode.

Available options:
direct,
register,
registrar
preset
string

register only; omitted keeps the current preset.

authId
string

register only, with the one-identity form.

outboundProxy
string

register only.

register
object

register only: overrides to the preset's values.

identities
object[]

register only. A password is required for a new identity and optional for one that exists; omitted, the current identities are kept.

Maximum array length: 20
inboundNumber
string

register only: must be one of the gateway's numbers once it has any. Omitted keeps the current one; an empty string clears it.

inboundRules
object[]

register only. Omitted keeps the current rules; an empty list clears them.

Maximum array length: 10
Example:

Response

Updated.

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
gateway
object

How a manually connected gateway is dialed; port and transport are null where unset. The register fields are empty on a direct gateway.

configPublished
boolean

Present after a change to a registered gateway; whether the cell's relay snapshot reached the config bucket.

connectedAt
integer<int64>