Signals Docs
SIP Trunking
SIP Trunking

Schemas

CatalogCurrency

string · enum
Enum values:
NGN

ChangeOutboundPolicyDestinationRulesRequest

​DestinationRuleChangeInput[] · required

CreateSubtrunkRequest

name
​string · required
status
​SubtrunkStatusInput · enum · required
Enum values:
enabled
disabled
​

CreateTrunkDigestCredentialRequest

realm
​string · required

CreateTrunkRequest

auth_mode
​TrunkAuthMode · enum · required
Enum values:
ip_allow_list
digest
codecs
​TrunkCodec[] · required
Enum values:
PCMA
PCMU
G729
G722
OPUS
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
media_security
​TrunkMediaSecurity · enum · required
Enum values:
rtp
sdes_srtp_required
name
​string · required
require_tls
​boolean · required
source_validation
​TrunkSourceValidation · enum · required
Enum values:
relaxed
strict
sources
​string[] · required
​TrunkTargetInput[] · required
​
number_block_ids
​string[]

Number blocks of the project, each routed whole to the trunk as part of the create.

outbound_policy_id
​string | null

A live outbound policy of the project to attach as part of the create.

subaccount_id
​string | null

DestinationContinent

string · enum
Enum values:
africa
americas
asia
europe
oceania

DestinationCountries

​DestinationCountry[] · required

DestinationCountry

calling_code
​string · required
continent
​DestinationContinent · enum · required
Enum values:
africa
americas
asia
europe
oceania
iso_code
​string · required
shared_code
​boolean · required

The calling code also reaches another country, so a country rule cannot use it.

DestinationRuleChangeInput

kind
​PolicyDestinationKind · enum · required
Enum values:
country
prefix
op
​DestinationRuleOpInput · enum · required
Enum values:
allow
deny
remove
value
​string · required
label
​string | null

DestinationRuleOpInput

string · enum
Enum values:
allow
deny
remove

NumberBlockConsumer

count
​integer · int32 · min: 0 · required
id
​string · required
name
​string · required
type
​string · required

OutboundPolicyDetail

applied_services
​integer · int64 · min: 0 · required
attached_services
​integer · int64 · min: 0 · required
​PolicyAttachmentRef[] · required
​PolicyCeilings · required
currency
​string · required
​PolicyDestinationSummary · required
id
​string · required
name
​string · required
​PolicyRecording · required
revision
​integer · int64 · required

The save revision the ETag quotes; send it back as If-Match.

status
​OutboundPolicyStatus · enum · required
Enum values:
active
archived
system_default
​boolean · required
as_of
​string · date-time · required
billing_group
​string · required
created_at
​string · date-time · required
created_by
​string | null · required
​PolicyDestinations · required

OutboundPolicyList

​OutboundPolicySummary[] · required

OutboundPolicyRequest

name
​string · required
recording_channels
​RecordingPolicyChannelsInput · enum · int32 · required
Enum values:
2
recording_mode
​RecordingPolicyMode · enum · required
Enum values:
off
all
recording_retention_days
​RecordingRetentionDays · enum · int32 · required
Enum values:
30
90
365
concurrency
​integer | null · int32 · min: 0
cps
​integer | null · int32 · min: 0
daily_spend_limit_minor
​integer | null · int64
max_call_duration_seconds
​integer | null · int32 · min: 0
max_destination_rate_minor
​integer | null · int64

OutboundPolicyStatus

string · enum
Enum values:
active
archived

OutboundPolicySummary

applied_services
​integer · int64 · min: 0 · required
attached_services
​integer · int64 · min: 0 · required
​PolicyAttachmentRef[] · required
​PolicyCeilings · required
currency
​string · required
​PolicyDestinationSummary · required
id
​string · required
name
​string · required
​PolicyRecording · required
revision
​integer · int64 · required

The save revision the ETag quotes; send it back as If-Match.

status
​OutboundPolicyStatus · enum · required
Enum values:
active
archived
system_default
​boolean · required

PolicyAllowedDestination

increment_additional_seconds
​integer · int64 · min: 0 · required
increment_initial_seconds
​integer · int64 · min: 0 · required
kind
​PolicyDestinationKind · enum · required
Enum values:
country
prefix
label
​string · required
match
​string · required
rate_minor
​integer | null · int64 · required
rate_unit
​PolicyDestinationRateUnit · enum · required
Enum values:
minute
second

