Signals Docs
Numbers
Numbers

Schemas

AcceptNumberOrderRequest

quote_hash
​string · required
quote_id
​string · required

AdjacentNumberInventory

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

CatalogCurrency

string · enum
Enum values:
NGN

CreateNumberDelegationRequest

end
​string · required
size
​NumberDelegationSize · enum · int32 · required
Enum values:
100
500
1000
start
​string · required
subtrunk_id
​string · required

CreateNumberHoldRequest

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

IndividualNumber

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

​required
​required
status
​NumberRouteStatus · enum · required
Enum values:
pending
applying
applied
failed

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

NumberBlockConsumer

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

NumberBlockDetail

​required
assigned
​integer · int32 · min: 0 · required
currency
​CatalogCurrency · enum · required
Enum values:
NGN
delegated
​integer · int32 · min: 0 · required
detached_at
​string | null · date-time · required
end
​string · required
id
​string · required
monthly_minor
​integer · int64 · required
ordered_at
​string · date-time · required
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
​NumberBlockSize · enum · int32 · required
Enum values:
10
50
100
500
1000
start
​string · required
status
​NumberBlockStatus · enum · required
Enum values:
reserved
active
pending_release
quarantined
tier
​string · required
​NumberDelegation[] · required
next_charge_at
​string | null · date-time · required
​required
​NumberAuditEntry[] · required
​NumberRouteSlice[] · required
​required

NumberBlockList

​NumberBlockSummary[] · required

NumberBlockSize

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

NumberBlockStatus

string · enum
Enum values:
reserved
active
pending_release
quarantined

NumberBlockSummary

​required
assigned
​integer · int32 · min: 0 · required
currency
​CatalogCurrency · enum · required
Enum values:
NGN
delegated
​integer · int32 · min: 0 · required
detached_at
​string | null · date-time · required
end
​string · required
id
​string · required
monthly_minor
​integer · int64 · required
ordered_at
​string · date-time · required
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
​NumberBlockSize · enum · int32 · required
Enum values:
10
50
100
500
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:
10
50
100
500
1000
start
​string · required
tier
​string · required
​NumberTierQuote[] · required
vanity_number
​string | null · required

NumberCandidateList

​NumberCandidate[] · required

NumberDelegation

assigned_at
​string · date-time · required
end
​string · required
id
​string · required
size
​NumberDelegationSize · enum · int32 · required
Enum values:
100
500
1000
start
​string · required
​NumberTarget · required

NumberDelegationSize

integer · enum · int32
Enum values:
100
500
1000

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:
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
subtrunk
voice_application
automation

NumberRouteFailure

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

NumberRouteList

​NumberRouteSlice[] · required

NumberRouteSlice

count
​integer · int32 · min: 0 · required
​required
​required
end
​string · required
​required
start
​string · required
status
​NumberRouteSliceStatus · enum · required
Enum values:
pending
applied
failed

NumberRouteSliceStatus

string · enum
Enum values:
pending
applied
failed

NumberRouteStatus

string · enum
Enum values:
pending
applying
applied
failed

NumberRouteTargetInput

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

NumberRouteTargetKindInput

string · enum
Enum values:
trunk
subtrunk
voice_application

NumberTarget

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

NumberTargetKind

string · enum
Enum values:
trunk
subtrunk
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

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

ReleaseNumberBlockRequest

end
​string · required
start
​string · required

ReplaceNumberRoutesRequest

​NumberRouteChangeInput[] · required