DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebarSidebar on Mobile
API Reference
BotsButtons and CardsIntegrationsBYODSService AppsService App GuestsService Apps G2GGuest IssuerWidgetsWebex ConnectLogin with WebexInstant ConnectInstant Connect Meeting LinksDeveloper SandboxBeta ProgramSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsCompliance
Webex APIs
Reference
Data Sources
Admin
OverviewAdmin APIsHybrid ServicesAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner Reports/TemplatesPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSettingsSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and AuthorizationMetadata and Samples
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsMetadata and SamplesBackground Images
Reference
Call ControlsCall RoutingCall Settings For MeCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsDevice Call SettingsDevicesEmergency Services SettingsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Operating ModesFeatures: Paging GroupFeatures: Single Number ReachLocation Call Settings
GETList Locations Webex Calling Details
POSTEnable a Location for Webex Calling
GETGet Location Webex Calling Details
PUTUpdate Location Webex Calling Details
GETGet a List of Update Routing Prefix jobs
GETGet the job status of Update Routing Prefix job
GETGet job errors for update routing prefix job
POSTChange Announcement Language
GETRead the List of Dial Patterns
GETGet a Location Emergency callback number
PUTUpdate a Location Emergency callback number
POSTValidate the List of Extensions
POSTValidate Extensions
PUTUpdate Music On Hold
GETGet Music On Hold
GETGet Private Network Connect
PUTUpdate Private Network Connect
GETRead the List of Routing Choices
GETGet the List of Phone Numbers Available for External Caller ID
GETGet Available Phone Numbers for a Location with Given Criteria
GETGet Webex Go Available Phone Numbers
GETGet Location ECBN Available Phone Numbers
GETGet Location Call Intercept Available Phone Numbers
POSTCreate a Receptionist Contact Directory
GETRead list of Receptionist Contact Directories
GETGet details for a Receptionist Contact Directory
DELETEDelete a Receptionist Contact Directory
PUTModify a Receptionist Contact Directory
Location Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPartner Reports/TemplatesPeopleRecording ReportReportsReports: Detailed Call HistorySend Activation EmailUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for Wholesale
Overview
Guides
Developer's Guide
Reference
Wholesale Billing ReportsWholesale Provisioning
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Reference
Data Sources
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Directory Services
Reference
Domain ManagementIdentity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCall Settings For MeCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsData SourcesDevice Call SettingsDevice ConfigurationsDevicesDomain ManagementEmergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Operating ModesFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsIdentity OrganizationIssuesLicensesLocation Call Settings
GETList Locations Webex Calling Details
POSTEnable a Location for Webex Calling
GETGet Location Webex Calling Details
PUTUpdate Location Webex Calling Details
GETGet a List of Update Routing Prefix jobs
GETGet the job status of Update Routing Prefix job
GETGet job errors for update routing prefix job
POSTChange Announcement Language
GETRead the List of Dial Patterns
GETGet a Location Emergency callback number
PUTUpdate a Location Emergency callback number
POSTValidate the List of Extensions
POSTValidate Extensions
PUTUpdate Music On Hold
GETGet Music On Hold
GETGet Private Network Connect
PUTUpdate Private Network Connect
GETRead the List of Routing Choices
GETGet the List of Phone Numbers Available for External Caller ID
GETGet Available Phone Numbers for a Location with Given Criteria
GETGet Webex Go Available Phone Numbers
GETGet Location ECBN Available Phone Numbers
GETGet Location Call Intercept Available Phone Numbers
POSTCreate a Receptionist Contact Directory
GETRead list of Receptionist Contact Directories
GETGet details for a Receptionist Contact Directory
DELETEDelete a Receptionist Contact Directory
PUTModify a Receptionist Contact Directory
Location Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPSTNPartner ManagementPartner Reports/TemplatesPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSend Activation EmailSession TypesSettingsSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
Space Meetings Migration
Calling
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationCore ConceptsCalls
Advanced Features
Call SettingsContactsSupplementary ServicesVoicemailBackground Noise Reduction
Kitchen Sink
Meetings
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationJoin a MeetingMigration To Improved MeetingsPasswords & CaptchasUnified Space Meetings
Advanced Features
Advanced ControlsDialing In and OutStreams & EffectsVideo Resolution
Multistream
Multistream Comprehensive GuideMultistream Quickstart
Migrating SDK V2 to V3
iOSAndroidBrowserNode.jsClick to Call
Developer CommunityCertifications

