Signals Docs
Signals API

AcceptNumberOrderRequest

quote_hash
​string · required
quote_id
​string · required

AddByocIngressSourceRequest

A public IPv4 network of /24 or narrower to accept calls from, enabled.
cidr
​string · required

AddByocPeerRequest

A carrier SBC to add to the connection, enabled; the lowest priority is tried first.
host
​string · required
port
​integer · int32 · min: 0 · required
priority
​integer · int32 · required
transport
​ByocPeerTransport · enum · required
Enum values:
udp
tcp
tls
weight
​integer · int32 · required

AdjacentNumberInventory

end
​string · required
free
​integer · int32 · min: 0 · required
start
​string · required

Alert

acknowledged_at
​string | null · date-time · required
acknowledged_by
​string | null · required
channels
​AlertChannel[] · required
Enum values:
email
webhook
in_app
sms
containment_id
​string | null · uuid · required
dedupe_key
​string · required
​AlertEvidence[] · required
fired_at
​string · date-time · required
id
​string · required
kind
​AlertKind · enum · required
Enum values:
balance_low
spend_daily
spend_monthly
spend_velocity
first_seen_high_cost_destination
new_source_ip
endpoint_health
trunk_apply_failed
policy_id
​string | null · required
policy_revision
​integer | null · int64 · required
reason
​string · required
remediation
​string · required
resolved_at
​string | null · date-time · required
severity
​AlertSeverity · enum · required
Enum values:
critical
warning
info
source_state
​AlertSourceState · enum · required
Enum values:
measured
data_unavailable
state
​AlertState · enum · required
Enum values:
firing
acknowledged
resolved
​AlertSubject · required
​required
trunk_id
​string | null · required

AlertChannel

string · enum
Enum values:
email
webhook
in_app
sms

AlertEvidence

amount_minor
​integer | null · int64 · required
currency
​string | null · required
held
​boolean · required
label
​string · required
note
​string | null · required
text
​string | null · required

AlertFeed

​Containment[] · required
​Alert[] · required

AlertKind

string · enum
Enum values:
balance_low
spend_daily
spend_monthly
spend_velocity
first_seen_high_cost_destination
new_source_ip
endpoint_health
trunk_apply_failed

AlertPolicy

channels
​AlertChannel[] · required
Enum values:
email
webhook
in_app
sms
enabled
​boolean · required
id
​string · required
kind
​AlertKind · enum · required
Enum values:
balance_low
spend_daily
spend_monthly
spend_velocity
first_seen_high_cost_destination
new_source_ip
endpoint_health
trunk_apply_failed
platform_ceiling_minor
​integer | null · int64 · required
platform_ceiling_window_seconds
​integer | null · int32 · required
​AlertPolicyResolution · required
revision
​integer · int64 · required
​AlertPolicyScope · required
​AlertPolicyThreshold · required
updated_at
​string · date-time · required
updated_by
​string · required

AlertPolicyList

​AlertPolicy[] · required

AlertPolicyResolution

amount_minor
​integer | null · int64 · required
count
​integer | null · int64 · required
currency
​string | null · required
for_seconds
​integer | null · int64 · required
percent
​string | null · required
rule
​string · required

AlertPolicyResolutionInput

rule
​AlertPolicyResolutionRuleInput · enum · required
Enum values:
below_threshold
day_rollover
month_rollover
acknowledged_or_24h
consecutive_successes
later_revision
amount_minor
​integer | null · int64
count
​integer | null · int64
currency
​string | null
for_seconds
​integer | null · int64
percent
​string | null

AlertPolicyResolutionRuleInput

string · enum
Enum values:
below_threshold
day_rollover
month_rollover
acknowledged_or_24h
consecutive_successes
later_revision

AlertPolicyScope

id
​string | null · required
label
​string · required
type
​AlertSubjectType · enum · required
Enum values:
account
organization
trunk
subaccount
webhook_endpoint

AlertPolicyScopeInput

The scope a policy change names; `id` may be left out for a scope that has none.
label
​string · required
type
​AlertSubjectType · enum · required
Enum values:
account
organization
trunk
subaccount
webhook_endpoint
id
​string | null

AlertPolicyThreshold

amount_minor
​integer | null · int64 · required
currency
​string | null · required
min_events
​integer | null · int64 · required
percent
​string | null · required
window_seconds
​integer | null · int64 · required

AlertPolicyThresholdInput

amount_minor
​integer | null · int64
currency
​string | null
min_events
​integer | null · int64
percent
​string | null
window_seconds
​integer | null · int64

AlertSeverity

string · enum
Enum values:
critical
warning
info

AlertSourceState

string · enum
Enum values:
measured
data_unavailable

AlertState

string · enum
Enum values:
firing
acknowledged
resolved

AlertSubject

id
​string · required
name
​string · required
type
​AlertSubjectType · enum · required
Enum values:
account
organization
trunk
subaccount
webhook_endpoint

AlertSubjectType

string · enum
Enum values:
account
organization
trunk
subaccount
webhook_endpoint

AlertSuggestedAction

href
​string · required
label
​string · required

AuditActor

detail
​string · required
name
​string · required
type
​AuditActorType · enum · required
Enum values:
user
api_key
operator
system

AuditActorType

string · enum
Enum values:
user
api_key
operator
system

AuditEvent

action
​string · required
​AuditActor · required
applied
​boolean · required
at
​string · date-time · required
category
​AuditEventCategory · enum · required
Enum values:
configuration
security
operator
detail
​string | null · required
effective_revision
​integer | null · int64 · required
from_revision
​integer | null · int64 · required
id
​string · required
kind
​AuditEventKind · enum · required
Enum values:
trunks
numbers
credentials
seats
alerts
automation
automation_suppression
automation_batch
request_id
​string | null · required
​required
summary
​string · required
ticket_ref
​string | null · required
to_revision
​integer | null · int64 · required

AuditEventCategory

string · enum
Enum values:
configuration
security
operator

AuditEventDetail

​AuditFieldChange[] · required
​AuditEvent · required
notes
​string[] · required
supersedes_at
​string | null · date-time · required
​AuditTimelineEntry[] · required

AuditEventKind

string · enum
Enum values:
trunks
numbers
credentials
seats
alerts
automation
automation_suppression
automation_batch

AuditFieldChange

after
​string | null · required
before
​string | null · required
label
​string · required
redacted
​boolean · required
unchanged
​boolean · required

AuditPage

as_of
​string · date-time · required
​AuditEvent[] · required
next_cursor
​string | null · required
previous_cursor
​string | null · required
retention_days
​integer · int64 · required
total
​integer · int64 · min: 0 · required
total_all
​integer · int64 · min: 0 · required

AuditResource

href
​string | null · required
id
​string · required
name
​string · required
type
​string · required

AuditTimelineEntry

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

AutomationParameterInput

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = string
type = number
type = boolean
Properties for Variant 1:
string

AutomationRunOutcome

string · enum
Enum values:
completed
no_answer
busy
suppressed
failed
rejected
expired
duplicate

AutomationRunStatus

string · enum
Enum values:
staged
queued
waiting_hours
scheduled
dialing
placed
ringing
answered

AutomationSuppressionReason

string · enum
Enum values:
already_called_today
do_not_call
no_longer_owed
automation_off
outside_hours

AutomationTriggerRun

A run as the trigger and cancel URLs answer it; `id` and `runId` are the same.
createdAt
​string · date-time · required
id
​string · required
​required
recipientNumber
​string · required
runId
​string · required
signalId
​string · required

The automation's id.

status
​AutomationRunStatus · enum · required
Enum values:
staged
queued
waiting_hours
scheduled
dialing
placed
ringing
answered
​required

BillingAccount

as_of
​string · date-time · required
available_minor
​integer · int64 · required
​required

Calls refused since the hard stop began; not counted on this route yet, so always null.

capacity_minor
​integer · int64 · required
​required

When cash went below zero; not recorded yet, so always null.

cash_minor
​integer · int64 · required
credit_limit_minor
​integer · int64 · required
currency
​string · required
​required

Hours until available cash runs out at the current spend; not estimated yet, so always null.

exponent
​integer · int32 · required
exposure_minor
​integer · int64 · required
holds_minor
​integer · int64 · required
id
​string · required
live
​boolean · required
​required

The balance below which the account counts as low; not configurable yet, so always null.

​BillingPromoPool[] · required
​required

The code calls are refused with during a stop; not reported here yet, so always null.

​required

When calls began to be refused; not reported here yet, so always null.

reserved_cash_minor
​integer · int64 · required
​required

How many live calls hold reserved cash; not counted yet, so always null.

revision
​integer · int64 · required
state
​BillingAccountState · enum · required
Enum values:
hard_stop_over_limit
unfunded
low_using_credit
promo_carrying
healthy
status
​BillingAccountStatus · enum · required
Enum values:
active
suspended
closed
​required

