D14869.11
Codec C20 API Reference Guide TC7.0, JANUARY 2014.
Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
99
Cisco TelePresence System Codec C20
API Reference Guide
Phonebook commands
xCommand Phonebook Folder Add
Phonebook entries can be stored in folders. Use this command to add a folder to the local
phonebook. The command returns the FolderId, which is a unique string that identifies the folder;
typically the format is “localGroupId-n”.
Name(r): The name of the folder.
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:
Name(r): <S: 0, 255>
ParentFolderId: <S: 0, 255>
Example:
xCommand Phonebook Folder Add Name: "New York Office"
OK
*r PhonebookFolderAddResult (status=OK):
Name: localGroupId-3
** end
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
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
