Webex Numbers API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Numbers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
11 operations
across 8 paths,
and defines 31 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.0.
11 operations8 paths31 schemas1 DELETE4 GET5 POST1 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 Numbers 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.
Across 8 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Numbers 11
POST
/telephony/config/locations/{locationId}/numbers
Add Phone Numbers to a location
Add Phone Numbers to a location2 paramsbody→ 201400401403404405409410
PUT
/telephony/config/locations/{locationId}/numbers
Manage Number State in a location
Manage Number State in a location2 paramsbody→ 204400401403404405409410
DELETE
/telephony/config/locations/{locationId}/numbers
Remove phone numbers from a location
Remove phone numbers from a location2 paramsbody→ 204400401403404405409410
List Manage Numbers Job errors4 params→ 200400401403404405409410
Schemas 31
The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are jobIdResponseObject (15 properties), StartJobResponse (15 properties), NumberObject (14 properties), JobDetailsResponse (13 properties). Each schema is shown below with its type and property counts.
JobExecutionStatusObject1
object
6 properties5 required
ValidateNumbersPostRequest
object
1 property1 required
NumberOwnerType
string
PLACE - PSTN phone number's owner is a workspace. PEOPLE - PSTN phone number's owner is a person. VIRTUALLINE - PSTN phone number's owner is a Virtual Profile.…
NumberStateOptions
string
ACTIVE - The number is activated and has calling capability. INACTIVE - A number is not yet activated and has no calling capability.
NumberCount
object
8 properties
NumbersDelete
object
1 property1 required
Status
string
OK - Everything is good. ERRORS - Validation has failed with errors.
numberItem
object
2 properties2 required
ValidateNumbersResponse
object
2 properties2 required
ErrorResponseObject
object
1 property
stepExecutionStatusesObject
object
8 properties5 required
ItemObject
object
4 properties
ErrorObject
object
2 properties
NumberObject
object
14 properties6 required
ErrorMessageObject
object
3 properties
NumberState
string
Available - The phone number is available. Duplicate - Duplicate phone number. Duplicate In List - Duplicate phone number in the list. Invalid - The phone numb…
Number
object
4 properties3 required
NumberUsageTypeOptions
string
NONE - Standard/user number usage (default). SERVICE - The number will be used in high-volume service, for example, Contact Center.
NumbersRequest
object
2 properties1 required
jobIdResponseObject
object
15 properties13 required
NumbersPost
object
6 properties1 required
JobDetailsResponse
object
13 properties8 required
JobExecutionStatusObject
object
9 properties5 required
JobListResponse
object
1 property1 required
MoveNumberValidationError
object
2 properties
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
NumberTypeOptions
string
TOLLFREE - A toll-free PSTN number. DID - A normal Direct Inward Dial (DID) PSTN number. MOBILE - A mobile number.
NumberListGetObject
object
2 properties1 required
StartJobResponse
object
15 properties13 required
CountObject
object
5 properties5 required
AdminBatchStartJobObject
object
4 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
