Cisco TelePresence SX20 Codec Reference Manual page 102

Cisco TelePresence SX20 Codec
Contents Introduction
xCommand Phonebook Folder Modify
Modify an existing phonebook folder.
FolderId: The unique identifier for the folder. 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.
Name(r): The name of the contact.
ParentFolderId: The unique identifier for the parent folder. 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 parent folder.
Requires user role: USER
Parameters:
FolderId(r): <S: 0, 255>
Name: <S: 0, 255>
ParentFolderId: <S: 0, 255>
Example:
xCommand Phonebook Folder Modify FolderId:localGroupId-3 Name: "New York
Head Office"
OK
*r PhonebookFolderModifyResult (status=OK):
** end
xCommand Phonebook Folder Delete
Delete an existing folder from the local phonebook.
FolderId: The unique identifier for the folder. 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.
Requires user role: USER
Parameters:
FolderId(r): <S: 0, 255>
Example:
xCommand Phonebook Folder Delete FolderId:localGroupId-3
OK
*r PhonebookFolderDeleteResult (status=OK):
** end
SX20 Codec API Reference Guide TC7.0, JANUARY 2014.
D14949.08
About the API xConfiguration
xCommand Phonebook Contact Add
102
xCommand xCommand
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.
Name: The name of the contact.
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.
ImageURL: Currently not in use.
Title: The title of the contact.
Number: The phone number or address of the contact.
Protocol: Select Auto, SIP, H323 or H320 protocol.
CallRate: Set a call rate.
CallType: Select a call type (audio or video).
Device: Select the device type.
Requires user role: USER
Parameters:
Name(r): <S: 0, 255>
FolderId: <S: 0, 255>
ImageURL: <S: 0, 255>
Title: <S: 0, 255>
Number: <S: 0, 255>
Protocol: <Auto/H320/H323/SIP>
CallRate: <0..6000>
CallType: <Audio/Video>
Device: <Mobile/Other/Telephone/Video>
Example:
xCommand Phonebook Contact Add Name: "John Doe" Number:12345
OK
*r PhonebookContactAddResult (status=OK):
Name: localContactId-1
** end
API Reference Guide
xStatus Appendices
Copyright © 2014 Cisco Systems, Inc. All rights reserved.