Cisco Codec C20 Reference Manual page 89

Cisco TelePresence System Codec C20
Contents Introduction
xCommand Phonebook Contact Add
Add new contact to the local phonebook. Stored internally in the system. Returns the ContactId (Name:
localContactId-1), which is a unique Id of the contact.
Name: The name of the contact.
FolderId: A unique identifier for the folder, which was created when the xCommand Phonebook Folder
Add command was issued.
ImageURL: The URL to an image.
Title: The title of the contact.
Number: The phone number or address of the contact.
Protocol: Select Auto, SIP, H323 or H320 protocol.
CallRate: Set a call rate.
CallType: Select a call type (audio or video).
Device: Select the device type.
Requires user role: ADMIN
Parameters:
Name(r): <S: 0, 255>
FolderId: <S: 0, 255>
ImageURL: <S: 0, 255>
Title: <S: 0, 255>
Number: <S: 0, 255>
Protocol: <Auto/H320/H323/SIP>
CallRate: <0..6000>
CallType: <Audio/Video>
Device: <Mobile/Other/Telephone/Video>
example:
xCommand Phonebook Contact Add Name: "John Doe" Number:12345
OK
*r PhonebookContactAddResult (status=OK):
Name: localContactId-1
** end
Codec C20 API Reference Guide TC6.0 February 2013.
D14869.05
About the API xConfiguration
xCommand Phonebook Contact Modify
xCommand Phonebook Contact Delete
89
xCommand xCommand
Modify the contact details of 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.
Name: The name of the contact.
FolderId: A unique identifier for the folder, which was created when the xCommand Phonebook Folder
Add command was issued.
ImageURL: The URL to an image.
Title: The title of the contact.
Requires user role: ADMIN
Parameters:
ContactId(r): <S: 0, 255>
Name: <S: 0, 255>
FolderId: <S: 0, 255>
ImageURL: <S: 0, 255>
Title: <S: 0, 255>
example:
xCommand Phonebook Contact Modify ContactId:localContactId-1 Name: "John Doe
- office"
OK
*r PhonebookContactModifyResult (status=OK):
** end
Delete an existing contact from the local phonebook.
ContactId: A unique identifier for the contact, which was created when the xCommand Phonebook
Contact Add command was issued.
Requires user role: ADMIN
Parameters:
ContactId(r): <S: 0, 255>
example:
xCommand Phonebook Contact Delete ContactId:localContactId-1
OK
*r PhonebookContactDeleteResult (status=OK):
** end
API Reference Guide
xStatus Appendices
Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.