The suspension in force on the account; not reported yet, so always null.

​required

The unpaid invoice holding the account; not reported yet, so always null.

BillingAccountState

string · enum
Enum values:
hard_stop_over_limit
unfunded
low_using_credit
promo_carrying
healthy

BillingAccountStatus

string · enum
Enum values:
active
suspended
closed

BillingDocumentCounts

credit_note
​integer · int64 · min: 0 · required
invoice
​integer · int64 · min: 0 · required
receipt
​integer · int64 · min: 0 · required
statement
​integer · int64 · min: 0 · required

BillingDocumentDetail

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: statement, kind
type = object · requires: invoice, kind
Properties for Variant 1:
kind
​string · enum · required
Enum values:
statement
​BillingStatementDetail · required

BillingDocumentDownload

filename
​string | null · required
format
​BillingDocumentFormat · enum · required
Enum values:
csv
pdf
note
​string | null · required
url
​string | null · required

BillingDocumentFormat

string · enum
Enum values:
csv
pdf

BillingDocumentKind

string · enum
Enum values:
statement
invoice
credit_note
receipt

BillingDocumentLabelValue

label
​string · required
value
​string · required
href
​string · required
label
​string · required

BillingDocumentList

as_of
​string · date-time · required
​BillingDocumentCounts · required
currency
​string · required
​BillingDocumentRow[] · required
exponent
​integer · int32 · required
invoiced
​boolean · required

BillingDocumentParties

from
​string · required
to
​string · required

BillingDocumentRestriction

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

BillingDocumentRow

detail
​string | null · required
​BillingDocumentDownload[] · required
id
​string · required
issued_at
​string | null · date-time · required
kind
​BillingDocumentKind · enum · required
Enum values:
statement
invoice
credit_note
receipt
net_minor
​integer | null · int64 · required
net_note
​string | null · required
number
​string | null · required
period_label
​string | null · required
period_note
​string | null · required
status
​BillingDocumentStatus · enum · required
Enum values:
open
issued
paid
unpaid
applied
void
status_note
​string | null · required
tax_minor
​integer | null · int64 · required
title
​string · required
total_minor
​integer | null · int64 · required

BillingDocumentStatus

string · enum
Enum values:
open
issued
paid
unpaid
applied
void

BillingInvoiceDetail

detail
​string | null · required
​BillingDocumentDownload[] · required
id
​string · required
issued_at
​string | null · date-time · required
kind
​BillingDocumentKind · enum · required
Enum values:
statement
invoice
credit_note
receipt
net_minor
​integer | null · int64 · required
net_note
​string | null · required
number
​string | null · required
period_label
​string | null · required
period_note
​string | null · required
status
​BillingDocumentStatus · enum · required
Enum values:
open
issued
paid
unpaid
applied
void
status_note
​string | null · required
tax_minor
​integer | null · int64 · required
title
​string · required
total_minor
​integer | null · int64 · required
​BillingDocumentLabelValue[] · required
currency
​string · required
exponent
​integer · int32 · required
​BillingDocumentLabelValue[] · required
​BillingInvoiceLine[] · required
​BillingDocumentParties · required
​BillingDocumentLabelValue[] · required
​BillingDocumentLink[] · required
​required
tax_rule
​string | null · required
usage_href
​string | null · required

BillingInvoiceLine

amount_minor
​integer · int64 · required
body
​string · required
meta
​string · required
ordinal
​integer · int32 · required
quantity
​string · required
title
​string · required
unit_price_minor
​integer · int64 · required

BillingPromoPool

amount_minor
​integer · int64 · required
category
​string · required
eligible_categories
​array | null · required
expires_at
​string · date-time · required
label
​string · required
pool_id
​string · required
reserved_minor
​integer · int64 · required
reserved_sessions
​integer | null · int64 · min: 0 · required
spent_at
​string | null · date-time · required

BillingStatementDetail

detail
​string | null · required
​BillingDocumentDownload[] · required
id
​string · required
issued_at
​string | null · date-time · required
kind
​BillingDocumentKind · enum · required
Enum values:
statement
invoice
credit_note
receipt
net_minor
​integer | null · int64 · required
net_note
​string | null · required
number
​string | null · required
period_label
​string | null · required
period_note
​string | null · required
status
​BillingDocumentStatus · enum · required
Enum values:
open
issued
paid
unpaid
applied
void
status_note
​string | null · required
tax_minor
​integer | null · int64 · required
title
​string · required
total_minor
​integer | null · int64 · required
​BillingStatementSkuTotal[] · required
​BillingStatementLine[] · required
closing_cash_minor
​integer · int64 · required
currency
​string · required
exponent
​integer · int32 · required
line_count
​integer · int32 · required
​BillingStatementLine[] · required
opening_cash_minor
​integer · int64 · required
reconcile_note
​string · required
reconciles
​boolean · required
​BillingDocumentLink[] · required
treasury_revision
​integer · int64 · required
version
​integer · int64 · required

BillingStatementLine

amount_minor
​integer · int64 · required
key
​string · required
label
​string · required
note
​string | null · required
origin
​string | null · required
sign
​BillingStatementLineSign · enum · required
Enum values:
plus
minus
flat
sub
​boolean · required

BillingStatementLineSign

string · enum
Enum values:
plus
minus
flat

BillingStatementSkuTotal

amount_minor
​integer · int64 · required
detail
​string · required
sku_code
​string · required

ByocAuthentication

How the carrier proves a call to us is its own: its source networks, its passwords or both.
​ByocIngressCredential[] · required

The usable passwords, the current one first; the secret is served only when generated.

​ByocIngressSource[] · required

ByocCeilings

max_call_duration_seconds
​integer · int32 · min: 0 · max: 2147483647 · required
max_concurrent
​integer · int32 · min: 0 · max: 2147483647 · required
max_cps
​integer · int32 · min: 0 · max: 2147483647 · required

ByocConnectionCall

id
​string · required
outcome
​CallOutcome · enum · required
Enum values:
answered
unanswered
cancelled
rejected
received_at
​string · date-time · required

ByocConnectionCreation

The created connection. `password` is the generated first password: sent by this response alone, null when none was asked for and on a replay.
​ByocConnectionDetail · required
password
​string | null · required

ByocConnectionDetail

direction
​ByocConnectionDirection · enum · required
Enum values:
inbound
outbound
both
hosted_number_count
​integer · int32 · min: 0 · required

Numbers in the connection's active hosted blocks.

id
​string · required
​required
​required
​required
name
​string · required
numbers_routed_elsewhere
​integer · int32 · min: 0 · required

Numbers of the active hosted blocks a route sends somewhere other than inbound_trunk.

peer_count
​integer · int32 · min: 0 · required

Enabled peers.

project_id
​string · required
​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

The hostname the carrier sends calls to, and the realm of the next generated password. Null once the connection is released, so another can take the name.

status
​ByocConnectionStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
status_since
​string · date-time · required

When the connection entered status, such as when it was last enabled.

subaccount_id
​string | null · required
as_of
​string · date-time · required
attempt_deadline_seconds
​integer · int32 · min: 0 · required

How long the whole attempt across every peer may take.

​ByocAuthentication · required

How the carrier proves a call to us is its own: its source networks, its passwords or both.

​ByocCeilings · required
failover_sip_codes
​integer[] · required

The SIP codes that move a call to the next peer.

g729
​boolean · required

G.711 (PCMA and PCMU) is always offered; true also offers G.729.

identity_policy
​ByocIdentityPolicy · enum · required
Enum values:
from_only
from_and_pai
media_security
​ByocMediaSecurity · enum · required
Enum values:
rtp
sdes_srtp_required
number_format
​ByocNumberFormat · enum · required
Enum values:
e164_plus
e164
national
peer_timeout_seconds
​integer · int32 · min: 0 · required

How long one peer has to answer before the call moves to the next peer.

​ByocPeer[] · required
privacy_passthrough
​boolean · required
strip
​integer · int32 · min: 0 · required

Leading digits removed from the dialled number before it is sent to the carrier.

tech_prefix
​string | null · required

ByocConnectionDirection

string · enum
Enum values:
inbound
outbound
both

ByocConnectionList

​ByocConnectionSummary[] · required

ByocConnectionRefusalReason

string · enum
Enum values:
source_not_permitted
authentication_failed
destination_unavailable

ByocConnectionRefusals

The edge's refusals at the connection's hostname.
last_at
​string · date-time · required
last_reason
​ByocConnectionRefusalReason · enum · required
Enum values:
source_not_permitted
authentication_failed
destination_unavailable
last_source_address
​string · required
total
​integer · int64 · required

Approximate: the edge rate limits the write.

ByocConnectionStatus

