Xcommand Phonebook Search - Cisco TelePresence System Codec C90 Reference Manual

Cisco TelePresence System Codec C90
Contents Introduction

xCommand Phonebook Search

The search command lets you search in both the local and corporate phone books. A search will give
a ResultSet. More examples can be found on the Developer Zone web page. Go to: http://developer.
tandberg.com/web/guest/howtos/cseries-api/phonebook.
PhonebookId: The value of the ID tag for which phonebook server to use. See xConfiguration
Phonebook Server. Not necessary to use.
PhonebookType: Which phone book to search in. Either the local phone book or the corporate
phonebook.
SearchString: Search for entries containing specified string (not begins with). If no FolderId
is specified, the search will yield search results from ALL folders/phonebook directories. The
SearchString parameter is optional for software version TC2.0 and later.
SearchField: Currently not in use.
Offset: Get records starting with this offset in a search. Default 0. Used together with Limit to support
paging.
FolderId: Search only in the specified folder. FolderId (string) is listed in the ResultSet of a search
result containing folders.
Limit: Limit the number of records in the result set to this number. E.g. Limit: 10 will only give a
ResultSet of 10 entries (Contacts + Folders) although the total number of hits may be greater.
Recursive: Set if the phonebook should search recursive. The result from an empty search will return
both the directories and the content in the directories. NOTE: This command is only valid for the local
directory.
Requires user role: USER
Parameters:
PhonebookId: <S: 0, 255>
PhonebookType: <Corporate/Local>
SearchString: <S: 0, 255>
SearchField: <Name/Number>
Offset: <0..65534>
FolderId: <S: 0, 255>
Limit: <0..65534>
Recursive: <False/True>
Example:
xCommand Phonebook Search PhonebookType:Corporate Limit:2
FolderId:"corporate _ 001"
OK
*r ResultSet ResultInfo TotalRows: 25
*r ResultSet Contact 1 Name: "/tmp"
*r ResultSet Contact 1 ContactId: "e _ 9664921"
*r ResultSet Contact 1 ContactMethod 1 ContactMethodId: "1"
*r ResultSet Contact 1 ContactMethod 1 Number: "H323:/John.Doe.Office@company.
D14641.06 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved.
About the API xConfiguration
96
xCommand xCommand
com"
*r ResultSet Contact 1 ContactMethod 1 Protocol: H323
*r ResultSet Contact 1 ContactMethod 2 ContactMethodId: "2"
*r ResultSet Contact 1 ContactMethod 2 Number: "SIP:/John.Doe.Office@company.
com"
*r ResultSet Contact 1 ContactMethod 2 Protocol: SIP
*r ResultSet Contact 2 Name: "Other"
*r ResultSet Contact 2 ContactId: "e _ 9468400"
*r ResultSet Contact 2 ContactMethod 1 ContactMethodId: "3"
*r ResultSet Contact 2 ContactMethod 1 Number: "H323:John.Doe.Home@company.
com"
*r ResultSet Contact 2 ContactMethod 1 Protocol: H323
*r ResultSet Contact 2 ContactMethod 2 ContactMethodId: "4"
*r ResultSet Contact 2 ContactMethod 2 Number: "SIP:John.Doe.Home@company.
com"
*r ResultSet Contact 2 ContactMethod 2 Protocol: SIP
** end
API Reference Guide
xStatus Appendices
www.cisco.com