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 Short Codes API

Manage short codes for SMS and MMS messaging.

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

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

This API exposes 3 operations across 2 paths, and defines 16 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.

3 operations 2 paths 16 schemas 2 GET1 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 Short Codes 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 3

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

Short Codes 3

Manage short codes for SMS and MMS messaging.

GET
/api/relay/rest/short_codes
List short codes
list_short_codes 5 params → 200400401500
GET
/api/relay/rest/short_codes/{id}
Get short code
retrieve_short_code 1 param → 200401404422500
PUT
/api/relay/rest/short_codes/{id}
Update short code
update_short_code 1 param body → 200401404422500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ShortCode (18 properties), ShortCodeResponse (18 properties), UpdateShortCodeRequest (8 properties), Types.StatusCodes.SpaceApiErrorItem (4 properties). Each schema is shown below with its type and property counts.

Types.StatusCodes.StatusCode401
object
Access is unauthorized.
1 property 1 required
ShortCodeType
string
Short code type.
Types.StatusCodes.StatusCode400
object
The request is invalid.
1 property 1 required
HttpMethod
string
HTTP method type.
uuid
string
Universal Unique Identifier.
Types.StatusCodes.StatusCode404
object
The server cannot find the requested resource.
1 property 1 required
UpdateShortCodeRequest
object
Request body for updating a short code.
8 properties 2 required
Types.StatusCodes.StatusCode500
object
An internal server error occurred.
1 property 1 required
PaginationLinks
object
Pagination links for list responses.
4 properties 2 required
ShortCodeResponse
object
Response containing a single short code.
18 properties 18 required
Types.StatusCodes.ValidationError
object
The request failed validation. See errors for details.
1 property 1 required
ShortCodeListResponse
object
Response containing a list of short codes.
2 properties 2 required
Types.StatusCodes.SpaceApiErrorItem
object
Details about a specific validation error.
4 properties 4 required
ShortCodeCapability
string
Short code capabilities.
ShortCodeMessageHandler
string
Message handler type for short codes.
ShortCode
object
Short code model.
18 properties 18 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signalwire-short-codes-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 Short Codes 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.