How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SignalWire Phone Numbers API

Manage phone numbers for your SignalWire project.

SignalWire Phone Numbers API is one of 80 APIs that SignalWire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Phone Numbers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 8 operations across 4 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{space_name}.signalwire.com.

8 operations 4 paths 25 schemas 2 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{space_name}.signalwire.com
Authentication
HTTP Basic, HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 2

SignalWire Phone Numbers API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (SignalWireBasicAuth). It accepts HTTP bearer tokens (SignalWireBearerAuth). By default, every request must be authenticated.

  • SignalWireBasicAuth — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed…
  • SignalWireBearerAuth — SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer follow…

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Phone Numbers 8

Manage phone numbers for your SignalWire project.

GET
/api/relay/rest/phone_numbers
List phone numbers
list_phone_numbers 5 params → 200400401500
POST
/api/relay/rest/phone_numbers
Purchase phone number
purchase_phone_number body → 200400401422500
GET
/api/relay/rest/phone_numbers/search
Search phone numbers
search_available_phone_numbers 8 params → 200401500
GET
/api/relay/rest/phone_numbers/{id}
Get phone number
retrieve_phone_number 1 param → 200401404422500
PUT
/api/relay/rest/phone_numbers/{id}
Update phone number
update_phone_number 1 param body → 200401404422500
DELETE
/api/relay/rest/phone_numbers/{id}
Release phone number
release_phone_number 1 param → 204401404422500
POST
/api/relay/rest/phone_numbers/{id}/e911_address
Assign an E911 address to a phone number
assign_e911_address 1 param body → 200401404422500
DELETE
/api/relay/rest/phone_numbers/{id}/e911_address
Remove the E911 address from a phone number
remove_e911_address 1 param → 200401404422500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are PhoneNumber (41 properties), PhoneNumberResponse (41 properties), UpdatePhoneNumberRequest (30 properties), AvailablePhoneNumber (6 properties). Each schema is shown below with its type and property counts.

Types.StatusCodes.StatusCode401
object
Access is unauthorized.
1 property 1 required
PurchasePhoneNumberRequest
object
Request body for purchasing a phone number.
1 property 1 required
PhoneNumberType
string
Phone number type.
Types.StatusCodes.StatusCode400
object
The request is invalid.
1 property 1 required
AssignE911AddressRequest
object
Request body for assigning an E911 address to a phone number.
1 property 1 required
HttpMethod
string
HTTP method type.
AvailablePhoneNumbersResponse
object
Response containing available phone numbers for purchase.
2 properties
uuid
string
Universal Unique Identifier.
Types.StatusCodes.StatusCode404
object
The server cannot find the requested resource.
1 property 1 required
PhoneNumberMessageHandler
string
Message handler type for phone numbers.
Types.StatusCodes.StatusCode500
object
An internal server error occurred.
1 property 1 required
PhoneNumberListResponse
object
Response containing a list of phone numbers.
2 properties 2 required
PaginationLinks
object
Pagination links for list responses.
4 properties 2 required
PhoneNumberE911Status
string
E911 provisioning status of a phone number.
PhoneNumberResponse
object
Response containing a single phone number.
41 properties 41 required
CallReceiveMode
string
Call receive mode.
Types.StatusCodes.ValidationError
object
The request failed validation. See errors for details.
1 property 1 required
Types.StatusCodes.SpaceApiErrorItem
object
Details about a specific validation error.
4 properties 4 required
PhoneNumberCapabilities
object
Phone number capabilities.
4 properties
PhoneNumberCallHandlerRequest
string
Call handler type for phone number update requests. Excludes handlers that can only be set via Fabric API.
PhoneNumberCallHandler
string
Call handler type for phone numbers.
UpdatePhoneNumberRequest
object
Request body for updating a phone number.
30 properties
PhoneNumber
object
Phone number model.
41 properties 41 required
AvailablePhoneNumber
object
Available phone number for purchase.
6 properties 1 required
PhoneNumberCapability
string
Phone number capability.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signalwire-phone-numbers-api-openapi.yml Raw ↑

Other APIs SignalWire publishes across the network.

SignalWire Calling API (JSON-RPC)
SignalWire Accounts API
SignalWire Addresses API
SignalWire AI Agents: Custom API
SignalWire AI Agents: Dialogflow API
SignalWire AI Chat API
SignalWire AI Webhooks API
SignalWire Applications API
SignalWire Available Phone Numbers API
SignalWire Call Flows API
SignalWire Calling Webhooks API
SignalWire Calls API
Where this information came from

This is an independent, third-party profile of SignalWire Phone Numbers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.