string · enum
Enum values:
draft
enabled
disabled
releasing
released

ByocConnectionSummary

direction
​ByocConnectionDirection · enum · required
Enum values:
inbound
outbound
both
hosted_number_count
​integer · int32 · min: 0 · required

Numbers in the connection's active hosted blocks.

id
​string · required
​required
​required
​required
name
​string · required
numbers_routed_elsewhere
​integer · int32 · min: 0 · required

Numbers of the active hosted blocks a route sends somewhere other than inbound_trunk.

peer_count
​integer · int32 · min: 0 · required

Enabled peers.

project_id
​string · required
​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

The hostname the carrier sends calls to, and the realm of the next generated password. Null once the connection is released, so another can take the name.

status
​ByocConnectionStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
status_since
​string · date-time · required

When the connection entered status, such as when it was last enabled.

subaccount_id
​string | null · required

ByocIdentityPolicy

string · enum
Enum values:
from_only
from_and_pai

ByocInboundTrunk

A trunk that rings a connection's numbers.
id
​string · required
name
​string · required

ByocIngressAuth

string · enum
Enum values:
source_address
digest
both

ByocIngressCredential

created_at
​string · date-time · required
id
​string · required
realm
​string · required
username
​string · required
valid_until
​string | null · date-time · required

When a rotated password stops working; null on the current one.

ByocIngressCredentialSecret

A generated password, sent by its create or rotate response alone; `password` is null on a replay, since the secret is never kept.
created_at
​string · date-time · required
id
​string · required
realm
​string · required
username
​string · required
valid_until
​string | null · date-time · required

When a rotated password stops working; null on the current one.

password
​string | null · required
replaced_valid_until
​string | null · date-time · required

When the password this one replaced stops working; null on a create.

ByocIngressSource

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

ByocIngressSourceInput

A public IPv4 network of /24 or narrower the carrier sends calls from.
cidr
​string · required

ByocMediaSecurity

string · enum
Enum values:
rtp
sdes_srtp_required

ByocNumberFormat

string · enum
Enum values:
e164_plus
e164
national

ByocPeer

A carrier SBC we send calls to; the lowest priority is tried first.
enabled
​boolean · required
host
​string · required
id
​string · required
port
​integer · int32 · min: 0 · required
priority
​integer · int32 · required
transport
​ByocPeerTransport · enum · required
Enum values:
udp
tcp
tls
weight
​integer · int32 · required

ByocPeerInput

A carrier SBC to send calls to; the lowest priority is tried first.
host
​string · required
port
​integer · int32 · min: 0 · required
priority
​integer · int32 · required
transport
​ByocPeerTransport · enum · required
Enum values:
udp
tcp
tls
weight
​integer · int32 · required

ByocPeerTransport

string · enum
Enum values:
udp
tcp
tls

Call

answered_at
​string | null · date-time · required
direction
​CallDirection · enum · required
Enum values:
inbound
outbound
ended_at
​string | null · date-time · required
from_number
​string · required
has_recording
​boolean · required
id
​string · required
observed_duration_ns
​integer | null · int64 · required
outcome
​CallOutcome · enum · required
Enum values:
answered
unanswered
cancelled
rejected
​CallRating · required
received_at
​string · date-time · required
​CallService · required
sip_call_id
​string | null · required
source_product
​CallSourceProduct · enum · required
Enum values:
trunking
voice
automation
pressone
​required
​CallTermination · required
to_number
​string · required

CallApiRequest

key_hint
​string · required
method
​string · required
path
​string · required
request_id
​string · required

CallBilling

amount_minor
​integer | null · int64 · required
billable_duration_ns
​integer | null · int64 · required
charge_category
​string | null · required
charging_session_ref
​string | null · required
connection_fee_minor
​integer | null · int64 · required
correction_ref
​string | null · required
currency
​string · required
destination
​string | null · required
drift_minor
​integer | null · int64 · required
drift_tolerance_minor
​integer | null · int64 · required
expected_amount_minor
​integer | null · int64 · required
funded_cash_minor
​integer | null · int64 · required
funded_promotional_minor
​integer | null · int64 · required
increment_ns
​integer | null · int64 · required
observed_duration_ns
​integer | null · int64 · required
​required
price_unit
​string · required
rating_state
​CallRatingState · enum · required
Enum values:
none
rated
unrated
pending
reserved_minor
​integer | null · int64 · required
settled_at
​string | null · date-time · required
settlement_ref
​string | null · required
settlement_revision
​integer | null · int64 · required
settlement_state
​string | null · required
terms_revision
​integer | null · int64 · required
unit_price_minor
​integer | null · int64 · required
usage_record_id
​string | null · required

CallCallerIdEvidence

asserted_number
​string · required
in_range
​boolean · required
number_id
​string | null · required
number_status
​string · required
quarantine_until
​string | null · date-time · required
range_end
​string · required
range_start
​string · required
released_at
​string | null · date-time · required

CallCarrierAttempt

attempt_number
​integer · int32 · required
finished_at
​string · date-time · required
outcome
​CallCarrierAttemptOutcome · enum · required
Enum values:
answered
busy
no_answer
destination_rejected
transport_failure
timeout
platform_failure
​CallCarrierPeer · required
sip_code
​integer | null · int32 · required
started_at
​string · date-time · required

CallCarrierAttemptOutcome

string · enum
Enum values:
answered
busy
no_answer
destination_rejected
transport_failure
timeout
platform_failure

CallCarrierConnection

​CallCarrierAttempt[] · required
id
​string · required
name
​string · required
​required

CallCarrierPeer

host
​string · required
id
​string · required

CallCompleteness

string · enum
Enum values:
finalizing
final

CallDetail

answered_at
​string | null · date-time · required
direction
​CallDirection · enum · required
Enum values:
inbound
outbound
ended_at
​string | null · date-time · required
from_number
​string · required
has_recording
​boolean · required
id
​string · required
observed_duration_ns
​integer | null · int64 · required
outcome
​CallOutcome · enum · required
Enum values:
answered
unanswered
cancelled
rejected
​CallRating · required
received_at
​string · date-time · required
​CallService · required
sip_call_id
​string | null · required
source_product
​CallSourceProduct · enum · required
Enum values:
trunking
voice
automation
pressone
​required
​CallTermination · required
to_number
​string · required
​required
​CallBilling · required
​required
​required
carrier_leg_ref
​string | null · required
carrier_route
​string | null · required
carrier_sip_summary
​string | null · required

The carrier's final SIP code; set only for a call through a connection.

completeness
​CallCompleteness · enum · required
Enum values:
finalizing
final
connected_from
​string | null · date-time · required
connected_to
​string | null · date-time · required
customer_sip_summary
​string · required
​CallMilestone[] · required
​CallRecording[] · required
​required
trunk_id
​string | null · required

CallDiagnosticLeg

created_at
​string | null · date-time · required
peer
​string · required
ref
​string · required
released_at
​string | null · date-time · required
side
​CallSipSide · enum · required
Enum values:
carrier
customer

CallDiagnosticState

string · enum
Enum values:
pending
ready
unavailable
expired

CallDirection

string · enum
Enum values:
inbound
outbound

CallEvent

attempt
​integer · int32 · required
delivered
​boolean · required
endpoint
​string | null · required
event_kind
​string · required
failure
​string | null · required
fallback
​boolean · required
latency_ms
​integer | null · int64 · required
​required
occurred_at
​string · date-time · required
​required
status_code
​integer | null · int32 · required

CallEventHistoryState

string · enum
Enum values:
enabled
disabled

CallEventList

​CallEvent[] · required

CallEventMethod

string · enum
Enum values:
GET
POST

CallEventRawHistory

string · enum
Enum values:
stored
disabled
expired

CallHangupInitiator

string · enum
Enum values:
caller
callee
platform
carrier

CallMediaAudioLeg

codec
​string | null · required

Null when the leg carried no packets; rtpengine then names no codec.

cumulative_loss_packets
​integer | null · int64 · required
index
​integer · int32 · required
jitter_ms
​integer | null · int64 · required
mos_tenths
​integer | null · int32 · required

MOS in tenths; 42 means 4.2.

packet_loss
​integer | null · int64 · required

Producer packet-loss counter, not a percentage.

packetization_ms
​integer | null · int32 · required
packetization_unavailable_reason
​string | null · required
protocol
​string · required
rtp_packets
​integer · int64 · required
rtt_ms
​integer | null · int64 · required
transcoding
​boolean · required
unavailable_reason
​string | null · required

CallMediaQueryState

string · enum
Enum values:
ready
unavailable

CallMediaSummary

