Signals Docs
Calls and recordings
Calls and recordings

Schemas

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

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
​required
​CallTermination · required
to_number
​string · required
​required
​CallBilling · required
​required
carrier_leg_ref
​string | null · required
carrier_route
​string | null · required
carrier_sip_summary
​string | null · required
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

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
state
​RecordingLifecycleState · enum · required
Enum values:
pending
capturing
stored
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

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

CapturePrice

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

NumberBlockConsumer

count
​integer · int32 · min: 0 · required
id
​string · required
name
​string · required
type
​string · 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

ProjectRef

id
​string · required
name
​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
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
failed
deleting
deleted

RecordingFormat

string · enum
Enum values:
mp3
wav

RecordingLifecycleState

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

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

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