Cisco Codec C20 Reference Manual page 91

Cisco TelePresence System Codec C20
Contents Introduction
xCommand Phonebook ContactMethod Delete
Delete details about the call setup to an existing contact in the local phonebook.
ContactId: A unique identifier for the contact, which was created when the xCommand Phonebook
Contact Add command was issued.
ContactMethodId: A unique identifier for the contact method, which was created when the xCommand
Phonebook ContactMethod Add command was issued.
Requires user role: ADMIN
Parameters:
ContactId(r): <S: 0, 255>
ContactMethodId(r): <S: 0, 255>
example:
xCommand Phonebook ContactMethod Delete ContactId:localContactId-2
ContactMethodId:1
OK
*r PhonebookContactMethodDeleteResult (status=OK):
** end
Codec C20 API Reference Guide TC6.0 February 2013.
D14869.05
About the API xConfiguration
xCommand Phonebook Search
91
xCommand xCommand
The search command lets you search in both the local and corporate phone books. A search gives
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 yields 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 only gives a ResultSet
of 10 entries (Contacts + Folders) although the total number of hits may be greater. Any limit higher
than 1000 is treated as 1000.
Recursive: Set if the phonebook should search recursive. The result from an empty search 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.
API Reference Guide
xStatus Appendices
Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.