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

Webex Numbers API

The Numbers API from Webex — 8 operation(s) for numbers.

Webex Numbers API is one of 193 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.2.0, at version 1.0.0.

11 operations 8 paths 31 schemas 1 DELETE4 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, HTTP Bearer
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 accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — e.g. Bearer YOURAUTHORIZATIONTOKEN

Paths & Operations 11

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 location 2 params body → 201400401403404405409410
PUT
/telephony/config/locations/{locationId}/numbers
Manage Number State in a Location
Manage Number State in a location 2 params body → 204400401403404405409410
DELETE
/telephony/config/locations/{locationId}/numbers
Remove Phone Numbers from a Location
Remove phone numbers from a location 2 params body → 204400401403404405409410
POST
/telephony/config/actions/validateNumbers/invoke
Validate Phone Numbers
Validate phone numbers 1 param body → 200400401403404405409410
GET
/telephony/config/numbers
Get Phone Numbers for an Organization with Given Criteria
Get Phone Numbers for an Organization with Given Criteria 20 params → 200400401403404405409410
GET
/telephony/config/jobs/numbers/manageNumbers
List Manage Numbers Jobs
List Manage Numbers Jobs 3 params → 200400401403404405409410
POST
/telephony/config/jobs/numbers/manageNumbers
Initiate Number Jobs
Initiate Number Jobs 1 param body → 201400401403404405409410
GET
/telephony/config/jobs/numbers/manageNumbers/{jobId}
Get Manage Numbers Job Status
Get Manage Numbers Job Status 2 params → 200400401403404405409410
POST
/telephony/config/jobs/numbers/manageNumbers/{jobId}/actions/pause/invoke
Pause the Manage Numbers Job
Pause the Manage Numbers Job 2 params → 204400401403404405409410
POST
/telephony/config/jobs/numbers/manageNumbers/{jobId}/actions/resume/invoke
Resume the Manage Numbers Job
Resume the Manage Numbers Job 2 params → 204400401403404405409410
GET
/telephony/config/jobs/numbers/manageNumbers/{jobId}/errors
List Manage Numbers Job Errors
List Manage Numbers Job errors 4 params → 200400401403404405409410

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are StartJobResponse (15 properties), NumberObject (15 properties), jobIdResponseObject (15 properties), JobDetailsResponse (13 properties). Each schema is shown below with its type and property counts.

ItemObject
object
4 properties
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.…
Status
string
OK - Everything is good. ERRORS - Validation has failed with errors.
NumberTypeOptions
string
TOLLFREE - A toll-free PSTN number. DID - A normal Direct Inward Dial (DID) PSTN number. MOBILE - A mobile number.
ValidateNumbersResponse
object
2 properties 2 required
NumberListGetObject
object
2 properties 1 required
StartJobResponse
object
15 properties 13 required
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
NumberObject
object
15 properties 7 required
jobIdResponseObject
object
15 properties 13 required
CountObject
object
5 properties 5 required
JobExecutionStatusObject
object
9 properties 5 required
JobDetailsResponse
object
13 properties 8 required
Number
object
4 properties 3 required
ErrorResponseObject
object
1 property
stepExecutionStatusesObject
object
8 properties 5 required
numberItem
object
2 properties 2 required
JobExecutionStatusObject1
object
6 properties 5 required
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…
NumberStateOptions
string
ACTIVE - The number is activated and has calling capability. INACTIVE - A number is not yet activated and has no calling capability.
MoveNumberValidationError
object
2 properties
JobListResponse
object
1 property 1 required
AdminBatchStartJobObject
object
4 properties 2 required
NumberCount
object
9 properties
NumbersDelete
object
1 property 1 required
NumbersRequest
object
2 properties 1 required
ErrorMessageObject
object
3 properties
NumberUsageTypeOptions
string
NONE - Standard/user number usage (default). SERVICE - The number will be used in high-volume service, for example, Contact Center.
ErrorObject
object
2 properties
ValidateNumbersPostRequest
object
1 property 1 required
NumbersPost
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-numbers-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
Where this information came from

This is an independent, third-party profile of Webex 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.