Numbers
Signals sells Nigerian numbers in blocks of consecutive numbers. Search for a block, hold it while you decide, accept its quote to buy it, then route its numbers to a trunk or a voice application. See Numbers and routing.
List assigned individual numbers
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List assigned individual numbers › Responses
Every assigned number in the project.
List owned number blocks
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List owned number blocks › Responses
Every number block the project owns.
Hold an exact number block candidate
Headers
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Hold an exact number block candidate › Request Body
endsizestartvanity_numberHold an exact number block candidate › Responses
The block is held with its quote.
block_idendexpires_atheld_atheld_byidoriginsizestartSearch currently available number blocks
query Parameters
sizeprefixpatternsdigitsmatchsetup_up_to_minorHeaders
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Search currently available number blocks › Responses
The matching block candidates with their prices.
Read an owned number block
path Parameters
block_idNumber block id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Read an owned number block › Responses
The number block with its slices and history.
assigneddetached_atendidmonthly_minorordered_atoriginentitlement marks the organization's included number: free, and never releasable.
hosted marks numbers a carrier connection brings: no quote and no Signals rental.
quarantine_untilquarantinedrevisionThe save revision the ETag quotes; send it back as If-Match.
sizeA Signals block holds 1, 10, 50, 100, 500 or 1000 numbers; a hosted block 1 to 1000.
startstatustiernext_charge_atAccept a held number quote
path Parameters
block_idNumber block id
Headers
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Accept a held number quote › Responses
The order was accepted behind a cash hold for its total; a paid order stays pending_charge until the hold is captured.
block_idcurrencyorder_idstatetotal_minorRelease a number shopping hold
path Parameters
block_idNumber block id
Headers
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Release a number shopping hold › Responses
The hold was released.
List assigned numbers in an owned block
path Parameters
block_idNumber block id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List assigned numbers in an owned block › Responses
Every assigned number in the block.
Release an owned number block; its numbers stop routing on return
path Parameters
block_idNumber block id
Headers
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Release an owned number block; its numbers stop routing on return › Request Body
endstartRelease an owned number block; its numbers stop routing on return › Responses
The block as saved, pending release.
assigneddetached_atendidmonthly_minorordered_atoriginentitlement marks the organization's included number: free, and never releasable.
hosted marks numbers a carrier connection brings: no quote and no Signals rental.
quarantine_untilquarantinedrevisionThe save revision the ETag quotes; send it back as If-Match.
sizeA Signals block holds 1, 10, 50, 100, 500 or 1000 numbers; a hosted block 1 to 1000.
startstatustiernext_charge_atList the number route slices of a block
path Parameters
block_idNumber block id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List the number route slices of a block › Responses
Every route slice in the block.
Replace selected number route slices; the routes are live on return
path Parameters
block_idNumber block id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Replace selected number route slices; the routes are live on return › Responses
The routes as saved.
List open number shopping holds
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List open number shopping holds › Responses
Every open shopping hold in the project.
Read an immutable number quote
path Parameters
quote_idQuote id
Headers
Signals-VersionThe supported API snapshot to use for this request.
Read an immutable number quote › Responses
The quote with its acceptance state.
currencyexpires_atidinitial_minormonthly_minorsetup_minorversionaccepted_atblock_idquote_hashstatusList number tiers with the project's prices
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List number tiers with the project's prices › Responses
Every number tier with the project's prices and patterns.
Read an assigned individual number
path Parameters
number_idIndividual number id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Read an assigned individual number › Responses
The individual number.
assigned_atblock_ididnumbertier