anchored
​boolean | null · required
dtmf
​string | null · required
first_rtp_ms
​integer | null · int64 · required
jitter_max_ms
​number | null · double · required
packets_lost
​integer | null · int64 · required
packets_total
​integer | null · int64 · required
rtp_path
​string | null · required
srtp
​boolean | null · required
expires_at
​string | null · date-time · required
imported_at
​string | null · date-time · required
​CallQosSummary · required
reason
​string | null · required
schema_version
​integer · int32 · required
state
​CallDiagnosticState · enum · required
Enum values:
pending
ready
unavailable
expired
​required

CallMediaTransport

​CallMediaAudioLeg[] · required
directionality_unavailable_reason
​string | null · required
media_profile
​string · required
media_timeout
​boolean | null · required
media_timeout_unavailable_reason
​string | null · required
one_way
​boolean | null · required
query_state
​CallMediaQueryState · enum · required
Enum values:
ready
unavailable
rtcp_bytes
​integer | null · int64 · required
rtcp_errors
​integer | null · int64 · required
rtcp_packets
​integer | null · int64 · required
rtp_bytes
​integer | null · int64 · required
rtp_errors
​integer | null · int64 · required
rtp_packets
​integer | null · int64 · required
unavailable_reason
​string | null · required
version
​integer · int32 · required
zero_way
​boolean | null · required

CallMilestone

kind
​CallMilestoneKind · enum · required
Enum values:
received
authenticated
authorized
routed
ringing
answered
ended
occurred_at
​string | null · date-time · required
reason
​string | null · required
sequence
​integer · int32 · required
state
​CallMilestoneState · enum · required
Enum values:
observed
not_reached
unavailable

CallMilestoneKind

string · enum
Enum values:
received
authenticated
authorized
routed
ringing
answered
ended

CallMilestoneState

string · enum
Enum values:
observed
not_reached
unavailable

CallOutcome

string · enum
Enum values:
answered
unanswered
cancelled
rejected

CallPage

answered
​integer · int64 · min: 0 · required
as_of
​string · date-time · required
​Call[] · required
failed
​integer · int64 · min: 0 · required
next_cursor
​string | null · required
previous_cursor
​string | null · required
total
​integer · int64 · min: 0 · required

CallPriceBook

id
​string · required

CallQosCaptureId

string · enum
Enum values:
111
113

CallQosCodecSource

string · enum
Enum values:
answer
offer-heuristic
none

CallQosEndpointRole

string · enum
Enum values:
freeswitch
carrier
customer_endpoint

CallQosPerspective

avg_jitter_ms
​number | null · double · required
avg_loss_pct
​string | null · required
avg_mos
​number | null · double · required
capture_id
​CallQosCaptureId · enum · required
Enum values:
111
113
codec
​string · required
codec_source
​CallQosCodecSource · enum · required
Enum values:
answer
offer-heuristic
none
duration_seconds
​integer · int32 · required
index
​integer · int32 · required
max_jitter_ms
​number | null · double · required
max_loss_pct
​string | null · required
min_mos
​number | null · double · required
packets_lost
​integer | null · int64 · required
relay
​CallQosRelay · enum · required
Enum values:
saas_rtpengine
mvno_rtpengine
report_count
​integer · int64 · required
reported_role
​CallQosEndpointRole · enum · required
Enum values:
freeswitch
carrier
customer_endpoint
reporter_role
​CallQosEndpointRole · enum · required
Enum values:
freeswitch
carrier
customer_endpoint
started_at
​string · date-time · required

CallQosRelay

string · enum
Enum values:
saas_rtpengine
mvno_rtpengine

CallQosSummary

expires_at
​string | null · date-time · required
imported_at
​string | null · date-time · required
​CallQosPerspective[] · required
reason
​string | null · required
schema_version
​integer · int32 · required
state
​CallDiagnosticState · enum · required
Enum values:
pending
ready
unavailable
expired

CallRating

amount_minor
​integer | null · int64 · required
billable_duration_ns
​integer | null · int64 · required
currency
​string · required
rating_state
​CallRatingState · enum · required
Enum values:
none
rated
unrated
pending
usage_record_id
​string | null · required

CallRatingState

string · enum
Enum values:
none
rated
unrated
pending

CallRecording

amount_minor
​integer | null · int64 · required
​required
currency
​string · required
duration_ms
​integer | null · int64 · required
failed_at
​string | null · date-time · required
failure_reason
​string | null · required
​required
id
​string | null · required
​required
​required
retention_expires_at
​string | null · date-time · required
sku_code
​string | null · required
source
​RecordingSource · enum · required
Enum values:
trunk
voice_record
voice_dial
voice_api
state
​RecordingLifecycleState · enum · required
Enum values:
pending
capturing
stored
absent
failed
deleting
deleted

CallRecordingPolicy

id
​string · required
name
​string · required
scope
​string · required

CallService

id
​string · required
name
​string · required

CallSipLadder

expires_at
​string | null · date-time · required
imported_at
​string | null · date-time · required
invite_headers
​string | null · required
​CallDiagnosticLeg[] · required
​CallSipMessage[] · required
reason
​string | null · required
schema_version
​integer · int32 · required
state
​CallDiagnosticState · enum · required
Enum values:
pending
ready
unavailable
expired

CallSipMessage

direction
​CallDirection · enum · required
Enum values:
inbound
outbound
failure
​boolean · required
offset_ms
​integer · int64 · required
side
​CallSipSide · enum · required
Enum values:
carrier
customer
text
​string · required

CallSipSide

string · enum
Enum values:
carrier
customer

CallSourceProduct

string · enum
Enum values:
trunking
voice
automation
pressone

CallSubaccount

id
​string · required
name
​string · required

CallTermination

​required
platform_reason
​string · required
q850_capture_reason
​string | null · required
q850_cause
​integer | null · int32 · required
q850_text
​string | null · required
sip_code
​integer | null · int32 · required

CancelAutomationRunRequest

event_id
​string · maxLength: 120 · required

The event_id the run was triggered with.

CapturePrice

currency
​string · required
rate_minor
​integer · int64 · required

CatalogCurrency

string · enum
Enum values:
NGN

ChangeOutboundPolicyDestinationRulesRequest

​DestinationRuleChangeInput[] · required

Containment

case_ref
​string · required
expires_at
​string · date-time · required
id
​string · uuid · required
notified_at
​string | null · date-time · required
notified_event
​string | null · required
prefix
​string · required
reason_category
​ContainmentReasonCategory · enum · required
Enum values:
destination_risk
account_compromise
reason_detail
​string · required
rejection_code
​ContainmentRejectionCode · enum · required
Enum values:
DESTINATION_CONTAINED
rejection_count
​integer · int64 · min: 0 · required
​required
released_at
​string | null · date-time · required
released_by
​string | null · required
source_alert_id
​string | null · required
starts_at
​string · date-time · required
trunk_id
​string · required
trunk_name
​string · required

ContainmentReasonCategory

string · enum
Enum values:
destination_risk
account_compromise

ContainmentRejectionCode

string · enum
Enum values:
DESTINATION_CONTAINED

ContainmentReleaseRequest

decision_at
​string | null · date-time · required
decision_by
​string | null · required
decision_reason
​string | null · required
id
​string · uuid · required
note
​string · required
requested_at
​string · date-time · required
requested_by
​string · required
state
​ContainmentReleaseRequestState · enum · required
Enum values:
pending
approved
rejected

ContainmentReleaseRequestState

string · enum
Enum values:
pending
approved
rejected

CreateByocConnectionRequest

attempt_deadline_seconds
​integer · int32 · min: 0 · required

How long the whole attempt across every peer may take; more than the peer timeout.

​ByocCeilings · required
direction
​ByocConnectionDirection · enum · required
Enum values:
inbound
outbound
both
failover_sip_codes
​integer[] · required

The SIP codes, 400 to 699, that move a call to the next peer.

g729
​boolean · required

G.711 (PCMA and PCMU) is always offered; true also offers G.729.

generate_password
​boolean · required

true generates the connection's first password, which the 201 body carries once.

identity_policy
​ByocIdentityPolicy · enum · required
Enum values:
from_only
from_and_pai
​ByocIngressSourceInput[] · required
media_security
​ByocMediaSecurity · enum · required
Enum values:
rtp
sdes_srtp_required
name
​string · required
number_format
​ByocNumberFormat · enum · required
Enum values:
e164_plus
e164
national
peer_timeout_seconds
​integer · int32 · min: 0 · required

How long one peer has to answer before the call moves to the next peer.

​ByocPeerInput[] · required
privacy_passthrough
​boolean · required
strip
​integer · int32 · min: 0 · max: 14 · required

Leading digits removed from the dialled number before it is sent to the carrier.

inbound_trunk_id
​string | null

The trunk that rings this connection's numbers: a trunk of this project that takes inbound calls. Required unless direction is outbound, where a trunk is refused.

subaccount_id
​string | null
tech_prefix
​string | null

