API reference
Every endpoint
801 operations in 46 groups, generated from the API's own route table. Open a group for parameters, schemas, code in cURL, Node.js and Python, and a console to run each request with a test key.
BrowseAll groups
Authentication19
- POSTCreate an account
- POSTLog in with email and password
- POSTComplete a two-factor login
- POSTRefresh an access token
- POSTLog out the current session
- GETList your active sessions
- DELETESign out one session
- POSTSign out every other session
- POSTVerify your email address
- POSTConfirm an email address change
- POSTResend the verification email
- POSTRedeem an invite code after sign-up
- POSTResend a verification email by address
- POSTRequest a password reset email
- POSTReset your password with a reset token
- POSTChange your password
- GETList the social login providers that are enabled
- GETStart a social login
- GETFinish a social login (provider callback)
Account34
- GETGet your account profile
- PUTUpdate your account profile
- GETGet one headline figure per workspace
- GETGet which walkthrough steps the account has completed
- POSTRequest an email address change
- POSTConfirm an email change from a signed-in session
- GETList recent security activity
- GETExport all your account data
- POSTClose your account
- GETPreview what closing the account would take
- POSTSave your onboarding goal
- GETGet your balance and test credit
- GETGet your Switch plan and trial status
- POSTStart a Switch subscription checkout
- GETGet your Switch free-trial application
- POSTApply for a Switch free trial
- POSTOpen the Switch billing portal
- POSTStart two-factor authentication setup
- POSTTurn on two-factor authentication
- POSTTurn off two-factor authentication
- GETGet your spend alert settings
- PUTUpdate your spend alert settings
- GETList your saved marketplace searches
- POSTSave a marketplace search
- DELETEDelete a saved search
- GETList your favorite routes
- POSTAdd a route to your favorites
- DELETERemove a route from your favorites
- GETList your dedicated IP addresses
- GETGet your SIP interconnect details
- GETGet your connectivity brief
- POSTTake a dedicated ingress IP
- POSTTake a dedicated egress IP
- POSTRelease a dedicated IP
API keys4
API usage1
Webhooks10
- GETList your webhook endpoints
- POSTCreate a webhook endpoint
- PATCHUpdate a webhook endpoint
- DELETEDelete a webhook endpoint
- POSTRotate a webhook signing secret
- POSTSend a test ping to a webhook endpoint
- GETList deliveries for one webhook endpoint
- GETList webhook deliveries across all your endpoints
- GETGet one webhook delivery, with its payload
- POSTResend a webhook delivery
Marketplace routes43
- GETBrowse the route marketplace
- POSTList a new route for sale
- GETGet marketplace totals for a filter
- GETPrice a phone number across the marketplace
- GETList destinations on the marketplace
- GETGet a route
- PUTUpdate a route you listed
- DELETEDelete a route you listed
- POSTDraft a listing from a rate sheet
- POSTTest an endpoint before listing a route
- GETList your call-centre routes and their call screening
- GETGet call screening settings, stats and flagged calls
- PATCHTurn call screening on or off for a route
- POSTClassify a sample transcript with call screening
- GETList your saved listing presets
- PUTSave a listing preset
- DELETEDelete a listing preset
- GETPreview the listings publishing a deck will create
- GETList your recently deleted routes
- POSTRestore a deleted route
- GETList your saved SIP endpoints
- POSTSave a SIP endpoint
- PATCHLabel a saved SIP endpoint
- DELETERemove a saved SIP endpoint
- GETPreview which route would carry a destination
- POSTTest connectivity to your route endpoint
- POSTCapture a SIP trace of a test call on a route
- GETGet a route's price history
- GETGet traffic and revenue stats for your route
- GETList the routes you sell
- GETCount your SMS routes hidden for lack of an endpoint
- POSTSet one delivery endpoint on all your endpoint-less SMS routes
- GETCount your listed routes that are live, and why the rest are hidden
- POSTSet one SMS delivery method on many of your SMS routes
- POSTSet one SIP endpoint on many of your voice routes
- GETGroup the routes you sell by endpoint or by A-Z deck
- GETCheck whether your switches are refusing our calls
- GETList the buyers of your route
- GETShow the billing increments your rate sheet sets
- POSTRead a rate sheet into a draft listing (no account needed)
- POSTSave a draft listing to claim after sign-up
- GETLook at a saved draft listing
- POSTCreate a route from a saved draft listing
Route checks7
Rate sheets21
- GETList rate-sheet imports for a route
- POSTUpload a rate sheet to a route
- POSTUpload and apply a rate sheet in one step
- GETGet a rate-sheet import
- POSTPreview a rate-sheet import
- POSTCompare a rate-sheet import with the live deck
- POSTApply a rate-sheet import
- POSTRoll a route back to an earlier rate-sheet import
- POSTReapply a rate-sheet import with new settings
- POSTPublish an A-Z deck as per-country listings
- POSTCollapse per-country listings back into one deck
- GETList the per-country listings of a deck
- GETList per-destination rates on a route
- POSTAdd a rate to your route's deck
- GETExport a route's rates as CSV
- POSTAdd many rates to your route's deck
- PATCHEdit or block one rate in your deck
- DELETEDelete one rate from your deck
- GETList scheduled rate changes on your route
- POSTSchedule a price change on a one-price route
- POSTWithdraw a scheduled rate change
Route blends7
Purchases14
- GETList your route purchases
- POSTBuy access to a marketplace route
- GETGet your voice routing order
- PUTReplace your voice routing order
- GETSee your first-choice and backup routes per destination
- GETSee which of your routes would carry a number
- PATCHSet a purchase's routing position
- DELETEClear a purchase's routing position
- GETGet a purchase
- PATCHPause or resume a purchase
- DELETECancel a purchase
- GETGet call counts, ASR and spend for a purchase
- POSTAccept a seller's rate increase
- GETList scheduled rate changes on a route you bought
Offers7
Route access6
Route messages3
Route reports10
- GETList route problem reports you raised or received
- POSTReport a problem with a route you bought
- GETCount route reports waiting on you
- GETGet a route report with its thread
- POSTReply on a route report
- POSTAcknowledge a route report (seller)
- POSTMark a route report resolved (seller)
- POSTConfirm a route report is fixed (buyer)
- POSTReopen a resolved route report (buyer)
- POSTEscalate a route report to support
Markets3
Voice and SMS7
Verify5
Number lookup1
Phone numbers52
- GETBrowse the number catalogue
- GETList countries with numbers for sale
- GETList number types for sale
- POSTBuy a phone number
- GETList your phone numbers
- GETGet your request to list numbers on the marketplace
- POSTAsk to list your numbers on the marketplace
- GETList your numbers usable as outbound caller IDs
- POSTAdd your numbers to a dialer caller-ID set
- GETGet one of your phone numbers
- GETGet a number's call flow
- PUTReplace a number's call flow
- PATCHPoint a number at one destination (and an optional backup)
- GETList a number's softphone lines
- POSTCreate a softphone line on a number
- POSTReveal a softphone line's login
- DELETEDelete a softphone line
- PATCHTurn monthly auto-renew on or off
- GETList inbound calls to a number
- GETSee which AI voice agent answers a number
- PUTPoint a number at an AI voice agent
- GETGet a number's voicemail, recording, IVR and schedule settings
- PUTConfigure voicemail on a number
- PUTConfigure call recording on a number
- PUTConfigure the IVR menu on a number
- PUTConfigure business-hours routing on a number
- GETList a number's uploaded greetings
- POSTUpload a voicemail or IVR greeting
- GETDownload a greeting's audio
- DELETEDelete a greeting
- GETList call recordings on a number
- GETDownload a call recording
- DELETEDelete a call recording
- GETList voicemails on a number
- GETDownload a voicemail
- POSTMark a voicemail heard or unheard
- DELETEDelete a voicemail
- POSTRelease a phone number
- GETGet a number's SMS settings
- PUTUpdate a number's SMS settings
- GETList SMS conversations on a number
- GETList SMS messages on a number
- POSTSend an SMS from one of your numbers
- POSTMark an SMS conversation read
- GETSearch the catalogue by digit pattern or vanity run
- POSTBuy several phone numbers in one request
- GETGet a spend and usage overview across your numbers
- GETGet spend and usage analytics for a number
- GETBrowse the public number catalogue
- GETNumber catalogue market summary
- GETList countries in the public number catalogue
- GETList number types in the public number catalogue
Billing22
- GETList ledger transactions
- GETGet your spending and earnings summary
- GETGet seller earnings broken down by route
- GETGet your outbound usage grouped by destination country
- GETGet your end-of-day balance history
- GETGet daily voice and SMS spend
- GETList your call and message records
- GETStream your call records as CSV
- GETList your call-record exports
- POSTStart a background call-record export
- GETDownload a finished call-record export
- GETList your receipts and statements
- GETGet a receipt or statement
- GETGet your monthly statement
- GETGet the financial position of your wallet or a sub-account
- GETList live call authorisations on a wallet
- GETReconcile a wallet balance against its ledger
- GETList posted, pending and unposted money movements
- GETList sub-account wallets you operate with their positions
- GETList your tax invoices
- POSTGenerate the tax invoice for a month
- GETGet a tax invoice
Top-ups13
- GETList your top-ups
- POSTStart a card top-up
- POSTTop up with an x402 USDC payment
- POSTStart a crypto top-up
- POSTStart a wire-transfer top-up
- GETList available top-up methods and their limits
- POSTStart saving a card for auto-recharge
- GETList your saved cards
- POSTSet your default card
- DELETERemove a saved card
- GETGet your auto-recharge settings
- PUTUpdate your auto-recharge settings
- GETList your pending top-ups with payment instructions
Payouts2
Dialer49
- POSTAsk the dialer assistant a question or give it an instruction
- GETGet dialer analytics across all your campaigns
- GETGet detailed analytics for one campaign
- GETList your dialer and SMS campaigns
- POSTCreate a dialer or SMS campaign
- GETGet a campaign
- PUTUpdate a campaign
- DELETEDelete a campaign
- POSTStart, pause or stop a campaign
- POSTMark a draft campaign ready to start
- GETGet live progress and spend for a campaign
- POSTParse a contact file and suggest a column mapping
- POSTImport mapped contacts into a campaign or a saved list
- GETList a campaign’s numbers with their call outcome
- POSTAdd destination numbers to a campaign
- DELETERemove every number from a campaign
- DELETERemove one number from a campaign
- GETList a campaign’s caller IDs
- POSTAdd caller IDs to a campaign
- DELETERemove every caller ID from a campaign
- GETList your caller-ID sets
- POSTCreate a caller-ID set
- GETGet a caller-ID set
- PATCHRename or describe a caller-ID set
- DELETEDelete a caller-ID set
- GETList the caller IDs in a set, with usage stats
- POSTAdd caller IDs to a set
- POSTAdd your revenue share numbers to a caller-ID set
- PATCHUpdate one caller ID in a set
- DELETERemove one caller ID from a set
- POSTEnable, disable or delete many caller IDs in a set
- GETGet usage stats for a caller-ID set
- PUTAssign a caller-ID set and rotation strategy to a campaign
- POSTBuild a call-back list from callers to your revenue share numbers
- GETMatch inbound callers to the caller IDs in a set
- POSTMatch inbound callers to a caller-ID set and optionally save them
- POSTPreview a cleaned number list
- POSTSave numbers as a contact list
- GETList your SMS templates
- POSTCreate an SMS template
- PATCHUpdate an SMS template
- DELETEDelete an SMS template
- GETList your saved contact lists
- POSTCreate a saved contact list
- GETGet a saved contact list with its numbers
- DELETEDelete a saved contact list
- GETList your simple caller-ID lists
- POSTCreate a simple caller-ID list
- DELETEDelete a simple caller-ID list
AI voice agents9
- GETList your AI voice agents
- POSTCreate an AI voice agent
- GETList the voices an agent can speak with
- POSTHear a voice speak a short line
- POSTDraft an agent from a plain-English description
- GETGet an AI voice agent
- PATCHUpdate an AI voice agent
- DELETEDelete an AI voice agent
- POSTSimulate one conversation turn with an agent
CLI tests13
- GETList your caller-ID tests
- POSTRun a caller-ID test on a route
- GETCheck whether handset caller-ID testing is available
- GETList the countries with test handsets online
- GETGet your caller-ID test quota and price
- POSTPreview a route liveness test before starting it
- GETList your route liveness tests
- POSTStart a route liveness test on several routes
- GETGet a route liveness test and each route's result
- POSTCancel a running route liveness test
- POSTTest a caller ID on your own switch
- GETGet a caller-ID test and its result
- POSTCancel a pending or scheduled caller-ID test
Do not call5
Interconnections11
- GETList your whitelisted source IPs
- POSTWhitelist a source IP for your traffic
- DELETERemove a whitelisted source IP
- GETList your interconnections
- GETGet an interconnection
- PUTUpdate an interconnection
- PUTSet delivery-receipt settings on an SMS interconnection
- POSTTest connectivity on a purchased route
- GETGet a summary of your interconnect setup
- GETGet live connection health per purchase
- POSTRotate the SIP and SMPP credentials on a purchase
Connections8
- GETLook up the account behind a connect code
- GETGet your connect code
- POSTRotate your connect code
- POSTConnect with another account by its code
- GETList your connections
- GETGet a connection with the routes each side can see
- DELETERemove a connection
- POSTShare or stop sharing your private routes with a connection
Switch3
Switch: customers61
- GETGet a Switch customer routing assignment
- POSTAssign routing to a Switch customer
- GETList a Switch customer trunks with traffic
- POSTAdd a trunk to a Switch customer
- GETList your Switch customers with live and 24-hour figures
- POSTCreate a Switch customer
- GETGet a Switch customer command-centre overview
- GETGet a Switch customer
- PATCHUpdate a Switch customer
- DELETEDelete a draft Switch customer
- GETGet a Switch customer lifecycle state and financial position
- POSTActivate, suspend, reactivate, close or reopen a Switch customer
- GETList a Switch customer lifecycle history
- POSTRotate a Switch customer inbound SIP password
- GETReveal a Switch customer inbound SIP credentials
- GETList what needs attention on a Switch customer
- GETList operational issues on a Switch customer
- GETList a Switch customer contacts
- POSTAdd a Switch customer contact
- PATCHUpdate a Switch customer contact
- DELETEDelete a Switch customer contact
- GETList internal notes on a Switch customer
- POSTAdd an internal note to a Switch customer
- PATCHEdit, pin or flag a Switch customer note
- DELETEDelete a Switch customer note
- GETGet per-destination quality for a Switch customer
- GETDrill into one destination for a Switch customer
- GETGet a Switch customer receivables summary
- GETGet a Switch customer credit position
- GETPreview how a payment would be allocated to invoices
- POSTRecord a payment received from a Switch customer
- POSTReverse a recorded Switch customer payment
- POSTPreview an invoice for a Switch customer unbilled period
- POSTIssue the reviewed invoice for a Switch customer
- GETGet a Switch customer billing profile
- PUTSave a Switch customer billing profile
- GETGet a Switch customer default sell deck and each trunk's deck
- PUTSet a Switch customer default sell deck
- POSTEmail a Switch customer a portal sign-in link
- GETList a Switch customer sell rates with buy cost and margin
- POSTAdd or replace one Switch customer sell rate
- GETCount a Switch customer sell rates by view
- GETList upcoming sell-rate starts and ends for a Switch customer
- GETGet a Switch customer rate-change notice period and what is queued
- PUTSet a Switch customer rate-change notice period
- GETList a Switch customer queued sell-rate changes
- GETDownload a Switch customer queued sell-rate changes as CSV
- POSTEmail a Switch customer a rate-change notice
- POSTPreview discontinuing a Switch customer whole sell deck
- POSTDiscontinue a Switch customer whole sell deck
- POSTDiscontinue one Switch customer sell rate
- GETList sell-rate discontinuation events for a Switch customer
- POSTReprice a Switch customer deck as a markup over buy cost
- GETExport a Switch customer sell rates as CSV
- POSTAdd or replace many Switch customer sell rates
- DELETEDiscontinue one Switch customer sell rate now
- POSTDiscontinue every Switch customer sell rate now
- GETList scheduled (future-dated) sell rates for a Switch customer
- POSTSchedule a future Switch customer sell-rate change
- DELETECancel a scheduled Switch customer sell rate
- POSTSet a Switch customer billing cycle and payment terms
Switch: customer trunks48
- GETList the trunk authentication methods available to you
- PATCHUpdate a Switch customer trunk
- DELETEDelete an unused Switch customer trunk
- GETShow the configuration actually in force on a trunk
- POSTArchive a Switch customer trunk
- POSTRestore an archived Switch customer trunk
- GETPreview what disabling, enabling or archiving a trunk would do
- GETCheck whether a Switch customer trunk can be deleted
- POSTClone a Switch customer trunk
- GETList a trunk's allowed source addresses
- POSTAllow a source address on a trunk
- GETList a trunk's addresses with overlaps and customer-level entries
- POSTPreview an address before allowing it on a trunk
- POSTTest a caller-ID rewrite rule against a sample number
- DELETERemove an allowed source address from a trunk
- POSTSet routing on a Switch customer trunk
- GETShow the route wired up for a trunk
- GETReveal a Switch customer trunk's SIP credentials
- GETGet a trunk's credential history and last successful authentication
- POSTRecord that a trunk credential was copied
- POSTReplace a Switch customer trunk's SIP password
- GETList trunk configuration changes awaiting or after review
- POSTApprove and apply a trunk configuration change
- POSTReject a trunk configuration change
- POSTWithdraw your own pending trunk change
- GETGet whether supplier trunk changes need approval
- POSTTurn supplier trunk change approval on or off
- GETGet whether trunk readiness blocks first activation
- POSTTurn the trunk readiness gate on or off
- GETGet the sell deck in force on a trunk
- PUTAssign a sell deck to a trunk
- GETPreview a sell-deck assignment for a trunk
- GETList a trunk's sell rates with buy cost and margin
- POSTAdd or replace one sell rate on a trunk
- GETCount a trunk's sell rates by view
- GETList upcoming sell-rate starts and ends on a trunk
- GETList sell-rate discontinuation events on a trunk
- POSTPreview discontinuing a trunk's whole sell deck
- POSTDiscontinue a trunk's whole sell deck
- POSTDiscontinue one sell rate on a trunk
- POSTAdd or replace many sell rates on a trunk
- DELETEDiscontinue one sell rate on a trunk now
- POSTDiscontinue every sell rate on a trunk now
- GETList scheduled (future-dated) sell rates on a trunk
- POSTSchedule a future sell-rate change on a trunk
- DELETECancel a scheduled sell rate on a trunk
- POSTReprice as a markup over buy cost from a trunk
- GETExport a trunk's sell rates as CSV
Switch: suppliers66
- GETList providers with their trunks
- POSTCreate a provider
- GETGet a provider with its trunks, endpoints and contacts
- PATCHUpdate a provider
- DELETEDelete a provider
- POSTChange a provider lifecycle status
- GETList a provider contacts
- POSTAdd a provider contact
- PATCHUpdate a provider contact
- DELETEDelete a provider contact
- GETList providers with their trunks
- POSTCreate a provider
- GETGet a provider with its trunks, endpoints and contacts
- PATCHUpdate a provider
- DELETEDelete a provider
- POSTChange a provider lifecycle status
- GETList a provider contacts
- POSTAdd a provider contact
- PATCHUpdate a provider contact
- DELETEDelete a provider contact
- GETGet call totals for a provider across its trunks
- GETList a provider payables and unbilled cost
- GETList what is wrong with a provider right now
- GETGet the change history for a provider and its trunks
- GETList billing disputes with a provider
- POSTOpen a billing dispute with a provider
- PATCHUpdate a billing dispute
- GETList SIP endpoints of a supplier trunk
- POSTAdd a SIP endpoint to a supplier trunk
- PATCHUpdate a SIP endpoint
- DELETERemove a SIP endpoint
- GETRender the SBC gateway configuration for a supplier trunk
- GETRender the SBC gateway configuration for a provider
- GETList health events for a supplier trunk
- GETGet the flap report for a supplier trunk
- POSTSend a test call to a supplier trunk
- POSTMove a supplier trunk to another provider
- GETList supplier trunks
- POSTCreate a supplier trunk
- GETGet live metrics for active supplier trunks
- GETShow where a supplier trunk sits in routing
- POSTPromote a marketplace purchase to a supplier trunk
- GETReveal a supplier trunk SIP credentials
- GETGet a supplier trunk overview and today figures
- GETGet quality by destination for a supplier trunk
- GETList quality and fraud protection events for a supplier trunk
- GETGet a supplier trunk
- PATCHUpdate a supplier trunk
- DELETEDelete a supplier trunk
- GETGet the production readiness checklist for a supplier trunk
- GETList configuration versions of a supplier trunk
- GETGet one configuration version of a supplier trunk
- POSTTest a supplier trunk SMS delivery
- POSTTest unsaved SMS delivery details
- POSTEmail a supplier portal sign-in link
- GETList the cost deck in force on a supplier trunk
- POSTSet the cost for one prefix on a supplier trunk
- POSTSet costs for many prefixes on a supplier trunk
- DELETEDelete one cost row from a supplier trunk
- POSTClear the cost deck of a supplier trunk
- GETList archived cost decks of a supplier trunk
- POSTRestore an archived cost deck
- GETList scheduled cost changes on a supplier trunk
- POSTSchedule a future cost change for one prefix
- DELETECancel a scheduled cost change
- GETReview queued cost changes before they take effect
Switch: rating38
- GETAnalyse the cost and configured margin of a destination
- GETList the suppliers that can carry a customer's traffic
- GETGet realised margin over a period
- GETList per-call realised margin
- GETGet the realised margin of one call
- GETList supplier rate decks
- POSTCreate a supplier rate deck
- GETGet a supplier rate deck
- DELETEDelete a rate deck
- GETList every version of a rate deck
- GETCompare a rate deck with the prices in force
- PUTSet which supplier trunks a rate deck prices
- PUTReplace the rows of a draft rate deck
- POSTOpen a new draft version of a rate deck
- POSTValidate a rate deck
- POSTSubmit a rate deck for approval
- POSTApprove a rate deck, now or from a future date
- POSTActivate a rate deck
- POSTRoll back an active rate deck
- GETShow what a blank rating or limit field inherits
- GETList sell decks
- POSTCreate a sell deck
- GETGet a sell deck with its reach and versions
- PATCHUpdate a sell deck's name, notes or charging profile
- GETList the prices in a sell deck
- POSTReplace the prices in a draft sell deck
- POSTOpen a new draft version of a sell deck
- POSTPublish a sell deck (preview first, then confirm)
- POSTSet or clear the system default sell deck
- GETLook up the buy and sell price for a destination
- GETList your operator sell rates
- POSTAdd or update one operator sell rate
- POSTAdd or update operator sell rates in bulk
- DELETEDelete an operator sell rate
- POSTClear operator sell rates
- POSTRead a rate sheet and propose a column mapping
- POSTPreview what a rate sheet would change
- POSTApply a rate sheet to a switch deck
Switch: routing23
- GETList route groups
- POSTCreate a route group
- GETGet a route group with its suppliers
- PATCHUpdate a route group's settings
- DELETEDelete a route group
- POSTClone a route group with all its suppliers
- PUTReplace the suppliers in a route group
- GETList dialplans
- POSTCreate a dialplan
- GETGet a dialplan with its rules
- PATCHRename, describe, enable or disable a dialplan
- DELETEDelete a dialplan
- POSTClone a dialplan with all its rules
- PUTReplace the rules in a dialplan
- GETPreview how a number would route
- POSTRun a route trace for a number
- GETList saved route traces
- POSTSave a route trace
- GETGet a saved route trace
- DELETEDelete a saved route trace
- GETList inbound IP ACLs for a customer or trunk
- POSTAdd an inbound IP ACL entry
- DELETERemove an inbound IP ACL entry
Switch: CDRs and analytics26
- GETGet margin and quality totals for all traffic
- GETGet daily margin and quality figures
- GETBreak down margin and quality by customer, supplier or destination
- GETList your recent call-record exports
- POSTStart a background call-record export
- GETGet the status of a call-record export
- GETGet traffic usage for one customer
- POSTRecord that call-record details were copied
- GETGet the values available to filter call records by
- GETGet your saved call-records layout
- PUTSave your call-records layout
- GETSearch call records
- GETCount call records by filter value
- GETGet charts for the filtered call records
- GETBreak down failed calls by stage and reason
- GETGroup failed calls by the dimensions they share
- GETGet the call-filter vocabulary
- GETGet the list-filter vocabulary
- GETGet one call record with attempts, SIP trace and timeline
- GETList the supplier attempts of a call
- GETList saved call-record views
- POSTSave a call-record view
- DELETEDelete a saved call-record view
- GETGet the SIP trace of a call
- POSTRe-run routing for a call record
- GETDownload filtered call records as CSV
Switch: invoicing26
- GETList customer invoices
- POSTIssue an invoice from a reviewed preview
- POSTPreview an invoice before issuing it
- GETGet an invoice with lines, payments and history
- POSTRecord a payment received against an invoice
- POSTVoid an invoice
- POSTVoid an invoice and issue its replacement
- POSTEmail an invoice to its recipients
- GETRender an invoice as printable HTML
- GETDownload an invoice as XML
- GETDownload an invoice as PDF
- GETList credit notes
- POSTIssue a credit note to a customer
- GETGet accounts-receivable ageing
- GETList supplier payables
- POSTRaise a payable for a supplier trunk over a period
- GETGet a payable with lines and payments
- POSTRecord a payment made to a supplier
- POSTVoid a payable
- GETGet accounts-payable ageing
- GETList bilateral counterparties
- POSTCreate a bilateral counterparty
- PATCHUpdate a bilateral counterparty
- DELETEDelete a bilateral counterparty
- POSTRun netting for a counterparty over a period
- GETList netting runs
Switch: operations32
- GETSee which caller IDs are presented, and by whom
- GETSee which senders rotate through many caller IDs
- GETGet fraud screening settings
- POSTUpdate fraud screening settings
- GETList fraud screening events
- GETList what needs attention first on the switch
- GETList operational issues
- GETGet an operational issue by reference
- GETGet the history of an operational issue
- POSTAcknowledge an operational issue
- POSTAssign an operational issue to a team member
- POSTResolve an operational issue
- POSTDismiss an operational issue
- POSTReopen a resolved or dismissed operational issue
- POSTSnooze notifications for an operational issue
- GETCount fraud screening events
- GETGet the learned traffic baseline used for risk scoring
- POSTRetrain the traffic baseline from recent calls
- POSTScore the risk of a call without placing it
- GETList calls in progress
- POSTAsk AI Control a question about your switch
- GETGet Do Not Call list sizes and recent hits
- GETList Do Not Call entries
- GETList calls refused or warned by Do Not Call
- GETCheck whether a number is on a Do Not Call list
- GETList which customers and trunks honour Do Not Call
- GETGet the Do Not Call setting of a customer or trunk
- PATCHTurn Do Not Call on or off for a customer or trunk
- POSTRemove Do Not Call numbers from an uploaded list
- GETDownload a scrubbed file
- POSTAdd numbers to your Do Not Call list from a file
- GETDownload your Do Not Call list as CSV
Switch: team and audit11
- GETGet your role and permissions on the switch
- GETList team members and the available roles
- POSTAdd a team member
- PATCHChange a team member's role, scope or status
- DELETESuspend a team member
- GETSearch the switch audit history
- GETGet the values available to filter the audit history by
- GETList approval requests
- POSTApprove or reject an approval request
- GETList approval policies
- PUTSet the approval policy for a permission
Application Manager24
- GETGet reseller analytics across your sub-accounts
- GETGet your Application Manager settings
- PUTUpdate your Application Manager settings
- GETGet sub-account totals
- GETList your sub-accounts
- POSTCreate a sub-account
- POSTCreate up to 100 sub-accounts at once
- GETGet a sub-account
- PATCHUpdate a sub-account
- POSTFund a sub-account from your balance
- POSTReturn funds from a sub-account to your balance
- POSTRecord a payment a sub-account made to you
- POSTReverse a recorded sub-account payment
- GETList a sub-account's API keys
- POSTIssue an API key for a sub-account
- DELETERevoke a sub-account API key
- POSTSet a sub-account's portal email and send a sign-in link
- POSTClose a sub-account
- POSTRegenerate a sub-account SIP password
- GETGet lifetime usage for a sub-account
- GETGet analytics for one sub-account
- GETList call records for a sub-account
- GETGet a monthly statement for a sub-account
- GETExport a sub-account's call records as CSV
Revenue share numbers26
- GETBrowse the revenue share number pool
- POSTTake a revenue share number
- POSTTake one number of every available type
- POSTRelease a revenue share number back to the pool
- GETList the revenue share numbers you hold
- GETList calls to your revenue share numbers
- GETGet the public revenue share call log
- GETList the carrier paths that reach the pool
- GETList revenue share rates by number type
- GETGet your revenue share balance
- GETGet when each payout term next opens
- GETGet a revenue share earnings statement
- GETList your revenue share payout requests
- POSTRequest a revenue share payout
- GETList your IVR configurations
- POSTCreate an IVR configuration
- PATCHUpdate an IVR configuration
- DELETEDelete an IVR configuration
- POSTPreview text-to-speech audio before saving
- POSTGenerate the audio for a text-to-speech IVR
- GETPlay an IVR configuration's audio
- POSTUpload audio for an IVR
- PATCHAttach an IVR to a number you hold
- GETGet the IVR set on a number you hold
- PUTReplace the IVR set on a number you hold
- GETCompare IVR variants on a number you hold
Notifications5
Support5
Compliance6
Onboarding4
Status8
- GETGet the public status page
- GETList past incidents
- GETGet one incident with its updates
- GETSubscribe to status updates as an RSS feed
- POSTSubscribe an email address to status updates
- GETConfirm a status subscription from the email link
- GETUnsubscribe from status updates from the email link
- POSTUnsubscribe from status updates in one click