Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex PSTN API

The PSTN API from Webex — 6 operation(s) for pstn.

Webex PSTN API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PSTN. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 6 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

7 operations 6 paths 11 schemas 2 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex PSTN API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 7

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

PSTN 7
GET
/telephony/pstn/locations/{locationId}/connectionOptions
Retrieve PSTN Connection Options for a Location
Retrieve PSTN Connection Options for a Location 3 params → 200400401403404405409410
PUT
/telephony/pstn/locations/{locationId}/connection
Setup PSTN Connection for a Location
Setup PSTN Connection for a Location 2 params body → 204400401403404405409410
GET
/telephony/pstn/locations/{locationId}/connection
Retrieve PSTN Connection for a Location
Retrieve PSTN Connection for a Location 2 params → 200400401403404405409410
PUT
/telephony/pstn/numbers/{phoneNumber}/emergencyAddress
Update the Emergency Address for a Phone Number
updateEmergencyAddressForPhoneNumber 2 params body → 204400401403404405409410
POST
/telephony/pstn/locations/{locationId}/emergencyAddress/lookup
Emergency Address Lookup to Verify if Address is Valid
emergencyAddressLookup 2 params body → 200400401403404405409410
POST
/telephony/pstn/locations/{locationId}/emergencyAddress
Add an Emergency Address to a Location
addEmergencyAddressToLocation 2 params body → 201400401403404405409410
PUT
/telephony/pstn/locations/{locationId}/emergencyAddresses/{addressId}
Update the Emergency Address of a Location
updateEmergencyAddressOfLocation 3 params body → 204400401403404405409410

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SuggestedEmergencyAddressObject (8 properties), EmergencyAddressObject (6 properties), ConnectionResponse (6 properties), AddressLookupErrorObject (3 properties). Each schema is shown below with its type and property counts.

EmergencyAddressObject
object
Object containing emergency address details.
6 properties
SuggestedEmergencyAddressObject
object
Object containing suggested address details.
8 properties
PSTNServiceType
string
GEOGRAPHICNUMBERS - PSTN service type for geographic numbers. TOLLFREENUMBERS - PSTN service type for toll-free numbers. BUSINESSTEXTING - PSTN service type fo…
ConnectionOptionsResponse
object
3 properties 1 required
ConnectionOptionsListResponse
object
1 property
PremiseRouteType
string
ROUTEGROUP - A route group has been selected for premises-based PSTN. TRUNK - A trunk group has been selected for premises-based PSTN.
PSTNType
string
LOCALGATEWAY - PSTN connection type for a premises-based connection. NONINTEGRATEDCCP - PSTN connection type for a Non-Integrated Cloud Connected PSTN connecti…
AllowedServiceTypesFromHydra
string
MOBILENUMBERS - PSTN service type for mobile numbers.
ConnectionResponse
object
6 properties 2 required
AddressLookupErrorObject
object
Object containing details about an error encountered during address lookup.
3 properties
SetUpPSTNLocationConnectionObject
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-pstn-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API