One to fifteen digits put before the dialled number sent to the carrier.

CreateNumberHoldRequest

end
​string · required
size
​NumberBlockSize · enum · int32 · required
Enum values:
1
10
50
100
500
1000
start
​string · required
vanity_number
​string | null

CreateSubaccountRequest

​SubaccountConfigurationInput · required
name
​string · required

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

CreateVoiceApplicationRequest

name
​string · required
voice_method
​VoiceHttpMethod · enum · required
Enum values:
GET
POST
voice_url
​string · uri · required
​
fallback_url
​string | null · uri
​
status_callback_url
​string | null · uri

CreateWebhookEndpointRequest

events
​string[] · required
scope_type
​WebhookEndpointScopeType · enum · required
Enum values:
organization
trunk
subaccount
automation
timeout_seconds
​integer · int32 · min: 0 · required
url
​string · uri · required
failover_url
​string | null · uri
scope_id
​string | null

CreatedWebhookEndpoint

​WebhookEndpoint · required
secret
​string | null · required
secret_unavailable
​boolean · required

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

HostedNumber

​required
number
​string · required

HostedNumberBlock

connection_id
​string · required
connection_name
​string · required
​required
end
​string · required
id
​string · required
imported_at
​string · date-time · required
last_inbound_call_at
​string | null · date-time · required

The project's newest inbound call to any number of the block, or null when it has none.

​NumberRouteSlice[] · required

The block's routes, which override default_trunk for their numbers.

size
​integer · int32 · min: 0 · required
start
​string · required

HostedNumberBlockDetail

connection_id
​string · required
connection_name
​string · required
​required
end
​string · required
id
​string · required
imported_at
​string · date-time · required
last_inbound_call_at
​string | null · date-time · required

The project's newest inbound call to any number of the block, or null when it has none.

​NumberRouteSlice[] · required

The block's routes, which override default_trunk for their numbers.

size
​integer · int32 · min: 0 · required
start
​string · required
​HostedNumber[] · required

HostedNumberBlockList

​HostedNumberBlock[] · required

HostedNumberCall

from
​string · required
id
​string · required
received_at
​string · date-time · required

HostedNumberImportBlock

One block the import created: a contiguous run of at most 1,000 numbers.
end
​string · required
id
​string · required
start
​string · required

HostedNumberImportReceipt

​HostedNumberImportBlock[] · required
imported
​integer · int32 · min: 0 · required

ImportHostedNumbersRequest

connection_id
​string · required

The carrier connection the numbers arrive through.

numbers
​string[] · required

1 to 5,000 distinct Nigerian E.164 numbers, such as +2348060000000.

IndividualNumber

​required
assigned_at
​string · date-time · required
block_id
​string · required
id
​string · required
number
​string · required
​required
tier
​string · required

IndividualNumberActivity

last_call_id
​string | null · required
last_inbound_at
​string | null · date-time · required
last_outbound_cli_at
​string | null · date-time · required
observed_at
​string · date-time · required

IndividualNumberList

​IndividualNumber[] · required

IndividualNumberRoute

The live route of one number; absent when the number is parked.
​NumberTarget · required

MediaQuality

estimated_mos
​number | null · double · required
fault_measured_calls
​integer · int64 · min: 0 · required

Answered calls with a relay media summary; the one-way and no-media sample.

jitter_ms
​number | null · double · required
no_media_calls
​integer · int64 · min: 0 · required
one_way_media_calls
​integer · int64 · min: 0 · required
packet_loss_pct
​string | null · required
quality_measured_calls
​integer · int64 · min: 0 · required

Answered calls with a Homer quality summary; the MOS, loss and jitter sample.

NumberAuditEntry

actor
​string · required
at
​string · date-time · required
id
​string · required
text
​string · required
tone
​NumberAuditTone · enum · required
Enum values:
info
idle
ok
warn

NumberAuditTone

string · enum
Enum values:
info
idle
ok
warn

NumberBlockConnection

The carrier connection whose range holds a hosted block.
id
​string · required
name
​string · required

NumberBlockConsumer

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

NumberBlockDetail

​required
assigned
​integer · int32 · min: 0 · required
​required
​required
​required
detached_at
​string | null · date-time · required
end
​string · required
id
​string · required
monthly_minor
​integer | null · int64 · required
ordered_at
​string · date-time · required
origin
​NumberBlockOrigin · enum · required

entitlement marks the organization's included number: free, and never releasable. hosted marks numbers a carrier connection brings: no quote and no Signals rental.

Enum values:
standard
vanity
entitlement
hosted
quarantine_until
​string | null · date-time · required
quarantined
​integer · int32 · min: 0 · required
revision
​integer · int64 · required

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

​NumberRouteConsumer[] · required
size
​integer · int32 · min: 1 · max: 1000 · required

A Signals block holds 1, 10, 50, 100, 500 or 1000 numbers; a hosted block 1 to 1000.

start
​string · required
status
​NumberBlockStatus · enum · required
Enum values:
reserved
active
pending_release
quarantined
tier
​string · required
next_charge_at
​string | null · date-time · required
​required
​NumberAuditEntry[] · required
​NumberRouteSlice[] · required
​required

NumberBlockList

​NumberBlockSummary[] · required

NumberBlockOrigin

string · enum
Enum values:
standard
vanity
entitlement
hosted

NumberBlockSize

integer · enum · int32
Enum values:
1
10
50
100
500
1000

NumberBlockStatus

string · enum
Enum values:
reserved
active
pending_release
quarantined

NumberBlockSummary

​required
assigned
​integer · int32 · min: 0 · required
​required
​required
​required
detached_at
​string | null · date-time · required
end
​string · required
id
​string · required
monthly_minor
​integer | null · int64 · required
ordered_at
​string · date-time · required
origin
​NumberBlockOrigin · enum · required

entitlement marks the organization's included number: free, and never releasable. hosted marks numbers a carrier connection brings: no quote and no Signals rental.

Enum values:
standard
vanity
entitlement
hosted
quarantine_until
​string | null · date-time · required
quarantined
​integer · int32 · min: 0 · required
revision
​integer · int64 · required

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

​NumberRouteConsumer[] · required
size
​integer · int32 · min: 1 · max: 1000 · required

A Signals block holds 1, 10, 50, 100, 500 or 1000 numbers; a hosted block 1 to 1000.

start
​string · required
status
​NumberBlockStatus · enum · required
Enum values:
reserved
active
pending_release
quarantined
tier
​string · required

NumberCandidate

adjacent_to
​string | null · required
as_of
​string · date-time · required
currency
​CatalogCurrency · enum · required
Enum values:
NGN
end
​string · required
monthly_minor
​integer · int64 · required
reasons
​string[] · required
setup_minor
​integer · int64 · required
size
​NumberBlockSize · enum · int32 · required
Enum values:
1
10
50
100
500
1000
start
​string · required
tier
​string · required
​NumberTierQuote[] · required
vanity_number
​string | null · required

NumberCandidateList

​NumberCandidate[] · required

NumberHold

block_id
​string · required
end
​string · required
expires_at
​string · date-time · required
held_at
​string · date-time · required
held_by
​string · required
id
​string · required
origin
​NumberHoldOrigin · enum · required
Enum values:
standard
vanity
​NumberQuote · required
size
​NumberBlockSize · enum · int32 · required
Enum values:
1
10
50
100
500
1000
start
​string · required
​required
​required

NumberHoldList

​NumberHold[] · required

NumberHoldOrigin

string · enum
Enum values:
standard
vanity

NumberOrder

block_id
​string · required
currency
​CatalogCurrency · enum · required
Enum values:
NGN
order_id
​string · required
state
​NumberOrderState · enum · required
Enum values:
pending_charge
active
failed
total_minor
​integer · int64 · required

NumberOrderState

string · enum
Enum values:
pending_charge
active
failed

NumberPattern

code
​string · required
label
​string · required

NumberQuarantine

count
​integer · int32 · min: 0 · required
end
​string · required
released_at
​string · date-time · required
released_by
​string · required
start
​string · required
until
​string · date-time · required

NumberQuote

currency
​CatalogCurrency · enum · required
Enum values:
NGN
expires_at
​string · date-time · required
id
​string · required
initial_minor
​integer · int64 · required
​NumberQuoteLine[] · required
monthly_minor
​integer · int64 · required
setup_minor
​integer · int64 · required
​NumberTierQuote[] · required
version
​integer · int64 · required

NumberQuoteDetail

currency
​CatalogCurrency · enum · required
Enum values:
NGN
expires_at
​string · date-time · required
id
​string · required
initial_minor
​integer · int64 · required
​NumberQuoteLine[] · required
monthly_minor
​integer · int64 · required
setup_minor
​integer · int64 · required
​NumberTierQuote[] · required
version
​integer · int64 · required
accepted_at
​string | null · date-time · required
block_id
​string · required
​required
quote_hash
​string · required
status
​NumberQuoteStatus · enum · required
Enum values:
accepted
active
expired

