Xcommand Phonebook Contact Delete; Xcommand Phonebook Contact Modify; Xcommand Phonebook Contactmethod Add - Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Contents
Introduction

xCommand Phonebook Contact Delete

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

xCommand Phonebook Contact Modify

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"
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
D14949.13
About the API
xConfiguration

xCommand Phonebook ContactMethod Add

111
xCommand
xCommand
Add contact details for an existing contact in the local phonebook. The command returns the
ContactMethodId, which is a unique string that identifies the contact method; typically the format is
"n".
You can add several contact methods to a contact. Note that only the first contact method will
appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact method
may have been created when issuing the xCommand Phonebook Contact Add command to make
the contact. All contact methods are available in the API, on the web interface and when using the
remote control.
ContactId: The unique identifier for the contact that you want to add a contact method to. 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.
Device: Set which type of device to call to.
Number(r): 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).
Requires user role: USER
Parameters:
ContactId(r): <S: 0, 255>
Device: <Mobile/Other/Telephone/Video>
Number(r): <S: 0, 255>
Protocol: <Auto/H320/H323/SIP>
CallRate: <0..6000>
CallType: <Audio/Video>
Example:
xCommand Phonebook ContactMethod Add ContactId:localContactId-2
Number:54321 Protocol:H323
API Reference Guide
xStatus
Appendices
Copyright © 2015 Cisco Systems, Inc. All rights reserved.

Hide quick links:

Advertisement

Table of Contents
loading

Table of Contents