Cisco Collaboration Endpoint Software 9.9 API Reference Guide

This document describes the application programming interface (API) for the Cisco Collaboration Endpoint Software.


Cisco Collaboration Endpoint Software 9.9 API Reference Guide - cover page
Brand
Cisco
Category
Other Electronics
Document type
Programming Manual
Language
English
Pages
515
File format
PDF
File size
12.9 MB
Published
27 October, 2023
Updated
27 October, 2023
MD5 checksum
9E99E8FEB06E27F9FC07736A66242048

About this manual

This document serves as a reference guide for the Application Programming Interface (API) for Cisco Collaboration Endpoint software. It details the available commands for configuring, managing, and monitoring devices registered with on-premise back-ends (CUCM, VCS) or Cisco's cloud service (Cisco Webex).

The guide covers various hardware products including the DX, MX, and SX series codecs, Room Kit series, and Webex Boards. It explains how to connect to the API via SSH, Telnet, HTTP/HTTPS, WebSocket, and RS-232, and describes the xConfiguration, xCommand, and xStatus command sets.

What's inside

  • Introduction
  • About the API
  • Connecting to the API
  • User roles
  • API Queue
  • xConfiguration Commands
  • xCommand Commands
  • xStatus Commands
  • Feedback Mechanism
  • Supported Commands Matrix

Frequently asked questions

What products are supported by the Cisco Collaboration Endpoint Software 9.9 API?

The API supports DX Series, MX Series, SX Series, Room Series, and Webex Boards products.

Which user roles can access the API commands?

User roles include admin, audit, integrator, roomcontrol, and user.

What is the default TLS version for HTTPS client, syslog, and SIP connections?

The minimum TLS version is increased from version 1.0 to 1.1.

What is the URL to download user documentation for Cisco Webex registered devices?

Go to https://help.webex.com.

Download PDF (12.9 MB)

More Cisco Manuals


View all Cisco manuals →