NumberQuoteLine

amount_minor
​integer · int64 · required
label
​string · required

NumberQuoteOrder

id
​string · required
state
​NumberOrderState · enum · required
Enum values:
pending_charge
active
failed

NumberQuoteStatus

string · enum
Enum values:
accepted
active
expired

NumberRouteChangeInput

end
​string · required
start
​string · required
​

NumberRouteConsumer

count
​integer · int32 · min: 0 · required
id
​string · required
name
​string · required
type
​NumberTargetKind · enum · required
Enum values:
trunk
voice_application
automation

NumberRouteList

​NumberRouteSlice[] · required

NumberRouteSlice

One attached route slice of a block; an attached slice is live on the voice hosts.
count
​integer · int32 · min: 0 · required
end
​string · required
start
​string · required
​NumberTarget · required

NumberRouteTargetInput

id
​string · required
type
​NumberRouteTargetKindInput · enum · required
Enum values:
trunk
voice_application

NumberRouteTargetKindInput

string · enum
Enum values:
trunk
voice_application

NumberTarget

id
​string · required
name
​string · required
type
​NumberTargetKind · enum · required
Enum values:
trunk
voice_application
automation

NumberTargetKind

string · enum
Enum values:
trunk
voice_application
automation

NumberTier

code
​string · required
currency
​CatalogCurrency · enum · required
Enum values:
NGN
label
​string · required
monthly_minor
​integer | null · int64 · required
​NumberPattern[] · required
rank
​integer · int32 · required
setup_minor
​integer | null · int64 · required

NumberTierList

​NumberTier[] · required

NumberTierQuote

count
​integer · int32 · min: 0 · required
initial_unit_minor
​integer · int64 · required
monthly_unit_minor
​integer · int64 · required
setup_unit_minor
​integer · int64 · required
tier
​string · required

NumberTransitionHold

kind
​NumberTransitionHoldKind · enum · required
Enum values:
legal
manual
lifts_at
​string | null · date-time · required
placed_at
​string · date-time · required
placed_by
​string · required
reference
​string · required

NumberTransitionHoldKind

string · enum
Enum values:
legal
manual

NumberVanity

number
​string · required
reason
​string · required
tier
​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

PendingPayer

billing_account_id
​string · required
billing_assignment_revision
​integer · int64 · required
effective_from
​string · date-time · required

PlatformCarrierSheet

What a customer gives their carrier beside the connection's own hostname and realm, restating the signaling and media fields above.
​PlatformMediaRange[] · required
​SignalingPort[] · required
signaling_addresses
​string[] · required

PlatformEndpoints

as_of
​string · date-time · required
​PlatformCarrierSheet · required

What a customer gives their carrier beside the connection's own hostname and realm, restating the signaling and media fields above.

media_anchors
​string[] · required
media_cidrs
​string[] · required
rtp_port_range
​string · required
​PortRange · required
signaling_fqdn
​string · required
signaling_nodes
​string[] · required
signaling_port
​integer · int32 · min: 0 · required
​SignalingPort[] · required
​PlatformTls · required
version
​integer · int64 · required

PlatformMediaRange

end
​integer · int32 · min: 0 · required
protocol
​PlatformSignalingTransport · enum · required
Enum values:
udp
tcp
tls
start
​integer · int32 · min: 0 · required

PlatformSignalingTransport

string · enum
Enum values:
udp
tcp
tls

PlatformTls

realm
​string · required
trust_chain
​string[] · 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
service_id
​string · required
service_name
​string · required
service_type
​PolicyServiceType · enum · required
Enum values:
trunk
voice_application
automation

PolicyAttachmentApplyState

string · enum
Enum values:
applied
pending

PolicyAttachmentList

​PolicyAttachment[] · required

PolicyAttachmentRef

note
​string | null · required
service_name
​string · required
service_type
​PolicyServiceType · enum · required
Enum values:
trunk
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
voice_application
automation

PortRange

end
​integer · int32 · min: 0 · required
start
​integer · int32 · min: 0 · required

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
available
​string[]
​ProjectRef[]
caused_by
​string
changed_resources
​string[]
conflicts
​string[]

The submitted numbers that already have a holder.

expensive_filter
​string
field
​string

The top-level request member a validation problem is about.

reason
​string
remediation
​string
supported
​string[]
unknown_variables
​string[]

ProjectList

​ProjectSummary[] · required

ProjectRef

id
​string · required
name
​string · required

ProjectStatus

string · enum
Enum values:
active
disabled

ProjectSummary

billing_account_id
​string · required
billing_assignment_revision
​integer · int64 · required
billing_effective_from
​string · date-time · required
currency
​CatalogCurrency · enum · required
Enum values:
NGN
id
​string · required
name
​string · required
​required
status
​ProjectStatus · enum · required
Enum values:
active
disabled

PromotionalCredit

applied_minor
​integer · int64 · required
expires_at
​string · date-time · required
remaining_minor
​integer · int64 · required

RateCallerIdRule

restricts
​boolean · required
text
​string · required

RateCoverage

as_of
​string · date-time · required
currency
​string · required
effective_from
​string · date-time · required
​RateCoverageRow[] · required

RateCoverageGap

covered_until
​string | null · date-time · required
missing
​RateCoverageGapKind · enum · required
Enum values:
route
rate
both
​RateCoverageNeighbour[] · required
prefix
​string · required
rate_micro
​integer | null · int64 · required
reason
​string | null · required

RateCoverageGapKind

string · enum
Enum values:
route
rate
both

RateCoverageNeighbour

name
​string · required
prefix
​string · required

RateCoverageRow

also_prefixes
​string[] · required
available_since
​string · date-time · required
​RateCallerIdRule · required
connection_fee_minor
​integer · int64 · required
country
​string · required
country_code
​string · required
id
​string · required
​RateIncrement · required
name
​string · required
prefix
​string · required
rate_micro
​integer · int64 · required
route_class
​string · required

RateDestination

also_prefixes
​string[] · required
country
​string · required
country_code
​string · required
name
​string · required
prefix
​string · required

RateDirection

string · enum
Enum values:
inbound
outbound

RateIncrement

increment_seconds
​integer · int32 · required
minimum_seconds
​integer · int32 · required
plan_name
​string | null · required

RateLookup

as_of
​string · date-time · required
containment
​string | null · required
covered
​boolean · required
currency
​string · required
​required
​required
destination_number
​string · required
direction
​RateDirection · enum · required
Enum values:
inbound
outbound
​required
​RatePriceBook · required
​required

RatePriceBook

id
​string · required
name
​string · required

RateTerms

​RateCallerIdRule · required
connection_fee_minor
​integer · int64 · required
effective_from
​string · date-time · required
​RateIncrement · required
rate_micro
​integer · int64 · required
route_class
​string · required

Recording

bytes
​integer | null · int64 · required
call_charge_minor
​integer | null · int64 · required
call_duration_ms
​integer | null · int64 · required
call_id
​string · required
capture_charge_minor
​integer | null · int64 · required
channels
​RecordingChannels · enum · int32 · required
Enum values:
1
2
currency
​string · required
deleted_at
​string | null · date-time · required
destination_label
​string · required
direction
​CallDirection · enum · required
Enum values:
inbound
outbound
duration_ms
​integer | null · int64 · required
failed_at
​string | null · date-time · required
failure_detail
​string | null · required
failure_reason
​string | null · required
format
​RecordingFormat · enum · required
Enum values:
mp3
wav
id
​string · required
intent_id
​string · required
legal_hold
​boolean · required
legal_hold_since
​string | null · date-time · required
remote_number
​string · required
retention_days
​RecordingRetentionDays · enum · int32 · required
Enum values:
30
90
365
retention_expires_at
​string | null · date-time · required
started_at
​string · date-time · required
state
​RecordingLifecycleState · enum · required
Enum values:
pending
capturing
stored
absent
failed
deleting
deleted
stored_at
​string | null · date-time · required
subaccount_id
​string | null · required
trunk_id
​string · required
trunk_name
​string · required

RecordingChannels

integer · enum · int32
Enum values:
1
2

RecordingDetail

A recording as a deletion request leaves it.
id
​string · required
state
​RecordingLifecycleState · enum · required
Enum values:
pending
capturing
stored
absent
failed
deleting
deleted

RecordingFormat

string · enum
Enum values:
mp3
wav

RecordingLifecycleState

string · enum
Enum values:
pending
capturing
stored
absent
failed
deleting
deleted

RecordingPolicyChannelsInput

integer · enum · int32
Enum values:
2

RecordingPolicyMode

string · enum
Enum values:
off
all

RecordingPolicyRef

