Build
Getting StartedPlatform IntroductionEmbedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded AppsAPI Reference
BotsButtons and CardsIntegrationsService AppsService App GuestsGuest IssuerWidgetsWebex ConnectLogin with WebexInstant ConnectInstant Connect Meeting LinksDeveloper SandboxBeta ProgramSubmit Your AppSupport PolicyFAQsDesign Guidelines
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsComplianceWebhooksWebex APIsAdmin
OverviewAdmin APIsAuthentication
Guides
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Reference
Call ControlsCall RoutingCalling Service SettingsDECT Devices SettingsDevice Call SettingsDevicesFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPeopleRecording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Webex for Wholesale
Webex for UCM
Contact Center
Customer Journey Data
Devices
Meetings
Messaging
SCIM2
Webex Assistant Skills
Workspace Integrations
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBeta Features: Call Recording with Compliance Announcement Feature Phase 3BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsDECT Devices SettingsDevice Call SettingsDevice ConfigurationsDevicesEventsFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocation Call SettingsLocation 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 ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API ChangelogGETQuery Status
POSTExecute Command
xAPI
The xAPI allows developers to programmatically invoke commands and query the status of devices that run Webex RoomOS software.
Executing commands requires an auth token with the spark:xapi_commands
scope. Querying devices requires an auth token with the spark:xapi_statuses
scope.
All xAPI requests require a deviceId
which can be obtained using the Devices API. xAPI commands and statuses are described in the Cisco Collaboration Endpoint Software API Reference Guide. For more information about developing applications for cloud connected devices, see the Device Developers Guide.
Method
Description
Query Status
Execute Command