PolicyAttachment

applied_at
​string | null · date-time · required
apply_state
​PolicyAttachmentApplyState · enum · required
Enum values:
applied
pending
attached_at
​string · date-time · required
calls_in_flight
​integer · int64 · min: 0 · required
id
​string · required
note
​string | null · required
outbound_enabled
​boolean · required
​required
parent_name
​string | null · required
service_id
​string · required
service_name
​string · required
service_type
​PolicyServiceType · enum · required
Enum values:
trunk
subtrunk
voice_application
automation

PolicyAttachmentApplyState

string · enum
Enum values:
applied
pending

PolicyAttachmentLimits

concurrency
​integer | null · int64 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required

PolicyAttachmentList

​PolicyAttachment[] · required

PolicyAttachmentRef

note
​string | null · required
service_name
​string · required
service_type
​PolicyServiceType · enum · required
Enum values:
trunk
subtrunk
voice_application
automation

PolicyCeiling

configured
​integer | null · int64 · min: 0 · required
unit
​string · required

PolicyCeilings

​PolicyCeiling · required
​PolicyCeiling · required
​PolicyDailySpend · required
​PolicyCeiling · required
​PolicyMoneyCeiling · required

PolicyDailySpend

configured_minor
​integer | null · int64 · required
currency
​string · required
resets_at
​string · date-time · required
used_today_minor
​integer · int64 · required

PolicyDeniedDestination

case_ref
​string | null · required
label
​string · required
match
​string · required
source
​PolicyDeniedDestinationSource · enum · required
Enum values:
customer
containment

PolicyDeniedDestinationSource

string · enum
Enum values:
customer
containment

PolicyDestinationKind

string · enum
Enum values:
country
prefix

PolicyDestinationRateUnit

string · enum
Enum values:
minute
second

PolicyDestinationSummary

allowed_countries
​string[] · required
allowed_prefixes
​integer · int64 · min: 0 · required
denied_prefixes
​integer · int64 · min: 0 · required

PolicyDestinations

​PolicyAllowedDestination[] · required
​PolicyDeniedDestination[] · required

PolicyMoneyCeiling

configured_minor
​integer | null · int64 · required
currency
​string · required

PolicyRecording

applied
​boolean · required
channels
​integer · int64 · min: 0 · required
​PolicyRecordingConsent · required
mode
​RecordingPolicyMode · enum · required
Enum values:
off
all
retention_days
​RecordingRetentionDays · enum · int32 · required
Enum values:
30
90
365

PolicyRecordingConsent

accepted
​boolean · required
accepted_at
​string | null · date-time · required
accepted_by
​string | null · required
terms_version
​string · required

PolicyServiceType

string · enum
Enum values:
trunk
subtrunk
voice_application
automation

Problem

The problem document every error response carries.
code
​string · required
detail
​string · required
request_id
​string · required
status
​integer · int32 · min: 0 · required
title
​string · required
type
​string · required
​ProjectRef[]
caused_by
​string
changed_resources
​string[]
expensive_filter
​string
reason
​string
remediation
​string

ProjectRef

id
​string · required
name
​string · required

RecordingPolicyChannelsInput

integer · enum · int32
Enum values:
2

RecordingPolicyMode

string · enum
Enum values:
off
all

RecordingRetentionDays

integer · enum · int32
Enum values:
30
90
365

ReleaseSubtrunkRequest

confirm_name
​string · required

ReleaseTrunkRequest

confirm_name
​string · required

SetTrunkOutboundPolicyRequest

`policy_id` is required and may be null, so a body that forgets it never removes a policy.
policy_id
​string | null · required

StartTrunkTestRequest

destination
​string | null
​

SubtrunkConfiguration

concurrency
​integer | null · int32 · min: 0 · required
cps
​integer | null · int32 · min: 0 · required
daily_spend_cap_minor
​integer | null · int64 · required
max_call_duration_seconds
​integer | null · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
velocity_cap_minor
​integer | null · int64 · required

SubtrunkConfigurationInput

Every ceiling, always sent together: null is no ceiling, so a key left out would clear one.
concurrency
​integer | null · int32 · min: 0 · required
cps
​integer | null · int32 · min: 0 · required
daily_spend_cap_minor
​integer | null · int64 · required
max_call_duration_seconds
​integer | null · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
velocity_cap_minor
​integer | null · int64 · required

