Signals Docs
Platform
Platform

Schemas

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

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

CatalogCurrency

string · enum
Enum values:
NGN

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:
spend_velocity
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:
spend_velocity
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

CreateSubaccountRequest

​SubaccountConfigurationInput · required
name
​string · required

NumberBlockConsumer

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

PendingPayer

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

PlatformEndpoints

as_of
​string · date-time · required
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

PlatformSignalingTransport

string · enum
Enum values:
udp
tcp
tls

PlatformTls

realm
​string · required
trust_chain
​string[] · required

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
​ProjectRef[]
caused_by
​string
changed_resources
​string[]
expensive_filter
​string
reason
​string
remediation
​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

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

UpdateAlertPolicyRequest

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

UpdateSubaccountRequest

​
name
​string | null