Xcommand Phonebook Search - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec

Introduction

xCommand Phonebook Search

The search command lets you search in both the local and corporate phone books. A search
gives a ResultSet.
The total number of folders and contacts (TotalRows) is always included in the result set when
searching the local phone book. When searching a corporate phonebook the total number
of folders and contacts may not be included. Whether it is included or not depends on the
backend corporate phonebook service (e.g. CUCM, VCS, TMS) and its version.
Requires user role: ADMIN, USER
USAGE:
xCommand Phonebook Search [PhonebookId: "PhonebookId"] [PhonebookType:
PhonebookType] [SearchString: "SearchString"] [SearchField: SearchField] [Offset:
Offset] [FolderId: "FolderId"] [Limit: Limit] [Recursive: Recursive] [ContactType:
ContactType] [Tag: Tag]
where
: String (0, 255)
PhonebookId
The identifier of the phonebook server that will be searched. See the xConfiguration
Phonebook Server ID setting.
: Corporate/Local
PhonebookType
Define whether to search the local phone book or the corporate phonebook.
: String (0, 255)
SearchString
Search for entries containing this string (note that the entry does not have to begin
with the string). If no FolderId is specified, all folders / phonebook directories will be
searched.
: Name/Number
SearchField
Currently not in use.
: Integer (0..65534)
Offset
Get records starting with this offset in a search. The default value is 0. Offset is used
together with Limit to support paging.
: String (0, 255)
FolderId
Search only in the specified folder. The FolderId (string) is listed in the ResultSet of a
search result containing folders.
: Integer (0..65534)
Limit
Limit the number of records in the result set to this number. For example, if the limit is
set to 10, the ResultSet will contain only 10 entries (Contacts and Folders) even if the
total number of hits is larger. The maximum limit is 1000.
SX20 Codec API Reference Guide CE8.3, JANUARY 2017.
D15316.05
About the API xConfiguration xCommand xCommand
: False/True
Recursive
This parameter will only have effect when searching the local phone book. The setting
determines whether a local phone book search should be limited to the given FolderId,
or also recursively search in its subfolders. If not specified, the search will be recursive.
When issuing the command without specifying any parameters, all folders, contacts and
contact methods in the local phone book will be returned.
: Any/Folder/Contact
ContactType
Search all contact types, or limit the search to folders or individual contacts.
: Untagged/Favorite
Tag
Limits the search to either contacts that have been tagged as favorite or the untagged
contacts.
132
API Reference Guide
xStatus Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.