SubtrunkCountLimitPair

child
​integer · int32 · min: 0 · required
parent
​integer · int32 · min: 0 · required

SubtrunkDelegation

assigned_at
​string · date-time · required
assigned_by
​string · required
block_id
​string · required
end
​string · required
id
​string · required
size
​integer · int32 · min: 0 · required
start
​string · required
status
​SubtrunkDelegationStatus · enum · required
Enum values:
pending
applying
applied
failed
detaching

SubtrunkDelegationStatus

string · enum
Enum values:
pending
applying
applied
failed
detaching

SubtrunkDestinationLimitPair

child
​string[] · required
parent
​string[] · required

SubtrunkDetail

​SubtrunkDelegation[] · required
id
​string · required
​SubtrunkInheritance · required
​SubtrunkConfiguration · required
name
​string · required
organization_id
​string · required
revision
​integer · int64 · required

The save revision the ETag quotes; send it back as If-Match.

status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
trunk_id
​string · required
​SubtrunkUsage · required

SubtrunkInheritance

organization_allowed_destinations
​string[] · required
​required

SubtrunkLimits

​SubtrunkCountLimitPair · required
delegated
​integer · int32 · min: 0 · required
​SubtrunkDestinationLimitPair · required
​SubtrunkMoneyLimitPair · required

SubtrunkList

​SubtrunkSummary[] · required

SubtrunkMoneyLimitPair

child_minor
​integer | null · int64 · required
parent_minor
​integer | null · int64 · required

SubtrunkPolicyCeilings

acknowledged_at
​string · date-time · required
currency
​CatalogCurrency · enum · required
Enum values:
NGN
daily_spend_cap_minor
​integer | null · int64 · required
id
​string · required
max_call_duration_seconds
​integer | null · int32 · min: 0 · required
max_concurrent
​integer | null · int32 · min: 0 · required
max_cps
​integer | null · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
revision
​integer · int64 · required
runtime_revision
​integer · int64 · required

SubtrunkRefusal

count
​integer · int32 · min: 0 · required
reason
​string · required

SubtrunkStatusInput

string · enum
Enum values:
enabled
disabled

SubtrunkSummary

currency
​CatalogCurrency · enum · required
Enum values:
NGN
id
​string · required
​SubtrunkLimits · required
name
​string · required
parent_trunk_id
​string · required
parent_trunk_name
​string · required
status
​SubtrunkSummaryStatus · enum · required
Enum values:
enabled
disabled
releasing

SubtrunkSummaryStatus

string · enum
Enum values:
enabled
disabled
releasing

SubtrunkUsage

answered_calls
​integer · int32 · min: 0 · required
as_of
​string · date-time · required
call_attempts
​integer · int32 · min: 0 · required
currency
​CatalogCurrency · enum · required
Enum values:
NGN
pending_spend_minor
​integer · int64 · required
​SubtrunkRefusal[] · required
refused_calls
​integer · int32 · min: 0 · required
settled_spend_minor
​integer · int64 · required
window_from
​string · date-time · required

TrunkAuthMode

string · enum
Enum values:
ip_allow_list
digest

TrunkAuthentication

​required
mode
​TrunkAuthMode · enum · required
Enum values:
ip_allow_list
digest
require_tls
​boolean · required
source_validation
​TrunkSourceValidation · enum · required
Enum values:
relaxed
strict
​TrunkSource[] · required

TrunkCeiling

configured
​integer · int32 · min: 0 · required
unit
​string · required

TrunkCodec

string · enum
Enum values:
PCMA
PCMU
G729
G722
OPUS

TrunkCreation

The created trunk. `digest_password` is the generated password of a digest trunk's first credential: sent by this response alone, null for an IP trunk and on a replay.
digest_password
​string | null · required
​TrunkDetail · required

TrunkDelegatedNumbers

count
​integer · int32 · min: 0 · required
to
​string | null · required

TrunkDetail

concurrency_limit
​integer · int32 · min: 0 · required
concurrency_used
​integer · int32 · min: 0 · required
cps
​string | null · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
​TrunkEndpointSummary · required
id
​string · required
max_call_duration_seconds
​integer · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
numbers
​integer · int32 · min: 0 · required
parent_name
​string | null · required
project_id
​string · required
revision
​integer · int64 · required