channels
​integer · int32 · min: 0 · required
id
​string · required
mode
​RecordingPolicyRefMode · enum · required
Enum values:
all
name
​string · required
retention_days
​RecordingRetentionDays · enum · int32 · required
Enum values:
30
90
365

RecordingPolicyRefMode

string · enum
Enum values:
all

RecordingRetentionDays

integer · enum · int32
Enum values:
30
90
365

RecordingSource

string · enum
Enum values:
trunk
voice_record
voice_dial
voice_api

RecordingsPage

​required
​Recording[] · required
​required
recorded_ms_this_month
​integer · int64 · required
total
​integer · int64 · min: 0 · required

RelatedCallLeg

direction
​CallDirection · enum · required
Enum values:
inbound
outbound
id
​string · required
relation
​RelatedCallRelation · enum · required
Enum values:
parent
child
sibling
started_at
​string · date-time · required

RelatedCallRelation

string · enum
Enum values:
parent
child
sibling

RelatedCalls

count
​integer · int64 · min: 0 · required
destination
​string · required
​RelatedCallLeg[] · required
sip_code
​integer | null · int32 · required

ReleaseByocConnectionRequest

The connection's name typed again, so a release is never a slip.
confirm_name
​string · required

ReleaseNumberBlockRequest

end
​string · required
start
​string · required

ReleaseTrunkRequest

confirm_name
​string · required

RemoveHostedNumbersRequest

confirm
​boolean · required

Must be true: removal releases every number of the block.

ReplaceNumberRoutesRequest

​NumberRouteChangeInput[] · required

ReplayWebhookEventsRequest

delivery_ids
​string[] · required
event_types
​string[] · required
preview
​boolean · required
window_from
​string · date-time · required
window_to
​string · date-time · 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

SignalingPort

port
​integer · int32 · min: 0 · required
transport
​PlatformSignalingTransport · enum · required
Enum values:
udp
tcp
tls

Subaccount

created_at
​string · date-time · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
​SubaccountPolicyCeilings[] · required
id
​string · required
live_calls
​integer · int32 · min: 0 · required
max_call_duration_seconds
​integer | null · int32 · required
max_concurrent
​integer | null · int32 · required
max_cps
​integer | null · int32 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
revision
​integer · int64 · required

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

status
​SubaccountLifecycleStatus · enum · required
Enum values:
enabled
suspended
updated_at
​string · date-time · required
​SubaccountUsage30Days · required

SubaccountBusiestDay

date
​string · date · required
settled_spend_minor
​integer · int64 · required

SubaccountConfigurationInput

currency
​string · required
daily_spend_cap_minor
​integer | null · int64
max_call_duration_seconds
​integer | null · int32 · min: 0
max_concurrent
​integer | null · int32 · min: 0
max_cps
​integer | null · int32 · min: 0
max_destination_rate_minor
​integer | null · int64

SubaccountLifecycleStatus

string · enum
Enum values:
enabled
suspended

SubaccountList

​Subaccount[] · required

SubaccountPolicyCeilings

acknowledged_at
​string · date-time · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · 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
policy_id
​string · required
policy_name
​string · required
policy_revision
​integer · int64 · required
runtime_revision
​integer · int64 · required
trunk_id
​string · required
trunk_name
​string · required

SubaccountRefusal

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

SubaccountStatusRequest

confirm_name
​string · required

SubaccountUsage30Days

answered_calls
​integer · int32 · min: 0 · required
as_of
​string · date-time · required
​required
call_attempts
​integer · int32 · min: 0 · required
currency
​string · required
live_calls
​integer · int32 · min: 0 · required
peak_concurrent
​integer · int32 · min: 0 · required
peak_concurrent_at
​string | null · date-time · required
pending_spend_minor
​integer · int64 · required
​SubaccountRefusal[] · required
settled_spend_minor
​integer · int64 · required
window_from
​string · date-time · required

TriggerAutomationRequest

The trigger body; it is read as JSON and validated member by member.
phone_number
​string · pattern: ^\+[1-9][0-9]{6,14}$ · required

The number to call, in E.164.

event_id
​string | null · maxLength: 120

Your id for this request; a repeat answers the first run. One is made when omitted.

metadata
​object | null

Kept with the run as sent; at most 4096 bytes of JSON.

name
​string | null · maxLength: 120

The recipient's name, the template's {{name}}.

​object | null

Template values: at most 40, keyed ^[a-zA-Z][a-zA-Z0-9_]{0,63}$.

TrunkApplicationState

string · enum
Enum values:
pending
applied
failed
unknown

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

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

Every number the trunk answers, by route or as a connection's hosted default.

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
application_state
​TrunkApplicationState · enum · required
Enum values:
pending
applied
failed
unknown
as_of
​string · date-time · required
​TrunkAuthentication · required
​TrunkEndpointEvidence[] · required
​TrunkLimits · required
​TrunkMedia · required
​TrunkNumbers · required
​required
​TrunkRoute[] · 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

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
​MediaQuality · required

Media quality of the window's answered calls on this trunk.

pdd_ms
​integer | null · int64 · required
pdd_reason
​string | null · required
​required
window_hours
​integer · int32 · min: 0 · required

TrunkNumbers

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

Every number the trunk answers, by route or as a connection's hosted default.

routed_explicitly
​integer · int32 · min: 0 · required

The numbers routed here by route alone; a release refuses while any remain.

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

Every number the trunk answers, by route or as a connection's hosted default.

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

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

UpcomingRateTerms

​RateCallerIdRule · required
connection_fee_minor
​integer · int64 · required
effective_from
​string · date-time · required
​RateIncrement · required
rate_micro
​integer · int64 · required
route_class
​string · required
notice_days
​integer · int64 · required
published_at
​string · date-time · required

UpdateAlertPolicyRequest

channels
​array | null
Enum values:
email
webhook
in_app
sms
enabled
​boolean | null
​
​
​

UpdateByocConnectionRequest

The connection's own settings. Peers, sources and passwords belong to their item routes, so a body naming any of them is refused rather than ignored.
attempt_deadline_seconds
​integer · int32 · min: 0 · required

How long the whole attempt across every peer may take; more than the peer timeout.

​ByocCeilings · required
direction
​ByocConnectionDirection · enum · required
Enum values:
inbound
outbound
both
failover_sip_codes
​integer[] · required

The SIP codes, 400 to 699, that move a call to the next peer.

g729
​boolean · required

G.711 (PCMA and PCMU) is always offered; true also offers G.729.

identity_policy
​ByocIdentityPolicy · enum · required
Enum values:
from_only
from_and_pai
media_security
​ByocMediaSecurity · enum · required
Enum values:
rtp
sdes_srtp_required
name
​string · required
number_format
​ByocNumberFormat · enum · required
Enum values:
e164_plus
e164
national
peer_timeout_seconds
​integer · int32 · min: 0 · required

How long one peer has to answer before the call moves to the next peer.

privacy_passthrough
​boolean · required
strip
​integer · int32 · min: 0 · max: 14 · required

Leading digits removed from the dialled number before it is sent to the carrier.

inbound_trunk_id
​string | null

The trunk that rings this connection's numbers: a trunk of this project that takes inbound calls. Required unless direction is outbound, where a trunk is refused.

subaccount_id
​string | null
tech_prefix
​string | null

One to fifteen digits put before the dialled number sent to the carrier.

UpdateByocIngressSourceRequest

A public IPv4 network of /24 or narrower, with whether it is accepted.
cidr
​string · required
enabled
​boolean · required

UpdateByocPeerRequest

The peer's settings in full, with whether it takes calls.
enabled
​boolean · required
host
​string · required
port
​integer · int32 · min: 0 · required
priority
​integer · int32 · required
transport
​ByocPeerTransport · enum · required
Enum values:
udp
tcp
tls
weight
​integer · int32 · required

UpdateSubaccountRequest

​
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

UpdateVoiceApplicationRequest

​
fallback_url
​string | null · uri
name
​string | null
​
status_callback_url
​string | null · uri
​
voice_url
​string | null · uri

UpdateWebhookEndpointRequest

Every field is optional and at least one is required; a field left out keeps its value.
events
​array | null
failover_url
​string | null · uri

Null clears the failover URL; leaving the field out keeps it.

is_active
​boolean | null
timeout_seconds
​integer | null · int32 · min: 0
url
​string | null · uri

UsageAmounts

calls_minor
​integer · int64 · required
numbers_minor
​integer · int64 · required
promotional_credit_minor
​integer · int64 · required
recording_minor
​integer · int64 · required
settling_minor
​integer · int64 · required
total_minor
​integer · int64 · required
voice_minor
​integer · int64 · required

UsageDay

​UsageProductAmount[] · required
date
​string · date · required
partial
​boolean · required
total_minor
​integer · int64 · required

