Xcommand Peripherals Pairing Unpair; Xcommand Peripherals Purge; Phonebook Commands; Xcommand Phonebook Contact Add - Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Introduction

xCommand Peripherals Pairing Unpair

Unpair endpoint from an ISDN Link, when the two have contact.
Requires user role: ADMIN
USAGE:
xCommand Peripherals Pairing Unpair MacAddress: "MacAddress"
where
: String (1, 100)
MacAddress
MacAddress: Enter the MAC address for the ISDN Link you wish to unpair from the
endpoint.

xCommand Peripherals Purge

Force unpair an endpoint from an ISDN Link when a connection has been lost. Note: You must
also unpair the ISDN Link to be able to pair it to another endpoint.
Requires user role: ADMIN, USER
USAGE:
xCommand Peripherals Purge ID: "ID"
where
: String (1, 100)
ID
Mac address of the ISDN Link in the format "xx:xx:xx:xx:xx:xx".
SX20 Codec API Reference Guide CE9.1, JUNE 2017.
D15316.07
About the API
xConfiguration
xCommand
xCommand

Phonebook commands

xCommand Phonebook Contact Add

Add a new contact to the local phonebook. The command returns the ContactId, which is a
unique string that identifies the contact; typically the format is "localContactId-n".
You can add several contact methods to a contact using the xCommand Phonebook
ContactMethod Add command. Note that only the first contact method will appear in the
Favorites list on the Cisco TelePresence Touch controller. All contact methods are available in
the API, on the web interface and when using the remote control.
Requires user role: ADMIN, USER
USAGE:
xCommand Phonebook Contact Add Name: "Name" [FolderId: "FolderId"] [ImageURL:
"ImageURL"] [Title: "Title"] [Number: "Number"] [Protocol: Protocol] [CallRate:
CallRate] [CallType: CallType] [Device: Device] [Tag: Tag]
where
: String (0, 255)
Name
The name of the contact.
: String (0, 255)
FolderId
The unique identifier for the folder that you want to store the contact in. The identifier
will be returned by an xCommand Phonebook Search command. It was also returned
when the xCommand Phonebook Folder Add command was issued to make the folder.
: String (0, 255)
ImageURL
Currently not in use.
: String (0, 255)
Title
The title of the contact.
: String (0, 255)
Number
The phone number or address of the contact.
: Auto/H320/H323/SIP/Spark
Protocol
Select the Auto, Spark, SIP, H323 or H320 protocol.
: Integer (0..6000)
CallRate
Set a call rate.
: Audio/Video
CallType
Select a call type (audio or video).
110
API Reference Guide
xStatus
Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.

Advertisement

Table of Contents
loading

Table of Contents