The current revision, quoted as the ETag; a write sends it back in If-Match.

signaling_fqdn
​string | null · required
status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
subaccount_id
​string | null · required
subaccount_name
​string | null · required
as_of
​string · date-time · required
​TrunkAuthentication · required
​TrunkEndpointEvidence[] · required
​TrunkLimits · required
​TrunkMedia · required
​TrunkNumbers · required
​required
​TrunkRoute[] · required

TrunkDiagnostics

​TrunkMediaDiagnostics · required

TrunkDigestCredential

created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
new_applied_at
​string | null · date-time · required
previous_retires_at
​string | null · date-time · required
realm
​string · required
revoked_at
​string | null · date-time · required
rotated_from_id
​string | null · required
username
​string · required
valid_until
​string | null · date-time · required

TrunkDigestCredentialList

​TrunkDigestCredential[] · required

TrunkDigestCredentialSecret

created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
new_applied_at
​string | null · date-time · required
previous_retires_at
​string | null · date-time · required
realm
​string · required
revoked_at
​string | null · date-time · required
rotated_from_id
​string | null · required
username
​string · required
valid_until
​string | null · date-time · required
password
​string | null · required
secret_unavailable
​boolean · required

TrunkDigestIdentity

enabled
​boolean · required
realm
​string · required
username
​string · required

TrunkDraftLimitsInput

concurrency
​integer · int32 · min: 0 · required
cps
​integer · int32 · min: 0 · required
max_call_duration_seconds
​integer · int32 · min: 0 · required

TrunkEndpointEvidence

detail
​string · required
last_attempt_at
​string | null · date-time · required
​required
priority
​integer · int32 · required
sip_uri
​string · required
state
​TrunkEndpointEvidenceState · enum · required
Enum values:
unknown
idle
healthy
degraded

TrunkEndpointEvidenceState

string · enum
Enum values:
unknown
idle
healthy
degraded

TrunkEndpointFailure

at
​string · date-time · required
code
​string · required

TrunkEndpointSummary

count
​integer · int32 · min: 0 · required
state
​TrunkEndpointSummaryState · enum · required
Enum values:
none
idle

TrunkEndpointSummaryState

string · enum
Enum values:
none
idle

TrunkIpCredential

cidr
​string · required
created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
selector_precedence
​integer · int32 · min: 0 · required

TrunkIpCredentialList

​TrunkIpCredential[] · required

TrunkIpCredentialRequest

cidr
​string · required
enabled
​boolean
selector_precedence
​integer · int32 · min: 0

TrunkLifecycleStatus

string · enum
Enum values:
draft
enabled
disabled
releasing
released

TrunkLimits

​TrunkCeiling · required
​TrunkCeiling · required
​TrunkCeiling · required

TrunkList

​TrunkSummary[] · required

TrunkMedia

codecs
​TrunkCodec[] · required
Enum values:
PCMA
PCMU
G729
G722
OPUS
security
​TrunkMediaSecurity · enum · required
Enum values:
rtp
sdes_srtp_required

TrunkMediaDiagnostics

as_of
​string · date-time · required
jitter_ms
​number | null · double · required
mos
​number | null · double · required
no_media_calls
​integer · int64 · min: 0 · required
one_way_calls
​integer · int64 · min: 0 · required
packet_loss_pct
​string | null · required
transcoded_calls
​integer · int64 · min: 0 · required
unavailable_reason
​string | null · required
window_hours
​integer · int32 · min: 0 · required

TrunkMediaSecurity

string · enum
Enum values:
rtp
sdes_srtp_required

TrunkMetrics

acd_reason
​string | null · required
acd_seconds
​integer | null · int64 · required
answered
​integer · int64 · min: 0 · required
as_of
​string · date-time · required
asr_7d_pct
​string | null · required
attempts
​integer · int64 · min: 0 · required
failed
​integer · int64 · min: 0 · required
pdd_ms
​integer | null · int64 · required
pdd_reason
​string | null · required
​required
window_hours
​integer · int32 · min: 0 · required

TrunkNumbers

​TrunkDelegatedNumbers · required
​TrunkQuarantinedNumbers · required
range
​string | null · required
routed
​integer · int32 · min: 0 · required

TrunkPolicy

id
​string · required
name
​string · required

TrunkQuarantinedNumbers

count
​integer · int32 · min: 0 · required
until
​string | null · date-time · required