Get Location ECBN Available Phone Numbers

List standard numbers that are available to be assigned as the location's emergency callback number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features.

Retrieving this list requires a full, read-only or location administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/locations/{locationId}/emergencyCallbackNumber/availableNumbers
URI Parameters
locationId
stringrequired

Return the list of phone numbers for this location within the given organization. The maximum length is 36.

Query Parameters
orgId
string

List numbers for this organization.

max
number

Limit the number of phone numbers returned to this maximum count. The default is 2000.

start
number

Start at the zero-based offset in the list of matching phone numbers. The default is 0.

phoneNumber
array[string]

Filter phone numbers based on the comma-separated list provided in the phoneNumber array.

ownerName
string

Return the list of phone numbers that are owned by the given ownerName. Maximum length is 255.

Response Properties
phoneNumbers
array[LocationECBNAvailableNumberObject]

Array of phone numbers.

phoneNumber
string

A unique identifier for the phone number.

state
STATE

Phone number's state.

ACTIVE
string

Phone number is in the active state.

INACTIVE
string

Phone number is in the inactive state.

isMainNumber
boolean

If true, the phone number is used as a location CLID.

tollFreeNumber
boolean

If true, the phone number is a toll-free number.

telephonyType
TelephonyType

The telephony type for the number.

PSTN_NUMBER
string

The object is a PSTN number.

isServiceNumber
boolean

If true, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free.

owner
object
id
string

Unique identifier of the owner to which phone number is assigned.

type
enum

Type of the phone number's owner.

PLACE
string

PSTN phone number's owner is a workspace.

PEOPLE
string

PSTN phone number's owner is a person.

VIRTUAL_LINE
string

PSTN phone number's owner is a Virtual Line.

HUNT_GROUP
string

PSTN Phone number's owner is a Hunt Group.

firstName
string

First name of the PSTN phone number's owner. This field will be present only when the owner type is PEOPLE or VIRTUAL_LINE.

lastName
string

Last name of the PSTN phone number's owner. This field will be present only when the owner type is PEOPLE or VIRTUAL_LINE.

displayName
string

Display name of the PSTN phone number's owner. This field will be present only when the owner type is PLACE or HUNT_GROUP.

Response Codes

The list below describes the common success and error responses you should expect from the API:

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
GET
/v1/telephony/config/locations//emergencyCallbackNumber/availableNumbers{?orgId,max,start,phoneNumber,ownerName}
Log in to try the API.
Header
Query Parameters
  • List numbers for this organization.
  • Limit the number of phone numbers returned to this maximum count. The default is 2000.
  • Start at the zero-based offset in the list of matching phone numbers. The default is 0.
  • Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
  • Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
  • Request
  • Response
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg/emergencyCallbackNumber/availableNumbers?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&max=5&start=0&phoneNumber=+12056852221,+12056852222&ownerName=Test
200 / OK
{
    "phoneNumbers": [
        {
            "phoneNumber": "+12056350001",
            "state": "ACTIVE",
            "isMainNumber": false,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": false,
            "owner": {
                "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
                "type": "PEOPLE",
                "firstName": "Test",
                "lastName": "Person"
            }
        },
        {
            "phoneNumber": "+12056350002",
            "extension": "1235",
            "state": "ACTIVE",
            "isMainNumber": true,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": false,
            "owner": {
                "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA=",
                "type": "PLACE",
                "displayName": "TestWorkSpace"
            }                        
        },
        {
            "phoneNumber": "+12056350003",
            "extension": "1236",                        
            "state": "INACTIVE",
            "isMainNumber": false,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": true,
            "isServiceNumber": false,
            "owner": {
                "id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NWQ3MmYwNS00NDYzLTQxYzktYjI0Ni01MDhkMDM2YzJhOTE",
                "type": "VIRTUAL_LINE",
                "displayName": "Test VL"
            }
        },
        {
            "phoneNumber": "+12056350004",
            "state": "ACTIVE",
            "isMainNumber": false,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": false,
            "owner": {
                "id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWnpOcmEybHNkalV3ZDBCbWJHVjRNaTVqYVhOamJ5NWpiMjA9",
                "type": "HUNT_GROUP",
                "displayName": "Test HG"
            }
        }
    ]
}

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2025 Cisco and/or its affiliates. All rights reserved.