Skip to main content
POST
voice.sip-trunk.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by voice.sip-trunk.create or a row of voice.sip-trunks.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

label
string
required

Your trunk label.

Maximum string length: 80
sipHost
string
required

Public fully qualified hostname; no IP address, credentials or port.

Maximum string length: 253
sipPort
integer
required

Signaling port.

Required range: 1 <= x <= 65535
transport
enum<string>
required

Signaling transport.

Available options:
tls,
tcp,
udp
numbersAttached
integer
required

Number of attached owned numbers.

Required range: 0 <= x <= 9007199254740991
credentialsStored
boolean
required

Credentials were saved privately; no credential is returned.

numbers
object[]
required

Attached owned telephone numbers.

createdAt
string<date-time>

Creation time.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$