TrunkRoute

enabled
​boolean · required
id
​string · required
priority
​integer · int32 · required
sip_uri
​string · required
transport
​TrunkTransport · enum · required
Enum values:
udp
tcp
tls
weight
​integer · int32 · required

TrunkSource

cidr
​string · required
enabled
​boolean · required
id
​string · required

TrunkSourceValidation

string · enum
Enum values:
relaxed
strict

TrunkSummary

concurrency_limit
​integer · int32 · min: 0 · required
concurrency_used
​integer · int32 · min: 0 · required
cps
​string | null · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
​TrunkEndpointSummary · required
id
​string · required
max_call_duration_seconds
​integer · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
numbers
​integer · int32 · min: 0 · required
parent_name
​string | null · required
project_id
​string · required
revision
​integer · int64 · required

The current revision, quoted as the ETag; a write sends it back in If-Match.

signaling_fqdn
​string | null · required
status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
subaccount_id
​string | null · required
subaccount_name
​string | null · required

TrunkTargetInput

priority
​integer · int32 · required
sip_uri
​string · required
transport
​TrunkTransport · enum · required
Enum values:
udp
tcp
tls
weight
​integer · int32 · required

TrunkTerminationUri

created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
priority
​integer · int32 · required
sip_uri
​string · required
transport
​TrunkTransport · enum · required
Enum values:
udp
tcp
tls
updated_at
​string · date-time · required
weight
​integer · int32 · required

TrunkTerminationUriList

​TrunkTerminationUri[] · required

TrunkTerminationUriRequest

sip_uri
​string · required
transport
​TrunkTransport · enum · required
Enum values:
udp
tcp
tls
enabled
​boolean
priority
​integer · int32
weight
​integer · int32

TrunkTestCheck

duration_ms
​integer | null · int64 · min: 0 · required
id
​string · required
node_id
​string | null · required
occurred_at
​string | null · date-time · required
sequence
​integer · int64 · min: 0 · required
state
​TrunkTestCheckState · enum · required
Enum values:
waiting
passed
failed
skipped
summary
​string | null · required
target_ref
​string | null · required

TrunkTestCheckState

string · enum
Enum values:
waiting
passed
failed
skipped

TrunkTestDetail

destination
​string | null · required
next_sequence
​integer · int64 · min: 0 · required
requested_kind
​TrunkTestKind · enum · required
Enum values:
config_validation
rtp_reachability
test_call
requested_revision
​integer · int64 · required
​TrunkTestRun · required

TrunkTestHistory

as_of
​string · date-time · required
​TrunkTestRun[] · required
retention_days
​integer · int32 · min: 0 · required
scheduled_check
​boolean · required

TrunkTestKind

string · enum
Enum values:
config_validation
rtp_reachability
test_call

TrunkTestRun

call_id
​string | null · required
call_summary
​string | null · required
​TrunkTestCheck[] · required
configuration_revision
​integer | null · int64 · required
finding
​string | null · required
finished_at
​string | null · date-time · required
id
​string · required
result
​TrunkTestRunResult · enum · required
Enum values:
running
passed
failed
run_by
​string · required
scheduled
​boolean · required
started_at
​string · date-time · required

TrunkTestRunResult

string · enum
Enum values:
running
passed
failed

TrunkTopFailure

calls
​integer · int64 · min: 0 · required
platform_reason
​string · required
share_pct
​string · required
sip_code
​integer | null · int32 · required

TrunkTrafficDirection

string · enum
Enum values:
inbound
outbound
both

TrunkTransport

string · enum
Enum values:
udp
tcp
tls

UpdateSubtrunkRequest

​
name
​string | null
​

UpdateTrunkRequest

The editable trunk fields. The project binding is fixed at creation, and sources and targets belong to their item routes, so a body naming any of them is rejected rather than ignored.
auth_mode
​TrunkAuthMode · enum · required
Enum values:
ip_allow_list
digest
codecs
​TrunkCodec[] · required
Enum values:
PCMA
PCMU
G729
G722
OPUS
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
media_security
​TrunkMediaSecurity · enum · required
Enum values:
rtp
sdes_srtp_required
name
​string · required
require_tls
​boolean · required
source_validation
​TrunkSourceValidation · enum · required
Enum values:
relaxed
strict
​
subaccount_id
​string | null