Getting Started with xAPI for PhoneOS

xAPI for PhoneOS only works on PhoneOS based hardware, 9841/9851/9861/9871/8875. It is only supported on PhoneOS 3.5 and later version firmware.

Q1. What type of connection XAPI uses for communication, HTTPS, WebSockets, or something else?

A1. xAPI on RoomOS can be accessed via https, WebSocket, Macro, SSH and Hydra. xAPI on PhoneOS can support access via https as of PhoneOS 3.5 and Hydra. WebSocket and Macro access are on roadmap.

Q2. Would xAPI be capable of waking up a phone from deep sleep mode?

A2. No. During deep sleep mode, network connection is cutoff. So xAPI command would not wake up the phone in deep sleep mode.

Q3. Can I use calling server admin credential to use xAPI? How can I set the xAPI user name and password?

A3. Webex Calling administrators can access part of xCommand via control hub web portal, from the device>Action>run xCommand menu. For Webex Calling system admin, if they want the full feature of xAPI, they also need to set an xAPI user name and password first. For CUCM, Broadsoft and OpenSIP platform admins, calling system admin account don't have xAPI privilege enabled by default. Dedicate xAPI user name and password need to be set for the device, before the admin can use the xAPI command to control the phone.

Please note, the xAPI set for Webex Calling will be applicable for all PhoneOS devices in this org, the xAPI account set for OpenSIP platforms would be applicable for the devices who share the same template with the same xAPI credential information, xAPI account for different device or device group registered in CUCM could be different based on setting.

Q4. After I set xAPI account, it doesn't take effect on the phone I want to control, why is that?

A4. Since xAPI access phone via HTTP, make sure the web server on the target device is enabled.

For Webex Calling MT phones, go to Control Hube > Device Page > All configuration > system.webaccess and change to Yes. By default, the port should be 443.
For OpenSIP platform, make sure the config sync to the device is
- <Enable_Web_Server >Yes</Enable_Web_Server
- <Enable_Protocol >Https</Enable_Protocol>
- <Web_Server_Port >443</Web_Server_Port>
For CUCM, go to device / device common profile settings and look for web access, make sure it is "enabled". In Https Server setting, you may select if you want to allow "https" only, or allow "http" as well.

Q5. How can I verify if my phone has xAPI account configured?

A5. You may verify if a phone has enabled xAPI access from the phone web page.

For MPP mode (webex calling MT & OpenSIP), please check Info tab > Status. Look for xAPI Admin Account Status
For Ent mode (CUCM or Webex DI), please look for xAPI Admin Account Status from visiting the web page of the IP Phone.

Q6. Would the xAPI user name and password still work after the factory reset?

A6. No, the xAPI account configuration will also be wiped out after factory reset. So once a phone has been factory reset via xAPI, you can not revoke it.

Q7. What xAPI can do now?

A7. xAPI is a set of APIs used to monitor, manage, and control PhoneOS-based devices. In this release, we are introducing xAPI as a new option for customers and partners to manage phones and build custom solutions.

The following features are now supported on phones registered to Webex Calling, Cisco Unified CM, or Cisco BroadWorks:

Retrieve basic device information and status, and subscribe to phone events
Perform device reboot and factory reset
Simulate hard key presses and screen touch operations
Capture device screens
Initiate calls

More features is coming in the roadmap. You are also welcomed to submit your proposal about what you want to do via xAPI. https://forms.office.com/r/tpGTPELz5V.

Q8. What is the purpose of the creation of xAPI as there are existing API sets like XSI / XML / RemoteSDK / CCAPI / JTAPI? Will the legacy API go away soon?

A8. Legacy API usually have calling platform limitations and have varied access method. These would not be phased out immediately. However, they will have very limited new investment for new features.

xAPI has the vision to unify the experience of customer, developers and partners when they work with PhoneOS, While PhoneOS is unifying the experience and firmware of Enterprise and Multi-platform, the application developed for PhoneOS devices should work regardless of the calling platform migration. There will be continued investment in xAPI to enrich its functions and use cases.