Phonebook Commands - Cisco TelePresence SX80 Reference Manual

Cisco TelePresence SX80
Contents Introduction

Phonebook commands

xCommand Phonebook Contact Add
Add a new contact to the local phonebook. The command returns the ContactId, which is a unique
string that identifies the contact; typically the format is "localContactId-n".
You can add several contact methods to a contact using the xCommand Phonebook ContactMethod
Add command. Note that only the first contact method will appear in the Favorites list on the
Cisco TelePresence Touch controller. All contact methods are available in the API and on the web
interface.
Name: The name of the contact.
FolderId: The unique identifier for the folder that you want to store the contact in. 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.
ImageURL: Currently not in use.
Title: The title of the contact.
Number: The phone number or address of the contact.
Protocol: Select the Auto, SIP, H323 or H320 protocol.
CallRate: Set a call rate.
CallType: Select a call type (audio or video).
Device: Select the device type.
Tag: Tag the contact as a Favorite, or untag an already tagged contact.
Requires user role: USER
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>
Tag: <Untagged/Favorite>
Example:
xCommand Phonebook Contact Add Name: "John Doe" Number:12345
Codec SX80 API Reference Guide TC7.3, OCTOBER 2015.
D15107.05
About the API xConfiguration
xCommand Phonebook Contact Delete
xCommand Phonebook Contact Modify
119
xCommand xCommand
Delete an existing contact from the local phonebook.
ContactId: The unique identifier for the contact. The identifier will be returned by an xCommand
Phonebook Search command. It was also returned when the xCommand Phonebook Contact Add
command was issued to make the contact.
Requires user role: USER
Parameters:
ContactId(r): <S: 0, 255>
Example:
xCommand Phonebook Contact Delete ContactId:localContactId-1
Modify contact details of an existing contact in the local phonebook. The following parameters
can be changed using this command: Name, FolderId, ImageURL and Title. You must use the
xCommand Phonebook ContactMethod Modify command to change the other parameters: Number,
Protocol, CallRate, CallType and Device.
ContactId: The unique identifier for the contact you want to modify. The identifier will be returned by
an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook
Contact Add command was issued to make the contact.
Name: The name of the contact.
FolderId: A 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.
ImageURL: Currently not in use.
Title: The title of the contact.
Tag: Tag the contact as a Favorite, or untag an already tagged contact.
Requires user role: USER
Parameters:
ContactId(r): <S: 0, 255>
Name: <S: 0, 255>
FolderId: <S: 0, 255>
ImageURL: <S: 0, 255>
Title: <S: 0, 255>
Tag: <Untagged/Favorite>
Example:
xCommand Phonebook Contact Modify ContactId:localContactId-1 Name: "John
Doe - office"
API Reference Guide
xStatus Appendices
Copyright © 2015 Cisco Systems, Inc. All rights reserved.