Cisco TelePresence SX20 Codec Reference Manual page 97

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

Advertisement

Cisco TelePresence SX20 Codec
Contents
Introduction
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: ADMIN
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
SX20 Codec API Reference Guide TC6.2, JULY 2013.
D14949.04
About the API
xConfiguration
xCommand Phonebook Folder Modify
xCommand Phonebook Folder Delete
97
xCommand
xCommand
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: ADMIN
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
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: ADMIN
Parameters:
FolderId(r): <S: 0, 255>
Example:
xCommand Phonebook Folder Delete FolderId:localGroupId-3
OK
*r PhonebookFolderDeleteResult (status=OK):
** end
API Reference Guide
xStatus
Appendices
Copyright © 2013 Cisco Systems, Inc. All rights reserved.

Hide quick links:

Advertisement

Table of Contents
loading

Table of Contents