Phonebook Commands; Xcommand Phonebook Contact Add; Xcommand Phonebook Contact Delete - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec

Introduction

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).
SX20 Codec API Reference Guide CE8.3, JANUARY 2017.
D15316.05
About the API xConfiguration xCommand xCommand
: Mobile/Other/Telephone/Video
Device
Select the device type.
: Untagged/Favorite
Tag
Tag the contact as a Favorite, or untag an already tagged contact.

xCommand Phonebook Contact Delete

Delete an existing contact from the local phonebook.
Requires user role: ADMIN, USER
USAGE:
xCommand Phonebook Contact Delete ContactId: "ContactId"
where
: String (0, 255)
ContactId
The unique identifier for the contact. The identifier will be returned by an xCommand
Phonebook Search command. It was also returned when the xCommand Phonebook
Contact Add command was issued to make the contact.
128
API Reference Guide
xStatus Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.