Als u wilt programmeren voor het apparaat, moet er een lokale gebruiker zijn op het apparaat. Zie voor meer informatie over het maken van lokale gebruikers het artikel Lokaal gebruikersbeheer.

Er zijn verschillende manieren om toegang te krijgen tot de API. Ongeacht welke methode u kiest, is de structuur van de API hetzelfde. Kies de verbindingsmethode die het beste past bij uw toepassing:

  • SSH (Beveiligde TCP/IP-verbinding. Deze is standaard ingeschakeld).

  • Telnet (alleen beschikbaar voor apparaten in de DX-, MX- en SX-serie. Deze is standaard uitgeschakeld).

  • HTTP/HTTPS (HTTPS is standaard ingeschakeld).

  • Seriële verbinding (kan worden gebruikt zonder een IP-adres, DNS of een netwerk. Deze is standaard ingeschakeld).

API handleiding

Ga naar https://roomos.cisco.com/ voor meer informatie over het gebruik van de API en de beschrijving van de opdracht.

De API-opdrachten voor alle producten en de syntaxis en semantiek worden beschreven in deze handleiding.

Opdrachten die niet van toepassing zijn wanneer een apparaat is geregistreerd bij Webex

Sommige configuraties, commando's en statussen die in de API beschikbaar zijn, zijn alleen van toepassing op ter plaatste geregistreerde apparaten. Ze zijn niet van toepassing op apparaten die bij Webex zijn geregistreerd. In de Matrix ondersteunde commando's van de API-gids worden deze items aangeduid met "On-prem only”.

Onder de niet geldende configuraties, opdrachten en statussen valt alles dat is gerelateerd aan H.323, H.320, SIP, NTP, CUCM, LDAP, Proximity en Far End Camera Control.

De niet geldende configuraties en statussen wordt verwijderd uit de Webex-geregistreerde apparaten in een latere softwareversie. We raden aan dat u niet programmeert met API-opdrachten in deze categorieën.