UsageDimension

string · enum
Enum values:
day
product
trunk
subaccount
destination
number_block
category
sku

UsageProductAmount

amount_minor
​integer · int64 · required
product
​UsageSourceProduct · enum · required

Usage folds numbers, recordings and platform charges into trunking.

Enum values:
trunking
voice
automation

UsageQuantity

billable_seconds
​integer · int64 · min: 0 · required
calls
​integer · int64 · min: 0 · required
numbers
​integer · int64 · min: 0 · required
observed_seconds
​integer · int64 · min: 0 · required
recorded_seconds
​integer · int64 · min: 0 · required

UsageRate

atoms_per_unit
​integer · int64 · required
connection_fee_minor
​integer | null · int64 · required
offer_id
​string · required
price_id
​string | null · uuid · required
quantity_increment_atoms
​integer · int64 · required
quantity_minimum_atoms
​integer · int64 · required
sku_code
​string · required
unit
​string · required
unit_price_minor
​integer · int64 · required

UsageRow

​UsageAmounts · required
detail
​string | null · required
dimension
​UsageDimension · enum · required
Enum values:
day
product
trunk
subaccount
destination
number_block
category
sku
key
​string · required
label
​string · required
parent_key
​string | null · required
​UsageQuantity · required
​required
​required

UsageScope

id
​string · required
name
​string · required

UsageScopes

​UsageScope[] · required
​UsageScope[] · required

UsageSourceProduct

string · enum
Enum values:
trunking
voice
automation

Usage folds numbers, recordings and platform charges into trunking.

UsageState

text
​string · required
tone
​string · required

UsageSummary

as_of
​string · date-time · required
​UsageProductAmount[] · required
currency
​string · required
​UsageDay[] · required
dimension
​UsageDimension · enum · required
Enum values:
day
product
trunk
subaccount
destination
number_block
category
sku
​required
​required
​required
​UsageQuantity · required
row_count
​integer · int64 · min: 0 · required
​UsageRow[] · required
​UsageScopes · required
​UsageAmounts · required
​UsageWindow · required

UsageWindow

days
​integer · int32 · min: 0 · required
from
​string · date · required
partial
​boolean · required
to
​string · date · required

VoiceAccount

account_sid
​string · required
auth_token_masked
​string · required
call_event_history
​CallEventHistoryState · enum · required
Enum values:
enabled
disabled
desired_revision
​integer · int64 · required
effective_revision
​integer · int64 · required
key_id
​string · required
project_id
​string · required
provisioning_status
​VoiceProvisioningStatus · enum · required
Enum values:
pending
applying
applied
partially_applied
failed
status
​VoiceAccountStatus · enum · required
Enum values:
pending
active
revoked

VoiceAccountStatus

string · enum
Enum values:
pending
active
revoked

VoiceApplication

created_at
​string · date-time · required
desired_revision
​integer · int64 · required
effective_revision
​integer · int64 · required
​required
fallback_url
​string | null · uri · required
id
​string · required
name
​string · required
numbers_pointed
​integer · int64 · required
project_id
​string · required
provisioning_status
​VoiceProvisioningStatus · enum · required
Enum values:
pending
applying
applied
partially_applied
failed
revision
​integer · int64 · required
​required
status_callback_url
​string | null · uri · required
updated_at
​string · date-time · required
voice_method
​VoiceHttpMethod · enum · required
Enum values:
GET
POST
voice_url
​string · uri · required

VoiceApplicationList

​VoiceApplication[] · required

VoiceHttpMethod

string · enum
Enum values:
GET
POST

VoiceProvisioningStatus

string · enum
Enum values:
pending
applying
applied
partially_applied
failed

WebhookDelivery

attempt
​integer · int32 · required
attempted_at
​string · date-time · required
call_sequence
​integer | null · int64 · required
duration_ms
​integer | null · int32 · required
endpoint_id
​string · required
endpoint_url
​string · uri · required
error
​string | null · required
event_id
​string · required
event_type
​string · required
id
​string · required
max_attempts
​integer · int32 · required
next_retry_at
​string | null · date-time · required
replay_request_id
​string | null · required
replay_requested_by
​string | null · required
replayable_until
​string | null · date-time · required
​required
result
​WebhookDeliveryResult · enum · required
Enum values:
delivered
retrying
exhausted
status_code
​integer | null · int32 · required

WebhookDeliveryAttempt

attempt
​integer · int32 · required
attempted_at
​string | null · date-time · required
duration_ms
​integer | null · int32 · required
error
​string | null · required
response_excerpt
​string | null · required
scheduled_for
​string | null · date-time · required
status_code
​integer | null · int32 · required
target
​WebhookDeliveryTarget · enum · required
Enum values:
primary
failover

WebhookDeliveryDetail

attempt
​integer · int32 · required
attempted_at
​string · date-time · required
call_sequence
​integer | null · int64 · required
duration_ms
​integer | null · int32 · required
endpoint_id
​string · required
endpoint_url
​string · uri · required
error
​string | null · required
event_id
​string · required
event_type
​string · required
id
​string · required
max_attempts
​integer · int32 · required
next_retry_at
​string | null · date-time · required
replay_request_id
​string | null · required
replay_requested_by
​string | null · required
replayable_until
​string | null · date-time · required
​required
result
​WebhookDeliveryResult · enum · required
Enum values:
delivered
retrying
exhausted
status_code
​integer | null · int32 · required
​WebhookDeliveryAttempt[] · required
request_body
​string · required
​object · required
response_excerpt
​string | null · required
​object | null · required

WebhookDeliveryList

​WebhookDelivery[] · required

WebhookDeliveryResource

id
​string · required
label
​string | null · required
type
​string · required

WebhookDeliveryResult

string · enum
Enum values:
delivered
retrying
exhausted

WebhookDeliveryTarget

string · enum
Enum values:
primary
failover

WebhookEndpoint

created_at
​string · date-time · required
created_by
​string | null · required
disabled_at
​string | null · date-time · required
disabled_reason
​string | null · required
events
​string[] · required
failover_url
​string | null · uri · required
​WebhookEndpointHealth · required
id
​string · required
is_active
​boolean · required
previous_retires_at
​string | null · date-time · required
retained_events
​integer | null · int64 · min: 0 · required
retention_ends_at
​string | null · date-time · required
​WebhookEndpointScope · required
secret_hint
​string · required
secret_rotated_at
​string · date-time · required
timeout_seconds
​integer · int32 · min: 0 · required
url
​string · uri · required

WebhookEndpointHealth

attempts
​integer · int64 · min: 0 · required
delivered
​integer · int64 · min: 0 · required
exhausted
​integer · int64 · min: 0 · required
failing_since
​string | null · date-time · required
failover_attempts
​integer | null · int64 · min: 0 · required
failover_delivered
​integer | null · int64 · min: 0 · required
last_attempt_at
​string | null · date-time · required
last_error
​string | null · required
last_status_code
​integer | null · int32 · min: 0 · required
p50_ms
​integer | null · int32 · min: 0 · required
p95_ms
​integer | null · int32 · min: 0 · required
p99_ms
​integer | null · int32 · min: 0 · required
recent_attempts
​integer · int64 · min: 0 · required
recent_failures
​integer · int64 · min: 0 · required
retrying
​integer · int64 · min: 0 · required
status
​WebhookEndpointHealthStatus · enum · required
Enum values:
healthy
degraded
disabled
window_hours
​integer · int32 · min: 0 · required

WebhookEndpointHealthStatus

string · enum
Enum values:
healthy
degraded
disabled

WebhookEndpointList

​WebhookEndpoint[] · required

WebhookEndpointScope

id
​string | null · required
name
​string | null · required
type
​WebhookEndpointScopeType · enum · required
Enum values:
organization
trunk
subaccount
automation

WebhookEndpointScopeType

string · enum
Enum values:
organization
trunk
subaccount
automation

WebhookReplayPreview

events
​integer · int64 · min: 0 · required
rate_per_second
​integer · int32 · min: 0 · required
window_from
​string · date-time · required
window_to
​string · date-time · required

WebhookReplayQueued

replay_request_id
​string · required

WebhookTestCheck

detail
​string · required
duration_ms
​integer | null · int32 · min: 0 · required
outcome
​WebhookTestOutcome · enum · required
Enum values:
ok
failed
skipped
step
​WebhookTestStep · enum · required
Enum values:
dns
connect
tls
request
response
failover

WebhookTestOutcome

string · enum
Enum values:
ok
failed
skipped

WebhookTestResult

​WebhookTestCheck[] · required
delivery_id
​string · required
event_id
​string · required
request_body
​string · required
status_code
​integer | null · int32 · min: 0 · required

WebhookTestStep

string · enum
Enum values:
dns
connect
tls
request
response
failover